# Parkour

The main documentation page for the ArenaParkour plugin.

# Installation

### Requirements

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

### Downloading

1. Download the [ArenaParkour](https://modrinth.com/plugin/arenaparkour) plugin
2. Stop your server and place the plugins in your plugins folder
3. Start the server and ArenaParkour 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 **/parkour** command to initiate the map creation.
2. Once you have created a map, you now need to set the parkour checkpoints. Run **/parkour checkpoint add <map></map>** to start the process. 
    - A wizard will open, asking you to set the checkpoint position. Follow the instructions in chat to set the checkpoint position.
    - The first checkpoint position will become the start of the parkour, with every subsequent checkpoint becoming the "end" position.
    - After setting the checkpoints, you may need to run **/battlearena reload** to reload the checkpoints, and the parkour will start.

### Configuration

The default configuration for Parkour can be found in **plugins/ArenaParkour/arenas/parkour.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 parkour modes can be found [here](https://github.com/BattlePlugins/ArenaParkour/tree/master/templates).

# Commands

<table id="bkmrk-command-description-" style="width: 119.524%; height: 229.2px;"><thead><tr style="height: 29.8px;"><th style="width: 40.7285%; height: 29.8px;">**Command**</th><th style="width: 59.2745%; height: 29.8px;">**Description**</th></tr></thead><tbody><tr style="height: 29.8px;"><td style="width: 40.7285%; height: 29.8px;">/parkour checkpoint add &lt;map&gt;  
</td><td style="width: 59.2745%; height: 29.8px;">Adds a checkpoint to a parkour arena.</td></tr><tr style="height: 46.6px;"><td style="width: 40.7285%; height: 46.6px;">/parkour checkpoint remove &lt;map&gt; &lt;index&gt;  
</td><td style="width: 59.2745%; height: 46.6px;">Removes a checkpoint from a parkour arena.</td></tr><tr style="height: 46.6px;"><td style="width: 40.7285%; height: 46.6px;">/parkour checkpoint clear &lt;map&gt;  
</td><td style="width: 59.2745%; height: 46.6px;">Clears all the checkpoints from a parkour arena.</td></tr><tr style="height: 46.6px;"><td style="width: 40.7285%; height: 46.6px;">/parkour checkpoint index &lt;map&gt; &lt;from&gt; &lt;to&gt;  
</td><td style="width: 59.2745%; height: 46.6px;">Changes the index of a checkpoint.</td></tr><tr style="height: 29.8px;"><td style="width: 40.7285%; height: 29.8px;">/parkour checkpoint list &lt;map&gt;  
</td><td style="width: 59.2745%; height: 29.8px;">Lists all the checkpoints in a parkour arena.</td></tr><tr><td style="width: 40.7285%;">/parkour checkpoint  
</td><td style="width: 59.2745%;">Teleports you to the last checkpoint you were on in a parkour.  
</td></tr></tbody></table>

# Permissions

<table id="bkmrk-permission-command-b" style="width: 122.143%;"><thead><tr><th style="width: 62.9907%;">**Permission**</th><th style="width: 37.0093%;">**Command**</th></tr></thead><tbody><tr><td style="width: 62.9907%;">battlearena.command.parkour.checkpoint.add</td><td style="width: 37.0093%;">/parkour checkpoint add</td></tr><tr><td style="width: 62.9907%;">battlearena.command.parkour.checkpoint.remove</td><td style="width: 37.0093%;">/parkour checkpoint remove</td></tr><tr><td style="width: 62.9907%;">battlearena.command.parkour.checkpoint.clear</td><td style="width: 37.0093%;">/parkour checkpoint clear</td></tr><tr><td style="width: 62.9907%;">battlearena.command.parkour.checkpoint.index</td><td style="width: 37.0093%;">/parkour checkpoint index</td></tr><tr><td style="width: 62.9907%;">battlearena.command.parkour.checkpoint.list</td><td style="width: 37.0093%;">/parkour checkpoint list</td></tr><tr><td style="width: 62.9907%;">battlearena.command.parkour.checkpoint  
</td><td style="width: 37.0093%;">/parkour checkpoint  
</td></tr></tbody></table>