Danger

The Adventure docs are currently a work in progress. Some areas may have limited coverage or may not be entirely up to date. Feel free to join our discord at https://discord.gg/MMfhJ8F if you have any questions.

Adventure

Warning

This documentation is for an unreleased version of Adventure. Some information may not be up to date, and API is subject to change.

Adventure is a library for server-controllable user interface elements in Minecraft: Java Edition.

Importing Adventure into your project

First, add the repository:

<repositories>
    <!-- ... -->
    <repository> <!-- for development builds -->
       <id>sonatype-oss</id>
       <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
    </repository>
    <!-- ... -->
</repositories>
repositories {
   // for development builds
   maven {
       name = 'sonatype-oss'
       url = 'https://oss.sonatype.org/content/repositories/snapshots/'
   }
   // for releases
   mavenCentral()
}
repositories {
   // for development builds
   maven(url = "https://oss.sonatype.org/content/repositories/snapshots/") {
       name = "sonatype-oss"
   }
   // for releases
   mavenCentral()
}

Declaring the dependency:

<dependency>
   <groupId>net.kyori</groupId>
   <artifactId>adventure-api</artifactId>
   <version>4.0.0-SNAPSHOT</version>
</dependency>
dependencies {
   implementation 'net.kyori:adventure-api:4.0.0-SNAPSHOT'
}
dependencies {
   implementation("net.kyori:adventure-api:4.0.0-SNAPSHOT")
}

Indices and tables