API - Streamline-Essentials/StreamlineWiki GitHub Wiki

Table of Contents:

Requirements

  • You will need to have basic programming knowledge.
  • Use Java 11 for backwards compatibility.
  • I would recommend using IntelliJ IDEA for development.
    • This tutorial will be using IntelliJ IDEA.

Repositories

Gradle

repositories {
    mavenCentral()
    maven { url = 'https://oss.sonatype.org/content/repositories/snapshots' }
    maven { url = 'https://oss.sonatype.org/content/repositories/central' }
    maven { url = 'https://jitpack.io' }
}

Maven

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

Dependencies

Gradle

Main Core:

dependencies {
  compileOnly "net.luckperms:api:5.4"

  compileOnly("com.github.Streamline-Essentials.StreamlineCore:StreamlineCore-API:main-SNAPSHOT")
  annotationProcessor("com.github.Streamline-Essentials.StreamlineCore:StreamlineCore-API:main-SNAPSHOT")
}

Spigot Core (for development with Spigot):

Note: The Spigot Core has the Main Core inside it (so you don't need to add the Main Core as a dependency).
dependencies {
    compileOnly "net.luckperms:api:5.4"

    compileOnly("com.github.Streamline-Essentials.StreamlineCore:StreamlineCore-BAPI:main-SNAPSHOT")
    annotationProcessor("com.github.Streamline-Essentials.StreamlineCore:StreamlineCore-BAPI:main-SNAPSHOT")
}

Maven

Main Core:

<dependencies>
    <dependency>
        <groupId>net.luckperms</groupId>
        <artifactId>api</artifactId>
        <version>5.4</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>com.github.Streamline-Essentials.StreamlineCore</groupId>
        <artifactId>StreamlineCore-API</artifactId>
        <version>main-SNAPSHOT</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

Spigot Core (for development with Spigot):

Note: The Spigot Core has the Main Core inside it -- so you don't need to add the Main Core as a dependency.
<dependencies>
    <dependency>
        <groupId>net.luckperms</groupId>
        <artifactId>api</artifactId>
        <version>5.4</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>com.github.Streamline-Essentials.StreamlineCore</groupId>
        <artifactId>StreamlineCore-BAPI</artifactId>
        <version>main-SNAPSHOT</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

Deeper Dive

  • Clone the ExampleModule repository from here.
  • More will be added later!
⚠️ **GitHub.com Fallback** ⚠️