> 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/reference/build-and-docs.md).

# Updates and compatibility

Update Reverse and its integrations while keeping your recordings and settings safe.

Use the marketplace download to update your servers and Maven Central to update a custom integration's API dependency. You do not need to compile Reverse.

## Update the plugin

1. Read the release notes and check supported server versions before downloading.
2. Stop new recordings and wait for current saves to finish.
3. Stop playback and shut down the affected servers.
4. Back up configuration and the complete recording storage, including terrain.
5. Replace the old jar for each installed role with the new download. Do not leave two versions of the same role in `plugins/`.
6. Start the servers, check the console, and make a short recording/playback test.

Keep recorder, player, and lobby on the same release across the network.

## Keep your configuration

Start with the files generated by your installed version. When a release introduces new settings, follow its release notes and merge your customizations rather than replacing the whole configuration with a short wiki example.

Message and display changes can usually be reloaded. Storage, connection, and networking changes require a restart; use the [configuration guide](/configure-and-customize/configuration.md) to check each setting.

## Keep recordings usable

A recording includes events and a reference to its starting terrain. Back up both. Template recordings also need the same template to remain available on the player server.

A newer release or extension can change what recording data it understands. Follow the release's compatibility notes before upgrading or downgrading, and keep a recoverable backup. Do not edit recording files manually to force a load.

## Update integrations

Developers should update the public API dependency to a version compatible with the installed Reverse release, then rebuild and test their own integration.

Check that custom event codecs and renderers are installed on the servers that need them. Changing a custom event's ID or payload requires coordinated updates on recording and playback servers.

{% content-ref url="/pages/m9tQJ0VAsw3jZ4HXAX22" %}
[Setting up](/api-introduction/getting-started.md)
{% endcontent-ref %}

## Before reopening the feature to players

* [ ] Recorder, player, and lobby start without errors.
* [ ] A new recording saves and can be watched.
* [ ] The terrain/template is visible.
* [ ] Owners and nonowners have the expected access.
* [ ] Lobby transfers and return transfers work, if used.
* [ ] Custom integrations still start and handle match end/save failures correctly.

{% content-ref url="/pages/HtRRMyBwU1nL9BCaUGbH" %}
[Storage and backups](/configure-and-customize/storage.md)
{% endcontent-ref %}


---

# 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/reference/build-and-docs.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.