Project setup

Maven dependencies

You need to add some dependencies in order to work with Cirrus. Please ensure you are using the latest version of the dependencies. This article may not contain up-to-date version numbers of dependencies.

Replace VERSION with the latest Cirrus version.

Repositories:

<repository>
  <id>simplixsoft-public</id>
  <url>https://repo.simplix.dev/repository/simplixsoft-public/</url>
</repository>

For Spigot also add:

<repository>
  <id>exceptionflug</id>
  <url>https://mvn.exceptionflug.de/repository/exceptionflug-public/</url>
</repository>

Dependencies & Initialization

Spigot

<dependency>  
  <groupId>dev.simplix.cirrus</groupId>
  <artifactId>cirrus-spigot</artifactId>
  <version>VERSION</version>
´</dependency>
<dependency>  
  <groupId>dev.simplix</groupId>  
  <artifactId>protocolize-api</artifactId>  
  <version>2.1.0</version>  
</dependency>

import dev.simplix.cirrus.spigot.CirrusSpigot;
import org.bukkit.plugin.java.JavaPlugin;

public class ExamplePlugin extends JavaPlugin {
  
  public void onEnable() {
    CirrusSpigot.init(this);
  }
}

A full Spigot-Cirrus setup can be found here.

BungeeCord

<dependency>  
  <groupId>dev.simplix.cirrus</groupId>
  <artifactId>cirrus-bungeecord</artifactId>
  <version>VERSION</version>
</dependency>

import dev.simplix.cirrus.bungeecord.CirrusBungeeCord;
import net.md_5.bungee.api.plugin.Plugin;

public class ExamplePlugin extends Plugin {
  @Override
  public void onEnable() {
      CirrusBungeeCord.init(this);
  }
}

Full BungeeCord-Cirrus setup here.

Velocity

<dependency>  
  <groupId>dev.simplix.cirrus</groupId>
  <artifactId>cirrus-velocity</artifactId>
  <version>VERSION</version>
</dependency>