Getting Started

BiomesAPI is a custom biome API for Paper servers without the use of datapacks. Our wrappers allow you to easily add new biomes to the game and send them to clients without touching any internals.

Compatibility

BiomesAPI is compatible with Minecraft 1.21.11 and 26.1.2+ and requires a Paper server running on Java 25 or later. BiomesAPI is also compatible with Folia, but it is up to you to ensure that the rest of your plugin is compatible with Folia if you choose to support it.

Installation

Installation depends on your build system and whether you choose to use BiomesAPI as a shaded dependency or external plugin dependency. This guide will assume you are using Gradle (Kotlin DSL) and will cover both shaded and external dependency methods.

The latest stable release is 2.2.0 and the latest snapshot is 2.3.0-b0a02a2.

Shaded External

Kotlin Copy

plugins {
  id("com.gradleup.shadow") version "9.4.2"
}

repositories {
  maven("https://repo.jsinco.dev/releases/")
}

dependencies {
  implementation("me.outspending.biomesapi:BiomesAPI:2.2.0")
}

tasks {
  shadowJar {
      val pack = "com.example.testplugin"
      relocate("me.outspending.biomesapi", "$pack.biomesapi")
      archiveClassifier.set("") // Remove the -all suffix
  }

  jar {
      enabled = false // Disable the default jar task
  }

  build {
      dependsOn(shadowJar) // Ensure the shadowJar task is run before the build
  }
}

repositories {
  maven("https://repo.jsinco.dev/releases/")
}

dependencies {
  compileOnly("me.outspending.biomesapi:BiomesAPI:2.2.0")
}

If you are using BiomesAPI as external dependency you will need to add BiomesAPI as a plugin dependency in your plugin.yml, or paper-plugin.yml.

Bukkit Plugin Paper Plugin

YAML Copy

name: ExamplePlugin
main: com.example.ExamplePlugin
version: 1.0-SNAPSHOT
api-version: 1.21
depend: [BiomesAPI] # Add this line!

name: ExamplePlugin
main: com.example.ExamplePlugin
bootstrapper: com.example.ExampleBootstrapper
version: 1.0-SNAPSHOT
api-version: 1.21
# Add these lines:
dependencies:
  bootstrap:
    BiomesAPI:
      load: BEFORE
      required: true
      join-classpath: true
  server:
    BiomesAPI:
      load: BEFORE
      required: true
      join-classpath: true

BiomesAPI external dependency plugin can be found on our GitHub releases or Modrinth.

Leave a Star, Please!

If you find BiomesAPI useful, please consider leaving a star on our GitHub repository.