M4id Library

A Kotlin toolkit for Minecraft mods on Fabric and NeoForge.

Write commands, networking, configuration, and registration once using Kotlin DSLs, then use them across both mod loaders. M4id is a shared library dependency for my mods.

Note: M4id is currently in alpha. APIs may change between releases, and breaking changes are expected before version 1.0.

Features

Installation

M4id is published through JitPack.

Each Minecraft version and loader combination is published as a separate artifact named <minecraft>-<loader>. For example, 1.21.1-fabric.

Gradle (Kotlin DSL)

Add JitPack to your repositories:

repositories {
    maven("https://jitpack.io")
}

Then add the appropriate dependency.

Fabric

dependencies {
    modImplementation(
        "com.github.DoctorM4id.M4id:1.21.1-fabric:0.1.0-alpha.5"
    )
}

NeoForge

dependencies {
    implementation(
        "com.github.DoctorM4id.M4id:1.21.1-neoforge:0.1.0-alpha.5"
    )
}

The JitPack project page provides the available artifacts and build information. You can also browse the GitHub tags for published versions.

Loader requirements

• Fabric: The Kotlin standard library and kotlinx.serialization are bundled into the M4id JAR.
• NeoForge: Requires Kotlin for Forge at runtime.

Compatibility

Minecraft versions between those listed above are skipped.

For the full compatibility matrix and the latest release for each supported version, see SECURITY.md.

Java requirement: Minecraft 1.20.5 and newer requires Java 21.

Project layout

M4id/
├── build-logic/                  # Convention plugins, manifests, publishing, mixins
├── build.fabric.gradle.kts       # Fabric build configuration
├── build.neoforge.gradle.kts     # NeoForge build configuration
├── stonecutter.properties.toml   # Mod metadata and per-version dependencies
└── src/
    ├── fabric/                   # Fabric-specific code
    ├── neoforge/                 # NeoForge-specific code
    └── main/
        ├── java/dev/doctorm4id/
        │   ├── m4id/
        │   │   ├── command/      # Command DSL
        │   │   ├── message/      # Networking
        │   │   ├── data/         # Configuration and data files
        │   │   ├── serial/       # Serializers
        │   │   ├── registration/ # Auto-registrar
        │   │   ├── text/         # Text builder
        │   │   ├── input/        # Keybinds
        │   │   ├── ext/          # Extension functions
        │   │   ├── platform/     # Platform abstractions and implementations
        │   │   ├── util/         # General utilities
        │   │   └── internal/     # Internal code, mixins, and tests
        │   └── percale/          # Codec, NBT, and Gson bridges
        └── resources/            # Mixins, access wideners, and assets

Support

• Community: Join the Discord server
• Bugs and feature requests: Open a GitHub issue
• Security issues: GitHub Security

Credits

M4id includes code derived from Kambrik and Percale. Thanks to the original authors for their work.

License

M4id is licensed under the Mozilla Public License 2.0.