Core library for DiamondFire mods, allowing them to share a common codebase and systems.

Mods can define features, classes that implement a FeatureTrait.

• ChatListeningFeature - Listen to chat messages
• CommandFeature - Register a command with aliases
• ModeSwitchListeningFeature - Listen to mode switches
• PacketListeningFeature - Listen to incoming and outgoing packets
• PlotSwitchListeningFeature - Listen to plot switches
• RenderedFeature - Run code when a frame is rendered
• ShutdownFeature - Run code when the game is shutting down
• TickedFeature - Run code every tick
• TooltipRenderFeature - Run code when a tooltip is rendered, allowing you to modify it
• UserCommandListeningFeature - Run code when the player runs a command, lets you to modify or cancel the command
• UserMessageListeningFeature - Run code when the player sends a message, lets you to modify or cancel the message
• WorldRenderFeature - Listen to world render events

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

public class Flint implements ClientModInitializer {

    @Override
    public void onInitializeClient() {
        FlintAPI.registerFeatures(
                new AwesomeFeature()
        );

    }

}

Send formatted messages with ease using messages.

public void success() {

    Flint.getUser().sendMessage(new CompoundMessage(
            new SuccessMessage("my_mod.awesome_success"),
            new SoundMessage(FSound.builder()
                    .setSound(SoundEvents.ENTITY_PLAYER_LEVELUP)
                    .setPitch(1.5F)
                    .build()
            )
    ));

}

The library provides a color palette for easy access to beautiful colors.

public void error() {

    Component.text("You did something BAD!", PaletteColor.RED);

}

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().

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

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>.

TODO

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.

A record that stores surface level information about a plot, such as the plot's name, id, and handle.

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.

Lets you send toasts with Toaster.toast(Component title, Component message).

A rate limiter that can be used to limit the rate at which code is executed.

Either grab the latest release from the releases page or on Modrinth.

Use the Modrinth Maven repository to depend on Flint in your project.

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.

repositories {
    // This is the recommended way to add the Modrinth Maven repository.
    exclusiveContent {
        forRepository {
            maven {
                name = "Modrinth"
                url = "https://api.modrinth.com/maven"
            }
        }
        filter {
            includeGroup "maven.modrinth"
        }
    }
}

dependencies {
    // Use modApi to gain access to Flint's classes.

    // Flint
    modApi("maven.modrinth:flint:${project.flint_version}")

    // Flint depends on Adventure,
    // loom doesn't resolve dependencies of dependencies
    // so you need to include it in your project yourself.

    // Adventure
    modImplementation include("net.kyori:adventure-platform-fabric:${project.adventure_fabric_version}") {
        exclude group: "net.fabricmc.fabric-api"
    }

}