CyberedCake/CyberAPI-testing

CyberAPI for testing purposes only

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.CyberedCake:CyberAPI-testing:6'
	}
	dependencies {
		implementation("com.github.CyberedCake:CyberAPI-testing:6")
	}
	<dependency>
	    <groupId>com.github.CyberedCake</groupId>
	    <artifactId>CyberAPI-testing</artifactId>
	    <version>6</version>
	</dependency>

                            
    libraryDependencies += "com.github.CyberedCake" % "CyberAPI-testing" % "6"
        
        

                            
    :dependencies [[com.github.CyberedCake/CyberAPI-testing "6"]]

Readme

<h1><p align="center">CyberAPI</p></h1> <h2><p align="center">DEVELOPER EDITION</p></h2> <p align="center"> <a href="https://jitpack.io/p/CyberedCake/CyberAPI-testing"><img src="https://jitpack.io/v/CyberedCake/CyberAPI-testing.svg?label=Latest+Build" alt="JitPack Build Status"></a> <a href="https://github.com/CyberedCake/CyberAPI-testing/releases/latest"><img src="https://github.com/CyberedCake/CyberAPI-testing/actions/workflows/actions.yml/badge.svg" alt="GitHub Actions Build Status"></a> </p> The new and improved CyberAPI, version 3, is here! This is a library used for most of <a href="https://github.com/CyberedCake?tab=repositories">CyberedCake's</a> plugins and can be used by you for free! It adds additional features that Spigot and Bungeecord do not have and makes existing stuff easier. <br> <br> You can view the to-do list and future plans <a href="https://github.com/CyberedCake/CyberAPI/projects/1">by clicking here</a> (redirects to main CyberAPI page) <h1><p align="center">How to install and use</p></h1> <details> <summary><b>INSTALL FOR SPIGOT</b> (click to expand/shrink)</summary>

Installation - Spigot

(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!)

<details> <summary><b>INSTALL WITH GRADLE [RECOMMENDED]</b> (click to expand/shrink)</summary>

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: <br> 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-testing:spigot:LATEST BUILD'
		implementation 'com.github.CyberedCake.CyberAPI-testing:common:LATEST BUILD'
	}

Step 3) Reload your gradle project and follow the usage instructions below.

</details> <details> <summary><b>INSTALL WITH MAVEN</b> (click to expand/shrink)</summary>

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: <br> 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-testing</groupId>
            <artifactId>spigot</artifactId>
            <version>LATEST BUILD</version>
	 </dependency>
	 <dependency>
            <groupId>com.github.CyberedCake.CyberAPI-testing</groupId>
            <artifactId>common</artifactId>
            <version>LATEST BUILD</version>
	 </dependency>
    </dependencies>

Step 3) Reload your maven project and follow the usage instructions below.

</details>

How to use - Spigot

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/
    }

}
</details> <details> <summary><b>INSTALL FOR BUNGEECORD</b> (click to expand/shrink)</summary>

Installation - Bungeecord

(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!)

<details> <summary><b>INSTALL WITH GRADLE [RECOMMENDED]</b> (click to expand/shrink)</summary>

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: <br> 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-testing:bungee:LATEST BUILD'
		implementation 'com.github.CyberedCake.CyberAPI-testing:common:LATEST BUILD'
	}

Step 3) Reload your gradle project and follow the usage instructions below.

</details> <details> <summary><b>INSTALL WITH MAVEN</b> (click to expand/shrink)</summary>

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: <br> 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-testing</groupId>
            <artifactId>bungee</artifactId>
            <version>LATEST BUILD</version>
	 </dependency>
    	<dependency>
            <groupId>com.github.CyberedCake.CyberAPI-testing</groupId>
            <artifactId>common</artifactId>
            <version>LATEST BUILD</version>
	 </dependency>
    </dependencies>

Step 3) Reload your maven project and follow the usage instructions below.

</details>

How to use - Bungeecord

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/
    }

}
</details>