Getting started

Add as a dependency

Since Prometheus 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 Prometheus common module.

Add required Maven repositories

In your root build.gradle add the following repositories:

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

Specify Prometheus version

In your gradle.properties add this line:

prometheus_version = 1.0.0

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

Import Prometheus common module

In your common build.gradle add the following dependency:

dependencies {
  implementation "it.crystalnest:prometheus-common:$minecraft_version-$prometheus_version"
}

Import Prometheus loader-specific modules

Fabric

In your fabric build.gradle add the following dependency:

dependencies {
  modImplementation "it.crystalnest:prometheus-fabric:$minecraft_version-$prometheus_version"
}

NeoForge

In your neoforge build.gradle add the following dependency:

dependencies {
  implementation "it.crystalnest:prometheus-neoforge:$minecraft_version-$prometheus_version"
}

Declare Prometheus dependency

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

Fabric

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

"depends": {
  "prometheus": "^${prometheus_version}"
}

Otherwise, if Prometheus is not strictly required, add this instead:

"suggests": {
  "prometheus": "^${prometheus_version}"
}

NeoForge

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

[[dependencies.${mod_id}]]
  modId = "prometheus"
  # Change this to "optional" if Prometheus is not required.
  type = "required"
  versionRange = "[${prometheus_version},)"
  ordering = "AFTER"
  side = "BOTH"