Skip to main content

Getting Started

MiniPlaceholders is a plugin and mod that allows you to register global placeholders based on Adventure Components to be used in other plugin/mods instances.

Requires Paper 1.21 and higher, Velocity 3.3.0 and higher, Fabric 1.21.1+ or Sponge API 8+.

To continue, you first need knowledge of MiniMessage. To see how to use the MiniMessage API in MiniPlaceholders, check this section.

To use MiniPlaceholders API, you need Java 21 at least

Remember not to shade or relocate MiniMessage, as the platforms on which MiniPlaceholders run already have MiniMessage built in. MiniPlaceholders is only compatible with projects using native API, if you use Adventure Platform Bukkit either relocated or integrated, MiniPlaceholders will not be able to work properly

If you want a template to create your next expansion, you can use our template https://github.com/MiniPlaceholders/Template-Expansion

This guide is updated for MiniPlaceholders v3. If you need a guide for MiniPlaceholders v2, you can view the change history on this wiki

API Module ​

Javadocs

  repositories {
    mavenCentral()
  }

  dependencies {
    compileOnly("io.github.miniplaceholders:miniplaceholders-api:3.0.1")
  }

Kotlin Extra ​

Javadocs

Kotlin Extra is an API submodule that makes it easy to develop Expansions in Kotlin environments.

It can only be used in environments that provide kotlin-stdlib, such as Fabric with Fabric Language Kotlin, or with plugins that provide it, such as MCKotlin

  repositories {
    mavenCentral()
  }

  dependencies {
    compileOnly("io.github.miniplaceholders:miniplaceholders-kotlin-ext:3.0.1")
  }