Skip to content

Ben-D-Anderson/InstantReplay

Repository files navigation

InstantReplay


What is it?

InstantReplay is a Minecraft plugin for Spigot versions 1.8 to 1.17 (inclusive) which allows Minecraft server administrators to review events by re-watching them.

Why use it?

This plugin is ideal for Minecraft servers running game-modes such as Factions and HCF, as players often break rules which would need recorded proof of the player violating the rule in order to punish them. Gone are the days of recording your screen to catch rule-breakers, server admins can now re-watch the rule violation occurring in-game.


Example Commands

Starting a replay with a 5 block radius, from 10 seconds ago:

/replay start 5 10s

Starting a replay with a 6 block radius, from 15 minutes ago, with a 3x speed:

/replay start 6 15m 3

Pausing a replay:

/replay pause

Resuming a replay:

/replay resume

Changing speed of a replay to 2x:

/replay speed 2

Skipping 30 seconds in a replay:

/replay skip 30s

Stopping a replay:

/replay stop

Getting the current timestamp:

/replay timestamp

Installation

  1. Ensure you have MySQL database for the plugin to use - the same database should not be used across multiple servers with InstantReplay.

  2. Download the latest version of ProtocolLib and move it into the plugins folder of your Minecraft server.

  3. Download the latest version of InstantReplay from the releases tab and move it into the plugins folder of your Minecraft server.

  4. Start your Minecraft server, and you should see a configuration file generated at plugins/InstantReplay/config.yml.

  5. Edit the mysql section of the configuration file to contain the details of your MySQL database - this is required for InstantReplay to function.

    For Example:

    mysql:
      username: "admin"
      password: "adminpassword"
      host: "127.0.0.1"
      database: "instantreplay"
      port: 3306
  6. Save the changes to the configuration file and restart the Minecraft server. The plugin should now be installed and functional.


The Wiki

Please read the wiki for detailed guides on usage, configuration and development.