Getting Started

Getting started

Applies to all versions. API names differ between 1.21.1 and 26.2 (see Home).

For players and modpacks

1. Install NeoForge for your Minecraft version (at least the version in the versions table).
2. Put the Common Toolkit JAR in the mods folder of the server and every client (it declares both sides and syncs registry data to clients).
3. Install the mods that depend on it.

Common Toolkit adds no blocks, items or gameplay by itself. It does load datapack files for its gear sets and brewing mixes, which other mods and datapacks can provide.

For developers

• Mod id: common_toolkit. Root package: com.skd.commontoolkit.
• It is not published to a Maven repository: build the JAR of the branch you target (./gradlew build, output in build/libs/) and add it to your project, for example:

dependencies {
    implementation files("libs/common_toolkit-<minecraft>-neoforge-<neoforge>-<version>.jar")
}

• Declare it as a required dependency in your neoforge.mods.toml:

[[dependencies.yourmod]]
    modId="common_toolkit"
    type="required"
    ordering="AFTER"
    side="BOTH"

Every release also publishes a -sources.jar.

Where to start:

You want to…	Use	Page
Load your own JSON files from datapacks, reloadable, synced to clients	DynamicRegistry / WeightedDynamicRegistry	Dynamic registries
Register payloads with less boilerplate	PayloadHelper, PayloadProvider	Developer utilities
Register blocks, items, effects… from one place	DeferredHelper	Developer utilities
Put items into existing creative tabs	TabFillingRegistry	Developer utilities
Random mob equipment from data	GearSetRegistry	Gear sets and brewing mixes