Thermoo

Adding Thermoo to Your Mod

Add the repository to your build.gradle

repositories {
    maven { url "https://jitpack.io/" }
    // Needed as Thermoo uses Cardinal Components 
    maven {
		name = "Ladysnake Mods"
		url = 'https://maven.ladysnake.org/releases'
    }
}

Add the dependency to your build.gradle

dependencies {
    modImplementation "com.github.thedeathlycow:thermoo:VERSION"
}

Replace 'VERSION' with the version you want to use. See the available versions on Jitpack

Using Thermoo

Usage of Thermoo, for both mods and datapacks, is documented on the wiki

LTS Policy

These are the current versions being supported by Thermoo.

Minecraft Version	Support Status
1.21.3	✅ Supported
1.21.1	✅ Supported
1.20.6	❌ Unsupported
1.20.4	❌ Unsupported
1.20.2	❌ Unsupported
1.20.1	⚠️ Critical fixes only
1.19.4	❌ Unsupported
1.19.2	❌ Unsupported

Status Definitions:

• ✅ Supported: This version is fully supported and will receive all new features, fixes, and updates (where possible)
• ⚠️ Critical fixes only: This version will receive only critical crash and security fixes, as well as minor features where they can be easily cherry-picked
• ❌ Unsupported: This version will receive no future updates, except for critical security fixes

Build and Test Instructions

Thermoo is built using Gradle with the Fabric Loom Gradle plugin.

To make a production build of Thermoo, run the following command:

gradlew build
# On windows add a ./
./gradlew build

The built jars will appear in /build/libs/, and will include a regular jar, a -sources jar, and a -javadoc jar. To play Thermoo, install Fabric API andCardinal Components API and install the regular into your Minecraft /mods folder.

To run Thermoo's unit tests, run the following command:

gradlew check

Thermoo also includes some game tests, to automatically run them use the following command:

gradlew runGametest

Finally, you can manually test Thermoo in a Minecraft environment using the test mod:

gradlew runTestmodClient

This will launch a Minecraft instance with a test mod that includes implements Thermoo's API features for testing.

If you instead want a clean test Minecraft instance with no gameplay modifications, run with the following:

gradlew runClient