Home

This is a shared code library that exposes multiple items without dedicated implementations, thus mods can freely use (or ignore) them for custom features. The library is based on a multiloader template, thus making it fully compatible with loader-specific MDKs and other multiloader templates.

What is Knight Lib for?

Knight Lib is designed for use in any project, either as the foundation for your own mod or as a required dependency for any of my mods. Its primary goals are to eliminate code duplication and provide unified, easy-to-use implementations of common utilities, ensuring compatibility across all mod loaders.

Within the core components, this library includes:
- A custom tick scheduler without data persistance.
- An Auto Config system available for Fabric and (Neo)Forge, with hotreload support (for Forge it's compatible with mods that add gui config, such as 'Configured'). The config is instantly read upon executing the mod that implements it, thus supporting configurability that was not possible before. It also contains multiple styles to decorate the TOML file.
- A custom boss bar builder to dynamically create and manage either simple or complex boss bars for registered bosses.
- A highly customizable camera shake manager for player cameras, designed for effortless usage.
- A music provider for entities, primarily meant for "Boss" entities. Easy-to-use utility, loops a music instance under certain conditionals.

More functionalities will be added over time, so any suggestion is welcome.



To report bugs or suggest features, join our Discord server.

How do I integrate this library into my project?

Include the maven repository under your "repositories" category, and then add the knightlib jar dependency.

repositories {
    maven {
        name = "Xylonity's vault"
        url = "https://raw.githubusercontent.com/Xylonity/maven-centralish/main/maven/"
    }
}

dependencies {
    // Forge
    implementation fg.deobf("dev.xylonity.knightlib:knightlib-forge-${minecraft_version}:${knightlib_version}")
    // Fabric
    modImplementation "dev.xylonity.knightlib:knightlib-fabric-${minecraft_version}:${knightlib_version}"
    // Common (in case you're using a multiloader template)
    implementation "dev.xylonity.knightlib:knightlib-common-${minecraft_version}:${knightlib_version}"

    // Forge implementation example
    implementation fg.deobf("dev.xylonity.knightlib:knightlib-forge-1.20.1:1.3.0")
}