> ## 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.

# Introduction

> What HotPotato is, how a match plays out, and where to go next.

HotPotato is a round-based, <Tooltip tip="The last surviving player wins; everyone else is eliminated along the way.">last-man-standing</Tooltip> minigame for Spigot and Paper servers. One or more players are handed a "hot potato". When the round timer runs out, whoever is still holding a potato is eliminated. Pass it on by hitting another player before time runs out. The last player standing wins.

<Note>
  New here? Start with [Installation](/installation), then set up your first arena with the [commands](/reference/commands).
</Note>

## Quick facts

|                 |                                                                                                                                                                                                                                                                                    |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Platform        | Spigot or Paper, Minecraft 1.18 and newer                                                                                                                                                                                                                                          |
| Java            | 17 or newer                                                                                                                                                                                                                                                                        |
| Where to get it | Premium plugin on [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) |
| Soft dependency | PlaceholderAPI (optional)                                                                                                                                                                                                                                                          |
| Storage         | YAML, SQLite, or MySQL                                                                                                                                                                                                                                                             |
| Languages       | English and French out of the box                                                                                                                                                                                                                                                  |

## How a match works

<Steps>
  <Step>
    ### Players join the lobby

    Players run `/hotpotato join <arena>` and wait in the arena lobby. When enough have joined, a countdown starts.
  </Step>

  <Step>
    ### A round begins

    Some players are made the potato. Everyone else is a runner. A round timer counts down.
  </Step>

  <Step>
    ### Pass the potato

    A potato holder hits a runner to pass it on. The runner becomes the potato; the holder becomes a runner.
  </Step>

  <Step>
    ### The timer ends

    Anyone still holding a potato is eliminated and becomes a spectator. If more than one player is left, a new round starts.
  </Step>

  <Step>
    ### Someone wins

    When one player remains, they win. Rewards run, stats are saved, and everyone is sent home.
  </Step>
</Steps>

## What you can configure

<Columns cols={2}>
  <Card title="Look and feel" icon="palette">
    The potato item, the holder's glow helmet, and the lobby leave item.
  </Card>

  <Card title="Timings" icon="clock">
    Round length, lobby size, countdown and transition timings, per arena.
  </Card>

  <Card title="Powerups" icon="bolt" href="/features/powerups">
    Floating pickups players grab during a round for an edge.
  </Card>

  <Card title="Rewards" icon="gift" href="/configuration/configuration">
    Commands that run when a game ends, for winners or losers.
  </Card>

  <Card title="Messages" icon="language" href="/configuration/messages-and-language">
    Every player-facing string, in your own language file.
  </Card>

  <Card title="Storage" icon="database" href="/configuration/storage">
    Keep stats in YAML, SQLite, or a shared MySQL database.
  </Card>
</Columns>

## Where to go next

<CardGroup cols={2}>
  <Card title="Installation" href="/installation" icon="download">
    Requirements, setup, and your first arena.
  </Card>

  <Card title="Game flow" href="/features/game-flow" icon="play">
    Rounds, the potato, and spectators in detail.
  </Card>

  <Card title="Commands" href="/reference/commands" icon="terminal">
    Every player and admin command.
  </Card>

  <Card title="Configuration" href="/configuration/configuration" icon="gear">
    A tour of the main config file.
  </Card>
</CardGroup>