Skip to main content

​
Install Reverse

Download Reverse from the marketplace where you purchased it. For your first test, install recorder and player on one server — that is all you need to record and watch replays.

​
Before you begin

Make sure you have:
  • A server running Java 21.
  • A Minecraft version and server software supported by the release you downloaded (check the marketplace listing).
  • Access to the server’s plugins folder and console.
  • An internet connection: Reverse needs it for activation and to download its own dependencies on first start.

​
Install in three steps

1

​
Choose your plugins

Not sure what to install? This table covers the common cases:Install the lobby on a Minecraft server behind your proxy, not in the proxy’s plugins folder.
2

​
Install your download

  1. Stop the server.
  2. Open the download and follow any included instructions. If it is an archive, extract it first.
  3. Copy the .jar for each role you need into the server’s plugins/ folder.
  4. If you are updating, replace the previous jar for that role rather than keeping both versions installed.
Keep the filenames supplied with your download. You do not need to compile anything or download the API to run Reverse.
3

​
Start once, configure, and restart

Start the server and let Reverse create its configuration files. Check the console for startup errors, stop the server, make your configuration changes, and restart.For a local first test, keep the default storage and leave networking disabled. Follow Your first replay before setting up a multi-server network.

​
Dependencies

Reverse downloads the libraries it needs automatically. Your server needs an internet connection and permission to write to its plugin folders. If you use SlimeWorldManager or ASP templates, install and configure that world manager separately. Follow the terrain guide for that optional setup. If a download fails, check internet access and the first related console error, then restart after fixing the cause.

​
Where are the settings?

Each plugin creates its own folder under plugins/: Local recordings default to plugins/recordings, shared by recorder and player on the same server. storage.recordings-folder: '' selects that default. A relative configured path resolves against the parent of the role’s data folder (normally plugins/); an absolute path is used as-is. Set matching paths on both roles if you change it, and restart. No recordings are moved automatically. Keep the complete selected folder when moving or backing up the server; see storage and backups.
Start with the generated files. Examples in this wiki show settings to merge into your configuration, not a reason to delete the rest of it.

​
Activation

Each installed role reads license.yml from its own data folder, using the license-key field: for example, plugins/reverse-recorder/license.yml and plugins/reverse-player/license.yml. Enter the key supplied with your purchase in each role’s file and restart; the role’s reload command does not reactivate it. Follow any additional activation instructions included with your download. Activation is checked at every startup, while the role starts, and it requires the server to reach the license service. There is no offline mode or grace period: a server that cannot reach the service stays disabled. It reports a single line in the console:
  • License validated means the key was accepted and the role started.
  • License validation failed: <reason> means the role stayed disabled. The reason is one of NOT_FOUND (unknown key), NOT_ACTIVE (not enabled yet), EXPIRED, LICENSE_SCOPE_FAILED, IP_LIMIT_EXCEEDED, RATE_LIMIT_EXCEEDED, FAILED_CHALLENGE, SERVER_ERROR, CONNECTION_ERROR (the server could not reach the license service), CONTENT_KEY_UNAVAILABLE (the service answered but the recording key could not be obtained) or CONFIGURATION_ERROR (the license.yml could not be read).
No stack trace is printed for a failed activation. If activation fails, check that the server can reach the internet and contact support with that line and your release version. Keep license details private when sharing logs. Recordings are encrypted with a key the service supplies during activation. Every server that records or plays them must therefore be able to activate; a role that cannot obtain the key stays disabled instead of writing files it could never replay. The key is never written to disk, and renaming a recording does not require it.

​
Check that it works

Run through this quick checklist before moving on:
  • The plugins start without errors.
  • Your test account has the permissions it needs.
  • You can save a short recording and watch it back.
  • A second account sees only the recordings it is allowed to access.
All good? Continue to Your first replay →