ArenaAPI

ArenaAPI is a Bukkit framework designed to make creating arenas in other plugins easy. Java documentation for this API can be found on psgs' site.

There are two ways you can incorporate this API in your own code.

Adding ArenaAPI as a dependency

The easiest way to incorporate ArenaAPI's functions in your plugin is to add ArenaAPI as a dependency. This can easily be done using Apache Maven. If you use Apache Maven, simply add the following dependency to your pom.xml file...

<dependency>
    <groupId>io.github.psgs</groupId>
    <artifactId>ArenaAPI</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

If you choose to use this method, any servers your plugin will run on will be required to also run ArenaAPI as a standalone plugin. It is also recommended that you add the following line to your plugin.yml file:

depend: [ArenaAPI]

Incorporating the ArenaAPI package

The other way to use ArenaAPI in your plugin is to incorporate the ArenaAPI package as part of your code.

To do this, simply copy the io.github.psgs.arenaapi package into the source folder of your own code. In most cases, this will be the src folder.

Then open up the package and delete the ArenaAPI.java file. Finally, open the ArenaManager.java file.

On line 15, you should see the following statement: private static ArenaAPI plugin;

Now change 'ArenaAPI' to the name of your plugin's main class.

Please remember to also copy across the license packaged in this repository.

Using ArenaAPI

Creating an Arena

// Import the Arena and ArenaManager classes
import io.github.psgs.arenaapi.Arena;
import io.github.psgs.arenaapi.ArenaManager;

/**
 * Create an new Arena object
 * @param id The Arena's ID number, used to reference the Arena
 * @param spawn The Arena's spawn location
 * @param l1 The top left location of the Arena block
 * @param l2 The bottom right location of the Arena block
*/
Arena arena = new Arena(int id, Location spawn, Location l1, Location l2);

// Save the arena to the configuration file
ArenaManager.getManager().createArena(arena);

Removing an Arena

// Import the ArenaManager class
import io.github.psgs.arenaapi.ArenaManager;

// Remove the arena from the configuration file and active memory
ArenaManager.getManager().removeArena(int id);

Getting an Arena

// Import the Arena and ArenaManager classes
import io.github.psgs.arenaapi.Arena;
import io.github.psgs.arenaapi.ArenaManager;

// Get an Arena using the arena's ID number
Arena arena = ArenaManager.getManager().getArena(int id);

Add a Player

// Import the ArenaManager class
import io.github.psgs.arenaapi.ArenaManager;

// Add a player to an Arena using the Arena's ID number
ArenaManager.getManager().addPlayer(Player player, int id);

Remove a Player

// Import the ArenaManager class
import io.github.psgs.arenaapi.ArenaManager;

// Remove a player from all active arenas
ArenaManager.getManager().removePlayer(Player player);

---

If you'd like to contribute to this plugin, feel free to open an issue or a pull request.

Thankyou xTrollxDudex from bukkit (Agent Troll on GitHub) for writing '[Tutorial] Make a minigame plugin' and some of the code provided in this plugin.