> ## Documentation Index
> Fetch the complete documentation index at: https://hotpotato.arrowtan.cc/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Requirements, step-by-step setup, and building your first arena.

This page gets HotPotato running and walks you through your first playable arena.

## Requirements

| Requirement    | Notes                                                              |
| -------------- | ------------------------------------------------------------------ |
| Server         | Spigot or Paper, Minecraft 1.18 or newer                           |
| Java           | 17 or newer                                                        |
| PlaceholderAPI | Optional. Only needed for [placeholders](/reference/placeholders). |

<Info>
  HotPotato downloads its own libraries (boosted-yaml, database drivers) on first start, so the server needs internet access the first time it enables.
</Info>

## Install

<Steps>
  <Step>
    ### Get the plugin

    Download the latest HotPotato jar from [BuiltByBit](https://builtbybit.com/resources/hotpotato-round-based-minigame.113401/), [SpigotMC](https://www.spigotmc.org/resources/hotpotato-round-based-minigame.136340/), or [Pixeleast](https://pixeleast.com/product/436700-hotpotato-roundbased-minigame).
  </Step>

  <Step>
    ### Stop the server

    Shut the server down fully before adding the jar.
  </Step>

  <Step>
    ### Drop in the jar

    Move the HotPotato jar into your `plugins/` folder.
  </Step>

  <Step>
    ### Start the server

    Start it back up. HotPotato creates its config files and folders on first run.
  </Step>

  <Step>
    ### Check it loaded

    Run `/hotpotato help`. If you see the help page, you are good to go.
  </Step>
</Steps>

## Plugin folder layout

<Tree>
  <Tree.Folder name="plugins" defaultOpen>
    <Tree.Folder name="HotPotato" defaultOpen>
      <Tree.File name="config.yml" />

      <Tree.File name="powerups.yml" />

      <Tree.Folder name="lang" defaultOpen>
        <Tree.File name="en.yml" />

        <Tree.File name="fr.yml" />
      </Tree.Folder>

      <Tree.Folder name="arenas" />

      <Tree.File name="stats.yml" />
    </Tree.Folder>
  </Tree.Folder>
</Tree>

## Build your first arena

All setup commands need the `hotpotato.admin` permission. Stand where you want each point to be, then run the command.

<Steps>
  <Step>
    ### Create the arena

    ```
    /hotpotato arena create myarena
    ```
  </Step>

  <Step>
    ### Set the spawns

    Stand in the lobby and run `setlobby`. Add at least one play spawn with `addspawn`. Set where spectators go and where players return after a game.

    ```
    /hotpotato arena setlobby myarena
    /hotpotato arena addspawn myarena
    /hotpotato arena setspectator myarena
    /hotpotato arena setreturn myarena
    ```
  </Step>

  <Step>
    ### Tune the numbers

    Set the minimum and maximum players, how many potatoes, and the round length in seconds.

    ```
    /hotpotato arena setmin myarena 4
    /hotpotato arena setmax myarena 12
    /hotpotato arena setpotatoes myarena 1
    /hotpotato arena setroundtime myarena 30
    ```
  </Step>

  <Step>
    ### Save and check

    ```
    /hotpotato arena save myarena
    ```

    If anything is missing, the save message lists what to fix. See [commands](/reference/commands) for the full list.
  </Step>
</Steps>

<Tip>
  Want to stop spectators flying off across the map? Add a [bounds box](/features/arena-bounds) with `setcorner1` and `setcorner2`.
</Tip>

## Optional integrations

* **PlaceholderAPI**: install it to use `%hotpotato_*%` [placeholders](/reference/placeholders) on scoreboards and in other plugins.
* **A database**: stats are stored in YAML by default. Switch to SQLite or MySQL on the [storage](/configuration/storage) page.