> For the complete documentation index, see [llms.txt](https://docs.marioded.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.marioded.com/readme.md).

# Welcome to Reverse

Everything you need to record gameplay, watch replays, and build with Reverse.

**Record the match. Revisit the moment.**

Reverse brings gameplay recording and interactive replays to your Minecraft servers. Capture a match, let players watch it back, and connect the experience to your existing game plugins.

## Where would you like to start?

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Set up your server</strong></td><td>Choose your plugins, install Reverse, and make your first recording.</td><td><a href="/get-started/installation.md">Installation</a></td></tr><tr><td><strong>Try your first replay</strong></td><td>Follow a short, hands-on walkthrough from recording to playback.</td><td><a href="/get-started/quick-start.md">Your first replay</a></td></tr><tr><td><strong>Build an integration</strong></td><td>Record matches automatically, add a Watch button, or extend the controls.</td><td><a href="/api-introduction/api.md">Developer hub</a></td></tr></tbody></table>

{% hint style="info" %}
**New to Reverse?** Start with recorder and player on one server. Keep networking disabled until your first local replay works. You can add a lobby and separate replay servers afterward.
{% endhint %}

## Meet the plugins

Choose the roles your setup needs. You do not have to install all three everywhere.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Recorder</strong></td><td>Install on gameplay servers to capture matches, events, and initial terrain.</td><td><a href="/use-reverse/recorder.md">Recording gameplay</a></td></tr><tr><td><strong>Player</strong></td><td>Give viewers playback controls, seeking, speed selection, and a replay catalog.</td><td><a href="/use-reverse/player.md">Watching replays</a></td></tr><tr><td><strong>Lobby</strong></td><td>Let players choose a recording and travel to a replay server through your proxy.</td><td><a href="/use-reverse/network.md">Lobby and proxy setup</a></td></tr></tbody></table>

## Find what you need

| I want to…                                  | Open this guide                                                                                            |
| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| Decide which plugins to install             | [Choose your setup](/get-started/overview.md)                                                              |
| Look up a command or permission             | [Commands and permissions](/use-reverse/commands.md)                                                       |
| Change menus, controls, or messages         | [Catalog menus](/configure-and-customize/menus.md) · [Viewer display](/configure-and-customize/display.md) |
| Use a database or back up recordings        | [Storage and backups](/configure-and-customize/storage.md)                                                 |
| Connect several servers                     | [Lobby and proxy setup](/use-reverse/network.md)                                                           |
| Fix a missing recording or incomplete scene | [Troubleshooting](/keep-things-running/troubleshooting.md)                                                 |
| Get a quick answer before setting things up | [Common questions](/keep-things-running/faq.md)                                                            |
| Copy a complete integration example         | [Example gallery](/api-how-to-guides/examples.md)                                                          |

## A few things to know

* **Java 21 is required.** Check [installation requirements](/get-started/installation.md) for server compatibility.
* **A replay is more than a file.** Events and base terrain are stored separately; keep both when moving or backing up recordings.
* **Ownership controls access.** A player owning a replay and a player having command permissions are two separate things.

{% content-ref url="/pages/ROn24Oa4AtqDQw9hp6mF" %}
[Choose your setup](/get-started/overview.md)
{% endcontent-ref %}

<details>

<summary>How to read examples in this documentation</summary>

Replace command placeholders such as `<replay-id>` with real values. YAML examples are sections to merge into your generated configuration unless the guide explicitly says otherwise. Configuration names use lower-kebab-case, such as `chunk-capture-radius`.

Complete Java integration examples have their own pages. Server owners can use the marketplace download; developers add the public API through their build tool. Use compatible plugin, API, and extension releases.

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.marioded.com/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.