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.

Getting Started

To use Adventure in your project, you will need to add the following dependency and repository (if using Gradle):

 <dependency>
    <groupId>net.kyori</groupId>
    <artifactId>adventure-api</artifactId>
    <version>4.8.1</version>
 </dependency>

Some platforms already use Adventure natively. In this case, you will not need to add Adventure as a dependency. To view the list of platforms that include Adventure, see Native Support.

To use Adventure with other platforms, you may wish to look at the platform-specific adapters. A list of platforms with supported adapters can be found at Platforms.

Using Snapshot Builds

To use snapshot builds, you will need to add the following repository:

<repositories>
    <repository>
       <id>sonatype-oss-snapshots</id>
       <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
    </repository>
</repositories>