Skip to content

Mod Usage

TheDeathlyCow edited this page Jul 12, 2024 · 19 revisions

Thermoo can be installed on servers without also requiring clients to install Thermoo, however the temperature and wetness data pieces will still (attempt) to synchronize with clients in case you want to, for example, display these on the HUD in your mod.

Setup

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. For example, v1.4. See the available versions on Jitpack

Usage

The following guides provide explanations and examples for using temperature in your own mod:

  1. Temperature Basics
  2. Temperature Attributes
  3. Temperature Changes
  4. Soaking
  5. Environment Controller and Events
  6. Temperature Effects

Extra APIs

These are extra APIs, primarily meant to promote integration with other mods:

FAQ

How does Powder Snow freezing work with Thermoo?

It doesn't. How to reconcile the (rather limited) vanilla temperature system added through Powder Snow is left to you to figure out for your own mod's needs.

One solution is to simply disable Powder Snow freezing and convert all temperature changes to a Thermoo temperature change. Frostiful provides example code mixins for how to do this: https://github.com/TheDeathlyCow/frostiful/tree/0.5.3/src/main/java/com/github/thedeathlycow/frostiful/mixins/powder_snow_effects