Installation

Get Donut Replay running on Paper, Folia or Canvas in a couple of minutes.

Requirements

RequirementNotes
ServerPaper, Folia or Canvas 1.21 – 26.2 (latest)
Java21+
PacketEventsRequired dependency — install it first

Optional soft-dependencies

These are detected automatically if present — none are required:

  • GrimAC or Vulcan — combat anticheat for flag-triggered recording
  • TotemGuard — totem / bad-packet anticheat
  • Floodgate — correct skins for Bedrock players in replays

Install

  1. Stop your server.
  2. Place PacketEvents and DonutReplay into the plugins/ folder.
  3. Start the server once. Donut Replay generates config.yml and messages.yml in plugins/DonutReplay/.
  4. (Optional) Edit the config, then run /replay reload.
plugins/
├── packetevents.jar        # required
├── DonutReplay.jar
└── DonutReplay/
    ├── config.yml
    └── messages.yml

Choose your storage

By default replays are stored as compressed JSON files — perfect for a single server. For a network, point every server at one MySQL database instead.

# plugins/DonutReplay/config.yml
General:
  Storage-Type: file        # "file" (single server) or "mysql" (network)
  MySQL:
    host: 127.0.0.1
    port: 3306
    database: betterreplay
    user: replay_user
    password: change-me

First run

Once it’s up, test it from the console or as an operator:

/replay recordall      → start recording everyone
/replay recordall      → stop & save
/replay list           → see the saved replay
/replay play <name>    → watch it

Then grab the right permissions for your staff and you’re done.