You can view the to-do list and future plans by clicking here
INSTALL FOR SPIGOT (click to expand/shrink)
(It is recommended that you use PaperSpigot instead of Spigot, but Spigot is still supported and PaperSpigot works on the 'spigot' portion of the library!)
INSTALL WITH GRADLE [RECOMMENDED] (click to expand/shrink)
Step 1) Include the below code in your build.gradle "repositories" section.
repositories {
maven { url 'https://jitpack.io' }
}
Step 2) Include the below code in your build.gradle "dependencies" and replace "LATEST BUILD" with the latest build that you see here:
Note: It is recommended that you include "common" as well in your gradle dependencies in order to include the common java documentation, though it should be noted that this isn't required.
dependencies {
implementation 'com.github.CyberedCake.CyberAPI:spigot:LATEST BUILD'
implementation 'com.github.CyberedCake.CyberAPI:common:LATEST BUILD'
}
Step 3) Reload your gradle project and follow the usage instructions below.
INSTALL WITH MAVEN (click to expand/shrink)
Step 1) Include the below code in your pom.xml "repositories" section.
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
Step 2) Include the below code in your build.gradle "dependencies" and replace "LATEST BUILD" with the latest build that you see here:
Note: It is recommended that you include "common" as well in your gradle dependencies in order to include the common java documentation, though it should be noted that this isn't required.
<dependencies>
<dependency>
<groupId>com.github.CyberedCake.CyberAPI</groupId>
<artifactId>spigot</artifactId>
<version>LATEST BUILD</version>
</dependency>
<dependency>
<groupId>com.github.CyberedCake.CyberAPI</groupId>
<artifactId>common</artifactId>
<version>LATEST BUILD</version>
</dependency>
</dependencies>
Step 3) Reload your maven project and follow the usage instructions below.
To use CyberAPI, write this in your main onEnable method:
import net.cybercake.cyberapi.spigot.CyberAPI;
import net.cybercake.cyberapi.common.builders.settings.Settings;
public class MainClass extends CyberAPI { // you must extend CyberAPI instead of JavaPlugin
@Override
public void onEnable() {
startCyberAPI( // this method will start CyberAPI and is **required** to be the first thing in your onEnable() method
Settings.builder()
// put your settings here, usually in the form of .<setting>(<value>)
.mainPackage("<your groupID>")
// it is necessary (almost required at this point) to define your main package, as it is used for CyberAPI's
// custom command and listener system
.build() // build once you have changed the settings you want
);
// now you have access to everything CyberAPI!
// view the docs here: https://docs.spigot.cybercake.net/
}
}
INSTALL FOR BUNGEECORD (click to expand/shrink)
(It is recommended that you use Waterfall instead of Bungeecord, but Bungeecord is still supported and Waterfall works on the 'bungee' portion of the library!)
INSTALL WITH GRADLE [RECOMMENDED] (click to expand/shrink)
Step 1) Include the below code in your build.gradle "repositories" section.
repositories {
maven { url 'https://jitpack.io' }
}
Step 2) Include the below code in your build.gradle "dependencies" and replace "LATEST BUILD" with the latest build that you see here:
Note: It is recommended that you include "common" as well in your gradle dependencies in order to include the common java documentation, though it should be noted that this isn't required.
dependencies {
implementation 'com.github.CyberedCake.CyberAPI:bungee:LATEST BUILD'
implementation 'com.github.CyberedCake.CyberAPI:common:LATEST BUILD'
}
Step 3) Reload your gradle project and follow the usage instructions below.
INSTALL WITH MAVEN (click to expand/shrink)
Step 1) Include the below code in your pom.xml "repositories" section.
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
Step 2) Include the below code in your build.gradle "dependencies" and replace "LATEST BUILD" with the latest build that you see here:
Note: It is recommended that you include "common" as well in your gradle dependencies in order to include the common java documentation, though it should be noted that this isn't required.
<dependencies>
<dependency>
<groupId>com.github.CyberedCake.CyberAPI</groupId>
<artifactId>bungee</artifactId>
<version>LATEST BUILD</version>
</dependency>
<dependency>
<groupId>com.github.CyberedCake.CyberAPI</groupId>
<artifactId>common</artifactId>
<version>LATEST BUILD</version>
</dependency>
</dependencies>
Step 3) Reload your maven project and follow the usage instructions below.
To use CyberAPI, write this in your main onEnable method:
import net.cybercake.cyberapi.bungee.CyberAPI;
import net.cybercake.cyberapi.common.builders.settings.Settings;
public class MainClass extends CyberAPI { // you must extend CyberAPI instead of Plugin
@Override
public void onEnable() {
startCyberAPI( // this method will start CyberAPI and is **required** to be the first thing in your onEnable() method
Settings.builder()
// put your settings here, usually in the form of .<setting>(<value>)
.mainPackage("<your groupID>")
// it is necessary (almost required at this point) to define your main package, as it is used for CyberAPI's
// custom command and listener system
.build() // build once you have changed the settings you want
);
// now you have access to everything CyberAPI!
// view the docs here: https://docs.bungee.cybercake.net/
}
}