Skip to content

Player profile data, dev origin fix, debug enhancements #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
NineOfGaming wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Player profile data, dev origin fix, debug enhancements #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f5de6bb
profile data, fix dev origin, improve debug
NineOfGaming May 12, 2026
5ab23a1
review changes
NineOfGaming Jun 2, 2026
8a2beb1
more review changes
NineOfGaming Jun 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 37 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Core library for DiamondFire mods, allowing them to share a common codebase and

---

> [!WARNING]
> [!WARNING]
> README is unfinished and may contain incorrect, outdated, or missing information.

## Features
Expand All @@ -35,7 +35,7 @@ Mods can define features, classes that implement a **FeatureTrait**.

#### Registering features

To register a feature, in your mod's onInitializeClient,
To register a feature, in your mod's onInitializeClient,
call **FlintAPI.registerFeature(FeatureTrait)** or **FlintAPI.registerFeature(FeatureTrait...)**.

```java
Expand Down Expand Up @@ -85,27 +85,38 @@ public void error() {

### Mode Tracking

Flint tracks the user's current mode and optionally the plot and node they are on, you can access this info using
Flint tracks the user's current mode and optionally the plot and node they are on, you can access this info using
**Flint.getUser().getMode()**, **Flint.getUser().getPlot()**, and **Flint.getUser().getNode()**.

User profile data can be enabled separately with **FlintAPI.fetchUserProfileWithWhois()**,
making the user's ranks and other data available through **Flint.getUser().getProfile()** and **Flint.getUser().getRanks()**.

Plot owner profile data can be enabled with **FlintAPI.fetchPlotOwnerProfileWithWhois()**.

You can also request arbitrary player data with **FlintAPI.requestPlayerLocation(String)** and **FlintAPI.requestPlayerProfile(String)**,
or omit the argument to request data for the current user.

```java
public boolean shouldShowPlotOverlay() {
return Flint.getUser().getMode() == Mode.PLAY && Flint.getUser().getPlot().handle() == "myplot";
}
```

> [!IMPORTANT]
> You only have access to the user's plot if **FlintAPI.confirmLocationWithLocate()** was called, if you are not
> calling this on your own, remember that you will get null when calling **Flint.getUser().getPlot()**!
> [!IMPORTANT]
> You only have access to the user's plot if **FlintAPI.confirmLocationWithLocate()** was called,
> if you are not calling this on your own, remember that you will get null when calling **Flint.getUser().getPlot()**!
>
> **FlintAPI.fetchPlotOwnerProfileWithWhois()** also enables location confirmation because Flint needs the plot owner before it
> can fetch their profile.
>
> This makes Flint run /locate every time a suspected mode change occurs.
> This makes Flint run /locate every time a suspected mode change occurs.
> Not only does this give you access to the plot the user is on, but it also makes mode tracking more accurate.

## ActionDump

The actiondump is stored in separate files for each color mode access them in the flint files,
for a & color syntax actiondump you would use `FlintFile.ACTION_DUMP_AMPERSAND.getPath()`,
you need to read the files on your own.
The actiondump is stored in separate files for each color mode access them in the flint files,
for a & color syntax actiondump you would use `FlintFile.ACTION_DUMP_AMPERSAND.getPath()`,
you need to read the files on your own.
To receive each version log into Node Beta and run `/getactiondump <color mode>`.

### DFItem
Expand All @@ -116,18 +127,28 @@ TODO

#### Mode

An enum containing every mode the user can be in,
you can check whether a mode means the user is in a plot
An enum containing every mode the user can be in,
you can check whether a mode means the user is in a plot
or if they are in a mode that allows them to modify a plot with `Mode.isInPlot()` and `Mode.isEditor()` respectively.

#### Plot

A record that stores surface level information about a plot, such as the plot's name, id, and handle.
A class that stores surface level information about a plot, such as the plot's name, id, and handle.
When available, plot owner profile data can be read with `Plot.getOwnerProfile()` and `Plot.getOwnerRanks()`.

#### PlayerProfile

Stores profile data parsed from `/whois`, including ranks, badges, pronouns, join date, and about text.
Ranks are exposed as both visible `PlayerRank` entries and category levels through `PlayerRanks`.

#### PlayerLocation

Stores location data parsed from `/locate`, including mode, plot, and node.

#### Node

An enum of every node on DiamondFire, you can get a node's ID with `Node.getId()` or its name with `Node.getName()`. Get
a node by its id or name using `Node.fromId()` or `Node.fromName()` respectively.
An enum of every node on DiamondFire, you can get a node's ID with `Node.getId()` or its name with `Node.getName()`.
Get a node by its id or name using `Node.fromId()` or `Node.fromName()` respectively.

#### Toaster

Expand All @@ -147,7 +168,7 @@ on [Modrinth](https://modrinth.com/mod/flint).
Use the Modrinth Maven repository to depend on Flint in your project.

### What version?
Flint updates on a **rolling release** schedule, once a push is made to the main branch, a new version is released.
Flint updates on a **rolling release** schedule, once a push is made to the main branch, a new version is released.
The latest release will be the most recent GitHub release, or other most recent release on Modrinth.

### Build Script Example
Expand Down
24 changes: 13 additions & 11 deletions src/main/java/dev/dfonline/flint/Flint.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
package dev.dfonline.flint;

import dev.dfonline.flint.actiondump.ActionDump;
import dev.dfonline.flint.feature.core.FeatureManager;
import dev.dfonline.flint.feature.core.FeatureTrait;
import dev.dfonline.flint.feature.core.FeatureTraitType;
Expand All @@ -11,6 +10,7 @@
import dev.dfonline.flint.feature.impl.ModeTrackerFeature;
import dev.dfonline.flint.feature.impl.PacketLoggerFeature;
import dev.dfonline.flint.feature.impl.StateDebugDisplayFeature;
import dev.dfonline.flint.feature.impl.WhoisFeature;
import dev.dfonline.flint.feature.trait.CommandFeature;
import dev.dfonline.flint.feature.trait.ConnectionListeningFeature;
import dev.dfonline.flint.feature.trait.RenderedFeature;
Expand All @@ -33,10 +33,9 @@
import net.kyori.adventure.platform.modcommon.MinecraftClientAudiences;
import net.minecraft.client.MinecraftClient;

import java.util.Arrays;

public class Flint implements ClientModInitializer {

@SuppressWarnings("unused")
public static final String MOD_ID = "flint";
public static final String MOD_NAME = "Flint";
public static final FeatureManager FEATURE_MANAGER = new FeatureManager();
Expand All @@ -58,8 +57,10 @@ public static User getUser() {
public void onInitializeClient() {
LOGGER.info("Sparking it up");

// FlintAPI.setDebugging(true);
// FlintAPI.confirmLocationWithLocate();
// FlintAPI.setDebugging(true);
// FlintAPI.confirmLocationWithLocate();
// FlintAPI.fetchUserProfileWithWhois();
// FlintAPI.fetchPlotOwnerProfileWithWhois();

FlintUpdate.fetchLatestRelease();

Expand All @@ -71,6 +72,7 @@ public void onInitializeClient() {
// Systems
new CommandSenderFeature(),
new LocateFeature(),
new WhoisFeature(),

// Functionality
new ModeTrackerFeature(),
Expand Down Expand Up @@ -123,25 +125,25 @@ private void registerEventCallbacks() {
((WorldRenderFeature) feature).worldRenderStartMain(context)
)
);

WorldRenderEvents.BEFORE_ENTITIES.register(context ->
FEATURE_MANAGER.getByTrait(FeatureTraitType.WORLD_RENDER).forEach(feature ->
((WorldRenderFeature) feature).worldRenderBeforeEntities(context)
)
);

WorldRenderEvents.AFTER_ENTITIES.register(context ->
FEATURE_MANAGER.getByTrait(FeatureTraitType.WORLD_RENDER).forEach(feature ->
((WorldRenderFeature) feature).worldRenderAfterEntities(context)
)
);

WorldRenderEvents.BEFORE_DEBUG_RENDER.register(context ->
FEATURE_MANAGER.getByTrait(FeatureTraitType.WORLD_RENDER).forEach(feature ->
((WorldRenderFeature) feature).worldRenderBeforeDebugRender(context)
)
);
);

WorldRenderEvents.BEFORE_TRANSLUCENT.register(context ->
FEATURE_MANAGER.getByTrait(FeatureTraitType.WORLD_RENDER).forEach(feature ->
((WorldRenderFeature) feature).worldRenderBeforeTranslucent(context)
Expand All @@ -164,7 +166,7 @@ private void registerEventCallbacks() {
((WorldRenderFeature) feature).worldRenderEndMain(context)
)
);

ClientLifecycleEvents.CLIENT_STOPPING.register(client ->
FEATURE_MANAGER.getByTrait(FeatureTraitType.SHUTDOWN).forEach(feature ->
((ShutdownFeature) feature).onShutdown()
Expand Down
Loading