NilKit API

Independent community tooling and APIs for NilLoader-based Minecraft development.

NilKit API provides reusable utilities for mods built around NilLoader, with a particular focus on legacy Minecraft development.

Important

NilKit API is not an official NilLoader project and is not required to use NilLoader.

NilLoader itself is maintained separately: https://git.sleeping.town/Nil/NilLoader

What does NilKit API provide?

NilKit API collects optional developer-facing utilities that would otherwise need to be reimplemented across multiple nilmods, including:

• Event dispatching and lifecycle helpers
• Reflection and class-patching utilities
• Legacy Minecraft mapping/remapping tooling
• General-purpose KDL utilities
• Java NIO networking helpers
• Standardized logging helpers
• Optional developer-toolbox integrations

The project is intended to complement NilLoader, not replace or reimplement it.

Minecraft compatibility

The core library does not require a hard bytecode link to a specific Minecraft JAR.

Minecraft-facing helpers are resolved lazily and depend on mappings compatible with the target game version. Minecraft 1.4.7 currently has built-in fallback mappings, while additional mapping data can be sourced from the tools/MinecraftRemapping submodule during development/build tooling.

See Minecraft compatibility.

Gradle

repositories {
    maven {
        url = uri("https://repo.tamkungz.me")
    }
}

dependencies {
    implementation "me.tamkungz.nilkit:nilkit:4.1.0"
}

Quick build

Gradle itself should run on a supported modern JDK, while the library targets Java 8 bytecode.

Linux/macOS:

./gradlew clean build

Windows:

gradlew.bat clean build

If your system default Java is incompatible with the Gradle version used by the project, see Building.

Documentation

• Features and API areas
• Minecraft compatibility
• Entrypoints
• Logging
• Metadata and KDL
• Mappings and remapping
• Networking
• Developer toolbox (-all.jar)
• Project architecture
• Building and CI
• Project-local Maven publishing

For release history, see CHANGE.md.

Upstream NilLoader

NilLoader is a separate project and remains under the control of its original maintainers.

• Official repository: https://git.sleeping.town/Nil/NilLoader
• GitHub mirror: https://github.com/exaskye/NilLoader

NilKit API does not claim ownership of NilLoader, its source code, or its branding.

License

NilKit API is licensed under the GNU Lesser General Public License v3.0 or later (LGPL-3.0-or-later).

See LICENSE for the full license text.