Getting Started¶

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

Declaring the dependency:

Maven

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

Gradle (Groovy)

 repositories {
    mavenCentral()
 }

 dependencies {
    implementation "net.kyori:adventure-api:4.20.0"
 }

Gradle (Kotlin)

 repositories {
    mavenCentral()
 }

 dependencies {
    implementation("net.kyori:adventure-api:4.20.0")
 }

Need development/snapshot builds? Using Snapshot Builds

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:

Maven

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

Gradle (Groovy)

repositories {
   maven {
       name = "sonatype-oss-snapshots1"
       url = "https://s01.oss.sonatype.org/content/repositories/snapshots/"
   }
}

Gradle (Kotlin)

repositories {
   maven(url = "https://s01.oss.sonatype.org/content/repositories/snapshots/") {
       name = "sonatype-oss-snapshots"
   }
}