Getting Started

Supported on Quilt Supported on Fabric Supported on Forge

JamLib is a set of cross-platform APIs developed with Architectury that we use for all of our mods.

You are also free to use JamLib in your projects, hence we have created this documentation on it.

Features

JSON5 configuration with automatic config screens.

Adding JamLib to Your Project

ArchitecturyFabricQuiltForge

Using Gradle PropertiesUsing Version Catalogues

gradle.properties

# rest of properties file ...
# find this at https://github.com/JamCoreModding/jamlib/releases
jamlib_version=1.0.1

build.gradle

allprojects {
    repositories {
        // rest of repositories block...

        maven {
            name = "Jamalam's Maven"
            url = "https://maven.jamalam.tech/releases"

            content {
                includeGroup "io.github.jamalam360"
            }
        }
    }
}

common/build.gradle

dependencies {
    // rest of dependencies block...

    modImplementation "io.github.jamalam360:jamlib:${jamlib_version}"
}

fabric/build.gradle

dependencies {
    // rest of dependencies block...

    modImplementation "io.github.jamalam360:jamlib-fabric:${jamlib_version}"
}

forge/build.gradle

dependencies {
    // rest of dependencies block...

    modImplementation "io.github.jamalam360:jamlib-forge:${jamlib_version}"
    // Dependency of JamLib. Forge requires that we specify this
    forgeRuntimeLibrary "blue.endless:jankson:1.2.3"
}

quilt/build.gradle

dependencies {
    // rest of dependencies block...

    modImplementation "io.github.jamalam360:jamlib-quilt:${jamlib_version}"
}

Version Catalogue

[versions]
# rest of versions...
# find this at https://github.com/JamCoreModding/jamlib/releases
jamlib = "1.0.1"

[libraries]
# rest of libraries...
jamlib-common = { module = "io.github.jamalam360:jamlib", version.ref = "jamlib" }
jamlib-fabric = { module = "io.github.jamalam360:jamlib-fabric", version.ref = "jamlib" }
jamlib-quilt = { module = "io.github.jamalam360:jamlib-quilt", version.ref = "jamlib" }
jamlib-forge = { module = "io.github.jamalam360:jamlib-forge", version.ref = "jamlib" }

build.gradle

allprojects {
    repositories {
        // rest of repositories block...

        maven {
            name = "Jamalam's Maven"
            url = "https://maven.jamalam.tech/releases"

            content {
                includeGroup "io.github.jamalam360"
            }
        }
    }
}

common/build.gradle

dependencies {
    // rest of dependencies block...

    modImplementation libs.jamlib.common
}

fabric/build.gradle

dependencies {
    // rest of dependencies block...

    modImplementation libs.jamlib.fabric
}

forge/build.gradle

dependencies {
    // rest of dependencies block...

    modImplementation libs.jamlib.forge
    // Dependency of JamLib. Forge requires that we specify this
    forgeRuntimeLibrary "blue.endless:jankson:1.2.3"
}

quilt/build.gradle

dependencies {
    // rest of dependencies block...

    modImplementation libs.jamlib.quilt
}

Using Gradle PropertiesUsing Version Catalogues

gradle.properties

# rest of properties file ...
# find this at https://github.com/JamCoreModding/jamlib/releases
jamlib_version=1.0.1

build.gradle

repositories {
    // rest of repositories block...

    maven {
        name = "Jamalam's Maven"
        url = "https://maven.jamalam.tech/releases"

        content {
            includeGroup "io.github.jamalam360"
        }
    }
}

dependencies {
    // rest of dependencies block...

    modImplementation "io.github.jamalam360:jamlib-fabric:${jamlib_version}"
}

Version Catalogue

[versions]
# rest of versions...
# find this at https://github.com/JamCoreModding/jamlib/releases
jamlib = "1.0.1"

[libraries]
# rest of libraries...
jamlib = { module = "io.github.jamalam360:jamlib-fabric", version.ref = "jamlib" }

build.gradle

repositories {
    // rest of repositories block...

    maven {
        name = "Jamalam's Maven"
        url = "https://maven.jamalam.tech/releases"

        content {
            includeGroup "io.github.jamalam360"
        }
    }
}

dependencies {
    // rest of dependencies block...

    modImplementation libs.jamlib
}

Using Gradle PropertiesUsing Version Catalogues

gradle.properties

# rest of properties file ...
# find this at https://github.com/JamCoreModding/jamlib/releases
jamlib_version=1.0.1

build.gradle

repositories {
    // rest of repositories block...

    maven {
        name = "Jamalam's Maven"
        url = "https://maven.jamalam.tech/releases"

        content {
            includeGroup "io.github.jamalam360"
        }
    }
}

dependencies {
    // rest of dependencies block...

    modImplementation "io.github.jamalam360:jamlib-quilt:${jamlib_version}"
}

Version Catalogue

[versions]
# rest of versions...
# find this at https://github.com/JamCoreModding/jamlib/releases
jamlib = "1.0.1"

[libraries]
# rest of libraries...
jamlib = { module = "io.github.jamalam360:jamlib-quilt", version.ref = "jamlib" }

build.gradle

repositories {
    // rest of repositories block...

    maven {
        name = "Jamalam's Maven"
        url = "https://maven.jamalam.tech/releases"

        content {
            includeGroup "io.github.jamalam360"
        }
    }
}

dependencies {
    // rest of dependencies block...

    modImplementation libs.jamlib
}

Using Gradle PropertiesUsing Version Catalogues

gradle.properties

# rest of properties file ...
# find this at https://github.com/JamCoreModding/jamlib/releases
jamlib_version=1.0.1

build.gradle

repositories {
    // rest of repositories block...

    maven {
        name = "Jamalam's Maven"
        url = "https://maven.jamalam.tech/releases"

        content {
            includeGroup "io.github.jamalam360"
        }
    }
}

dependencies {
    // rest of dependencies block...

    implementation fg.deobf("io.github.jamalam360:jamlib-forge:${jamlib_version}")
    // Dependency of JamLib. Forge requires that we specify this
    forgeRuntimeLibrary "blue.endless:jankson:1.2.3"
}

Version Catalogue

[versions]
# rest of versions...
# find this at https://github.com/JamCoreModding/jamlib/releases
jamlib = "1.0.1"

[libraries]
# rest of libraries...
jamlib = { module = "io.github.jamalam360:jamlib-forge", version.ref = "jamlib" }

build.gradle

repositories {
    // rest of repositories block...

    maven {
        name = "Jamalam's Maven"
        url = "https://maven.jamalam.tech/releases"

        content {
            includeGroup "io.github.jamalam360"
        }
    }
}

dependencies {
    // rest of dependencies block...

    implementation fg.deobf(libs.jamlib)
    // Dependency of JamLib. Forge requires that we specify this
    forgeRuntimeLibrary "blue.endless:jankson:1.2.3"
}

Once JamLib is successfully in your development environment, you can add a dependency on it to your mod metadata.

FabricQuiltForge

fabric.mod.json

{
    // rest of JSON
    "depends": {
        // rest of depends
        "jamlib": ">=1.0.0"
    }
}

quilt.mod.json

{
    // rest of JSON
    "quilt_loader": {
        // rest of quilt_loader
        "depends": [
            // rest of depends
            {
                "id": "jamlib",
                "version": ">=1.0.0"
            }
        ]
    }
}

META-INF/mods.toml

[[dependencies.YOUR_MOD_ID]]
modId = "jamlib"
mandatory = true
versionRange = "[1.0.0,)"
ordering = "AFTER"
side = "BOTH"

Refer to the sidebar for documentation on the available APIs within JamLib.