Developer Guide

WARNING

Before the release of the 1.0.0 version, the API is subject to breaking changes at any time.

Adding the Dependency

INFO

You can find all versions on the Modrinth Versions or GitHub Releases page.

This badge should display the latest version:

Via Modrinth Maven

Format: "maven.modrinth:perspective-api:${version}+${loader}-${minecraft_version}"

repositories {
  exclusiveContent {
    forRepository {
      maven {
        name = "Modrinth"
        url = uri("https://api.modrinth.com/maven")
      }
    }
    filter {
      includeGroup("maven.modrinth")
    }
  }
}

dependencies {
  // Use `implementation` for >=26.1
  modImplementation("maven.modrinth:LIqveQm1:1.0.0-beta.9+fabric-26.2")
}

Adding com.google.auto.service (Optional)

dependencies {
  compileOnly("com.google.auto.service:auto-service-annotations:1.1.1")
  annotationProcessor("com.google.auto.service:auto-service:1.1.1")
}

This makes SPI implementation more convenient, without having to manually edit service files.

Demo Mod

Perspective API Demo implements several custom perspectives and can be used as a development reference.

---