Skip to content

Getting started

Crystal Spider edited this page Dec 31, 2024 · 6 revisions

Add as a dependency

Since Leathered Boots is built on a MultiLoader environment, you can depend on it regardless of whether you use a MultiLoader environment too or not.

Note: if you're not using a MultiLoader environment, the root build.gradle and the loader-specific build.gradle are the same, and you don't need Leathered Boots common module.

Add required Maven repositories

In your root build.gradle add the following repositories:

repositories {
  // Required only for 1.18.2
  maven { url = "https://jitpack.io" }
  // Crystal Nest repository where Leathered Boots is hosted.
  exclusiveContent {
    forRepository {
      maven {
        name = "Crystal Nest"
        url = "https://maven.crystalnest.it"
      }
    }
    filter {
      includeGroup "it.crystalnest"
    }
  }
}

Specify Leathered Boots version

In your gradle.properties add this line:

leathered_boots_version = 6.0.1

Make sure to point to the latest version for the specific Minecraft version.

Import Leathered Boots common module

In your common build.gradle add the following dependency:

dependencies {
  implementation "it.crystalnest:leathered-boots-common:$minecraft_version-$leathered_boots_version"
}

Import Leathered Boots loader-specific modules

Fabric

In your fabric build.gradle add the following dependency:

dependencies {
  modImplementation "it.crystalnest:leathered-boots-fabric:$minecraft_version-$leathered_boots_version"
}
NeoForge

In your neoforge build.gradle add the following dependency:

dependencies {
  implementation "it.crystalnest:leathered-boots-neoforge:$minecraft_version-$leathered_boots_version"
}
The NeoForge module is available since version 1.20.2.
Forge

In your forge build.gradle add the following dependency:

dependencies {
  // Forge deobfuscation strips dependencies, so you need to import Cobweb too. If missing, add the version property and set it to 1.0.0
  implementation fg.deobf("it.crystalnest:cobweb-forge:$minecraft_version-$cobweb_version")
  implementation fg.deobf("it.crystalnest:leathered-boots-forge:$minecraft_version-$leathered_boots_version")
}
The Forge module is unavailable since version 1.21.

Declare Leathered Boots dependency

Depending on the mod loader, you need to declare Leathered Boots dependency in different ways.

Fabric

In your fabric.mods.json add the following dependency:

"depends": {
  "leathered_boots": "^${leathered_boots_version}"
}

Otherwise, if Leathered Boots is not strictly required, add this instead:

"suggests": {
  "leathered_boots": "^${leathered_boots_version}"
}
NeoForge

In your mods.toml (neoforge.mods.toml since 1.20.5) add the following dependency:

[[dependencies.${mod_id}]]
  modId = "leathered_boots"
  # Change this to "optional" if Leathered Boots is not required.
  # Change this field to use Forge syntax if on 1.20.2
  type = "required"
  versionRange = "[${leathered_boots_version},)"
  ordering = "AFTER"
  side = "BOTH"
Forge

In your mods.toml add the following dependency:

[[dependencies.${mod_id}]]
  modId = "leathered_boots"
  mandatory = true # Change this to false if Leathered Boots is not required.
  versionRange = "[${leathered_boots_version},)"
  ordering = "AFTER"
  side = "BOTH"

Other requirements

Not much else is really needed, however, since leathered boots can only be made out of other existing armors, it only make sense that the following 2 points are already covered by you:

  • You have your own custom ArmorMaterial(s) for your own custom armor set.
  • You have the textures for your armor pieces, both item (in inventory) and armor (equipped) versions.