# Spleef

The main documentation page for the ArenaSpleef plugin.

# Installation

### Requirements

- A Paper server (or other derivative) running 1.19.4 or above
- [BattleArena](https://modrinth.com/plugin/battlearena) 4.0.0 or higher

### Downloading

1. Download the [ArenaCTF](https://modrinth.com/plugin/arenaspleef) plugin
2. Stop your server and place the plugins in your plugins folder
3. Start the server and ArenaSpleef will load

# Creating an Arena

### Map Creation

1. The first step follows the same steps as outlined in the BattleArena [Map Creation](https://docs.battleplugins.org/books/user-guide/page/map-creation) documentation. For ArenaSpleef, you will use the **/spleef** command to initiate the map creation.
2. Once you have created a map, you now need to set the spleef layers. Run **/spleef layer add <map>** to start the process. 
    - A wizard will open, asking you to set the layer bounds. Follow the instructions in chat to set the layer bounds.
    - After you have set the layer bounds, you will be asked to set the block type the layer comprises of. Type the block name in chat.
    - After setting the layer bounds and block type, layers will now be placed upon joining the game. Repeat this for each remaining team.
3. If you wish to set a death region, rather than having a player die automatically due to lava or void, you can run **/spleef deathregion <map>** to set a death region. This will ask you to set the bounds of the death region upon execution.

### Configuration

The default configuration for Spleef can be found in **plugins/ArenaSpleef/arenas/spleef.yml**. This can be modified in any way. See the [**Arena Configuration**](https://docs.bplug.in/books/user-guide/page/arena-configuration) page for more details.

Additionally, configs for other spleef modes can be found [here](https://github.com/BattlePlugins/ArenaSpleef/tree/master/templates).

##### [Actions](https://docs.bplug.in/books/user-guide/page/action-reference)


- **give-shovel:** Gives the player a spleef shovel which is configured in the ArenaSpleef config.yml. 
    - Syntax: give-shovel{shovel=<shovel>}
- **paste-layers:** Pastes the spleef layers into the map.

# Commands

<table border="1" id="bkmrk-command-description-" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50.0596%;"></col><col style="width: 50.0596%;"></col></colgroup><tbody><tr><th class="align-left">**Command**</th><th class="align-left">**Description**</th></tr><tr><td>/spleef deathregion</td><td>Sets the death region for a spleef arena.</td></tr><tr><td>/spleef layer add</td><td>Adds a layer to a spleef arena.</td></tr><tr><td>/spleef layer remove</td><td>Removes a layer from a spleef arena.</td></tr><tr><td>/spleef layer clear</td><td>Clears all layers from a spleef arena.</td></tr><tr><td>/spleef layer index</td><td>Changes the index of a layer.</td></tr><tr><td>/spleef layer list</td><td>Lists all layers in a spleef arena.</td></tr></tbody></table>

# Permissions

<table border="1" id="bkmrk-permission-command-b" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50.0596%;"></col><col style="width: 50.0596%;"></col></colgroup><tbody><tr><td>**Permission**</td><td>**Command**  
</td></tr><tr><td>battlearena.command.spleef.deathregion</td><td>/spleef deathregion</td></tr><tr><td>battlearena.command.spleef.layer.add</td><td>/spleef layer add</td></tr><tr><td>battlearena.command.spleef.layer.remove</td><td>/spleef layer remove</td></tr><tr><td>battlearena.command.spleef.layer.clear</td><td>/spleef layer clear</td></tr><tr><td>battlearena.command.spleef.layer.index</td><td>/spleef layer index</td></tr><tr><td>battlearena.command.spleef.layer.list</td><td>/spleef layer list</td></tr></tbody></table>