Iridium

ANY VERSION UNDER 3.0.0 SHOULD BE CONSIDERED HIGHLY UNSTABLE AND SHOULD NOT BE USED

Major JarInJar system changes since v3.0.0 please refer to V3 Doc

kotlin jar-in-jars made easy

Iridium Sticker

[![](https://teamvoided.org/iridium-sticker.png)](https://github.com/TeamVoided/iridium)

Iridium Usage

settings.gradle.kts

pluginManagement {
    repositories {
        //other repos
        maven("https://maven.teamvoided.org/releases")
    }
}

root build.gradle.kts

plugins {
    id("org.teamvoided.iridium") version "3.0.0" //will automatically use root project for jarInJar
    //maven publishing id("iridium.project.publish-script")
}

module build.gradle.kts

plugins {
    id("iridium.mod.build-script")
    //upload mod to modrinth id("iridium.mod.upload-script")
    //maven publishing id("iridium.project.publish-script")
}

jar-in-jar script

plugins {
    id("iridium.mod.jar-in-jar")
    id("iridium.mod.build-script")
    //upload mod to modrinth id("iridium.mod.upload-script")
}

The Iridium Config Spec

Although you can configure Iridium in the gradle build script, Iridium can load config files in TOML, JSON5, YAML & JSON

If Iridium detects that no changes were made to the config in the gradle build script it will attempt to load config files in this order (assume all files are in the gradle/iridium directory):

• iridium.toml
• iridium.json5
• iridium.yml
• iridium.json

i didn't tell you this but if Iridium fails to find a config file it will autogenerate a toml one

The Actual Spec

projectTitle: String
modId: String
githubRepo: String
discordServerInviteId: String
authors: List<String>
majorMinecraftVersion: String
minecraftVersion: String
mappings: Mappings object (details below)
fabricLoaderVersion: String
fabricApiVersion: String
fabricLangKotlinVersion: String
license: String
modules: List<String>

The Mappings Object Spec

type: MappingsType (any of "MOJANG", "YARN", "PARCHMENT", "QUILT", "MOJPARCH", "MOJYARN"
version: String? (Irrelevant for MappingsType.MOJANG, leave either null or blank)

The JarInJar Script

This is what you came here for right???

The Jar In Jar script will automatically add all modules defined in the iridium config file to your mod jar

Mod Build Script V1.2.0+

The Mod Build Script plugin will auto generate a mod json for you

As of iridium version 1.2.0 a closure/configuration action is used to define its properties

To set the description/version you still use the default project.description/version properties

Here's an example

plugins {
    kotlin("jvm") version "1.9.0"
    kotlin("plugin.serialization") version "1.9.0"
    id("iridium.mod.build-script")
}

modSettings {
    modId("example-mod")
    modName("Example Mod")
    // other properties
}

/*irrelevant as of v2.0.0+*/ base.archivesName.set("example-mod")
version = project.properties["mod_version"] as String
description = "Example Mod Description"
group = project.properties["maven_group"] as String

Advanced stuff v2.0.0+

Iridium will generate a default mod json, however if you want to edit the data itself you can use mutations

Here's in example

modSettings {
    mutation {
        this.languageAdapters["customAdapter"] = "adapter.example.Adapter"
    }
}

Mod Build Script V1.1.1 and under

The Mod Build Script plugin will auto generate a mod json for you

here are the properties

• modId (the mod id as a string)
• modName (name of the mod as a string)
• modEntrypoints (entry points of the mod as a LinkedHashMap of String and List of Strings where the initial string is the name of the entrypoint and the list of strings contains the actual entry points)
• modMixinFiles (the mixin files of the mod as a list of strings)
• modDepends (the dependencies of the mod as a LinkedHashMap of String and String where the initial string is the mod id and the secondary string is the version of the dependency)
• isModParent (if this is the parent of all the other mods (if it is a jar-in-jar mod [boolean])
• customModIcon (a custom icon for the mod defaults to "assets/{modId}/icon.png)"

To set the description/version use the default project.description/version properties

Setting a property in the gradle build script

//other gradle stuff
val examplePropertyName by extra("examplePropertyValue")

This is cool and all but what if I want one of my modules to depend on another

Well fret not, you can simply use the "dependencyHelper" extension provided by the mod build script

Here's an example

plugins {
    //other stuff
    id("iridium.mod.build-script")
}

dependencies {
    implementation(dependencyHelper.modProject(":some-module"))
}