Journey API

Journey has a shared "core" java API library a separate java API component for each platform that Journey runs on.

To use the Journey API, you must download the dependency using your project's build tool: Maven or Gradle. The platform-specific libraries have a few helpful tools, but you may not need them because most of the API resides the shared library.

Declaring Dependencies

Gradle

repositories {
  mavenCentral()
}

dependencies {
  implementation 'net.whimxiqal.journey:core-api:<version>[-SNAPSHOT]'
  implementation 'net.whimxiqal.journey:<platform_id>-api:<version>[-SNAPSHOT]'
}

Maven

<dependencies>
    <dependency>
        <groupId>net.whimxiqal.journey</groupId>
        <artifactId>core-api</artifactId>
        <version>version[-SNAPSHOT]</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

To use snapshots, you must add the snapshot repository:

Gradle

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

Maven

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

The platforms and their identifiers are below:

Platform	ID
Bukkit (Paper/Purpur)	bukkit

Kyori Adventure

Journey uses the Kyori Aventure library. You should not need to add it manually as a dependency.