Getting started

Add as a dependency

Since Fancy Entity Renderer 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 Fancy Entity Renderer common module.

Add required Maven repositories

In your root build.gradle add the following repositories:

repositories {
  // Crystal Nest repository where Fancy Entity Renderer is hosted.
  exclusiveContent {
    forRepository {
      maven {
        name = "Crystal Nest"
        url = "https://maven.crystalnest.it"
      }
    }
    filter {
      includeGroup "it.crystalnest"
    }
  }
}

Specify Fancy Entity Renderer version

In your gradle.properties add this line:

fer_version = 0.2.0

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

Import Fancy Entity Renderer common module

In your common build.gradle add the following dependency:

dependencies {
  implementation "it.crystalnest:fancy-entity-renderer-common:$minecraft_version-$fer_version"
}

Import Fancy Entity Renderer loader-specific modules

Fabric

In your fabric build.gradle add the following dependency:

dependencies {
  modImplementation "it.crystalnest:fancy-entity-renderer-fabric:$minecraft_version-$fer_version"
}

NeoForge

In your neoforge build.gradle add the following dependency:

dependencies {
  implementation "it.crystalnest:fancy-entity-renderer-neoforge:$minecraft_version-$fer_version"
}

Forge

In your forge build.gradle add the following dependency:

dependencies {
  implementation fg.deobf("it.crystalnest:fancy-entity-renderer-forge:$minecraft_version-$fer_version")
}

Declare Fancy Entity Renderer dependency

Depending on the mod loader, you need to declare Fancy Entity Renderer dependency in different ways.

Fabric

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

"depends": {
  "fancy_entity_renderer": "^${fer_version}"
}

Otherwise, if Fancy Entity Renderer is not strictly required, add this instead:

"suggests": {
  "fancy_entity_renderer": "^${fer_version}"
}

NeoForge

In your neoforge.mods.toml add the following dependency:

[[dependencies.${mod_id}]]
  modId = "fancy_entity_renderer"
  # Change this to "optional" if Fancy Entity Renderer is not required.
  type = "required"
  versionRange = "[${fer_version},)"
  ordering = "AFTER"
  side = "CLIENT"

Forge

In your mods.toml add the following dependency:

[[dependencies.${mod_id}]]
  modId = "fancy_entity_renderer"
  mandatory = true # Change this to false if Fancy Entity Renderer is not required.
  versionRange = "[${fer_version},)"
  ordering = "AFTER"
  side = "CLIENT"