LogoUndefined Creations
Getting Started

Setup

To use the Stellar API in your project, we first need to import this into the project.

Here is a list of platforms:

VersionSpigotPaper
1.20.6 - Latest
1.13 - 1.20.6

Paper can still be used on older versions, with the SpigotMC module.

Accessing the API

First add the repository:

maven {
    name = "undefined-repo"
    url = "https://repo.undefinedcreations.com/releases"
}

Latest Version

Then add the library to your dependencies:

compile 'com.undefined:stellar:(latest version):platform' // or implementation if shadowing

Using Stellar

To actually use Stellar, you have two options:

  1. Adding the plugin on your server
  2. Shadowing the dependency.

Adding the plugin to your server

Another option is to add the Stellar plugin to your server. This is a good option for when you have multiple plugins that use Stellar. You can get the latest JAR from the GitHub releases: https://github.com/UndefinedCreations/Stellar/releases.

Shadowing the dependency

Shadowing means that you stellar will be included in the built JAR. If you use Gradle, it's suggested to use the gradleup shadow plugin, and if you are using Maven it's suggested to use the maven shade plugin.

Important

You should modify your Gradle dependency to implementation instead of compile/compileOnly and remove the scope block from your Maven dependency.