Replay mod documentation

5.4 Compatibility with other Mods

5.4.2 Shaders Mod

Karyonix’ Shaders Mod is no longer compatible with Minecraft Forge starting with 1.9.4. As such it is not compatible with the Replay Mod either.
Please use Optifine instead.

5.4.3 Custom Main Menu

The Custom Main Menu mod is often used in mod packs to customize their Main Menu with a button layout fitting the background image, links to their website / bug tracker and similar.
If you are familiar with it, the button id for the Replay Mod is: 17890234 (text: ).

Due to the nature of this Custom Main Menu mod, buttons added to the Main Menu by 3rd party mods like the Replay Mod will not show up by default.Thus, to access the Replay Viewer/Editor/Center, you need to manually configure the position for those buttons.To do so, you need to modify the Custom Main Menu configuration file.
Usually, you can find it at (if you’re using a mod pack launcher, it normally has its own .minecraft folder).For an explanation of this config file, have a look at Custom Main Menu’s page.

You can find a list of already modified config files here.

5.4.5 LabyMod

LabyMod v3.7.x has been reported to be compatible with ReplayMod and other Forge mods.
Lower versions are not compatible.

5.4.6 OldAnimationsMod

In case your Minecraft crashes when you are using both ReplayMod and OldAnimationsMod, try removing OldAnimationsMod.

5.4.7 Orange’s 1.7 Animations

If you use ReplayMod with shaders and 1.7 Animations you may see floating water and glass. Remove 1.7 Animations to resolve this.

5.4.9 Baritone

The Baritone mod can cause a crash when you’re trying to load a replay. If you experience such problems, try running without Baritone.

5.4.10 RandomPatches

Minecraft may crash if you try to use RandomPatches together with ReplayMod. Try removing RandomPatches if Minecraft crashes on startup.

5.4.11 Sodium

ReplayMod can record when Sodium is installed but will crash during render. Disable Sodium before rendering, it can be re-enabled after that.

5.4.13 LiteLoader

LiteLoader is known to cause issues due to the mixin version it contains.

You can use MultiMC to workaround this problem.

The MultiMC function requires that your computer has a default editor for json files associated.

1: Create your instance then edit the instance2: Click 3: Click 4: Click ; use as name and as uid5: Select the new ReplayMod and click 6: Replace the contents with one of the below snippets7: Save and close the text editor8: Move ReplayMod up until it is above LiteLoader9: Remove the ReplayMod jar from the mods folder if you installed it previously.

Snippet for 1.8.9

Snippet for 1.12.2

The MultiMC interface to place ReplayMod above LiteLoader.

The properties for the new Empty.

5.2 Crash while rendering

If Minecraft crashes after a few frames of rendering, it most likely means the FFmpeg didn’t like the Command Line Arguments you passed.
If you customized the Command Line Arguments manually, re-check them — it’s probably your own fault.

Hint: In your .minecraft folder, you’ll find a file called which contains information about FFmpeg’s rendering process.

• If you did not customize the Command Line Arguments, you might have entered some insanely high (or low) values e.g. for Bitrate or Video Resolution. Try again with other, more reasonable values.
• Make sure the camera doesn’t move below Y=0 or above Y=255

Права плагина X Replay:

replay.*— Все праваreplay.admin — Право админаreplay.settings.* — Просмотр и редактирование настроек реплеяreplay.settings.edit — редактировать настройки реплея.replay.settings.see — Посмотреть настройки реплея.replay.reload — Перезагрузить плагинreplay.list — Получить список всех игроковreplay.dump — Создать дамп реплеяreplay.debug — Включить режим отладкиreplay.exist — Получить информацию о реплееreplay.lang — Чтобы использовать команду /replay createLangreplay.check — Чтобы использовать проверку команд /replay check.replay.snapshot — Чтобы использовать команду /replay snapshotreplay.history.other — просмотр истории повторов другого игрокаreplay.fix.other — Исправить другого игрока с помощью  /fix (Player)replay.replay.messages.edit — редактировать префиксreplay.invite — Пригласить игрока командой / пригласить на совместный просмотр повтораПрава для игрока: replay.userreplay.load — возможность загрузить повторreplay.history.open — просмотр истории повторов всех игроковreplay.fix.use— используйте команду /fixreplay.getID — используйте команду /getIDreplay.accept — принять запрос с помощью /acceptreplay.rleave — для выхода из группы воспроизведения с помощью /rleaveРазрешение для Bungeecord:Replay.command

3.7 Player Overview

Using the key, you can open the Player Overview. In the Player Overview, you see a list of all currently loaded Players in the Replay.

By clicking on a player’s Name or Head, you can spectate this player.

Next to each player, there’s a checkbox using which you can toggle the player’s visibility.
This way, you can hide certain players from the Replay.Below the individual checkboxes, there are two checkbox buttons — one to hide all players and one to show all players.

If you want to save the player visibility settings, check «Remember Hidden Players» checkbox.
If checked, invisible players will stay invisible after closing the Replay (this can of course be reverted),
otherwise all of the players are visible again after reloading the Replay.

The Player Overview Screen

1.1 Installing the Replay Mod

Minecraft 1.14 and above

The ReplayMod for Minecraft 1.14 and above requires Fabric to be installed.

You can find Fabric and the installation instructions here.

After installing Fabric, simply put the downloaded ReplayMod .jar file into the folder of your Minecraft directory.

Minecraft 1.12.2 and below

For Minecraft 1.12.2 and below it requires Minecraft Forge to be installed.

If you don’t know how to install Forge, follow this tutorial.

After installing Forge, simply put the downloaded file in the folder of your Minecraft directory.

Note: The Replay Mod is entirely client side and can not be installed on the servers you play on.

Frequently Asked Questions

For how long can I record?

Theoretically, a Replay File can be up to 24 days, 20 hours, 30 minutes and 23 seconds long — which is a timespan you’ll probably never reach.

How many chunks around me does the Mod record?

If you’re playing in Singleplayer, all of the loaded chunks within your Render Distance are recorded.If you’re on a server, this depends on the view-distance setting in the server.properties file, which is set to 11 Chunks by default.

The Replay Mod of course records every loaded, not only the rendered chunks. Therefore, chunks behind your back are recorded as well.

Why can’t I start recording in the middle of a session?

Due to the way the Replay Mod works, you need to start recording when joining a Server or World — otherwise some data which the Replay Files need is missing.

How does recording affect my FPS?

Usually, recording a Replay does not affect your framerate, and it also doesn’t lead to lag on servers.We’ve tested the Mod on a low-end notebook with only 3GB of ram, and everything worked fine.

3.7 Player Overview

Using the key, you can open the Player Overview. In the Player Overview, you see a list of all currently loaded Players in the Replay.

By clicking on a player’s Name or Head, you can spectate this player.

Next to each player, there’s a checkbox using which you can toggle the player’s visibility.
This way, you can hide certain players from the Replay.Below the individual checkboxes, there are two checkbox buttons — one to hide all players and one to show all players.

If you want to save the player visibility settings, check «Remember Hidden Players» checkbox.
If checked, invisible players will stay invisible after closing the Replay (this can of course be reverted),
otherwise all of the players are visible again after reloading the Replay.

The Player Overview Screen

1.3 Compatibility with other Mods

1.3.1 General information

In General, the Replay Mod should be compatible with most Forge Mods. However, due to the way that recording works, many Mods that add new Blocks, Mobs or Game Mechanics are not supported.
Mods that simply modify the Client (like the PixelCam Mod or the
CommandGroups Mod) usually work.

1.3.2 Optifine

The Replay Mod is compatible with , which can be downloaded at http://optifine.net/downloads.
Other Optifine Versions for Minecraft 1.8.0 might, but don’t have to be compatible as well.

Warning: If you have Optifine installed, you can not render videos from within the Replay Mod.
This might change in future Replay Mod versions.

1.3.3 Shaders Mod

You can use the Replay Mod together with karyonix’ Shaders Mod,
but rendering videos results in possible crashes and malformed videos. Therefore, you have to uninstall the Shaders Mod before rendering.

5.2 Crash while rendering

If Minecraft crashes after a few frames of rendering, it most likely means the FFmpeg didn’t like the Command Line Arguments you passed.
If you customized the Command Line Arguments manually, re-check them — it’s probably your own fault.

Hint: In your .minecraft folder, you’ll find a file called which contains information about FFmpeg’s rendering process.

• If you did not customize the Command Line Arguments, you might have entered some insanely high (or low) values e.g. for Bitrate or Video Resolution. Try again with other, more reasonable values.
• Make sure the camera doesn’t move below Y=0 or above Y=255

3.7 Player Overview

Using the key, you can open the Player Overview. In the Player Overview, you see a list of all currently loaded Players in the Replay.

By clicking on a player’s Name or Head, you can spectate this player.

Next to each player, there’s a checkbox using which you can toggle the player’s visibility.
This way, you can hide certain players from the Replay.Below the individual checkboxes, there are two checkbox buttons — one to hide all players and one to show all players.

If you want to save the player visibility settings, check «Remember Hidden Players» checkbox.
If checked, invisible players will stay invisible after closing the Replay (this can of course be reverted),
otherwise all of the players are visible again after reloading the Replay.

The Player Overview Screen

3.1 Movement

3.1.1 Basic Controls

While in the Replay, you can freely move around using the movement keys ( by default).
You can move through block similar to Spectator Mode.

Using the Mouse Wheel, you can modify your flying speed. Scrolling up causes you to fly faster, while scrolling down slows you down.

If you prefer the camera to be controlled similar to vanilla Creative Mode, you can change that in the Replay Settings.

3.1.2 Camera Roll

While in a Replay, you can tilt the Camera.

By default, pressing will tilt the screen clockwise, and pressing will tilt the screen counterclockwise.Using , you can reset the Camera Roll.

When holding the key ( key on Mac) while tilting, you can tilt slower and more precisely.

Hint: Most of the Keybindings mentioned in this documentation can be changed in Minecraft’s Control Menu.

A Screenshot taken with a tilted camera

3.1.3 Spectating Entities

You can spectate any living entitiy (including players) while in a Replay. When looking at an entity, a crosshair will be visible.

By right-clicking, you will start spectating the entity. If you want to stop spectating the entity, use your Sneak Key ().

3.2 Controlling Time

3.2.1 Replay Speed

In the upper left corner of you screen, there is a Play/Pause button (Shortcut: ), using which you can entirely pause the time of the Replay.All Entities, Particles and Block Updates will be frozen until you resume. You can fly through a paused Replay as usual.

Next to the Play/Pause Button, there is a Speed Slider. Using the Speed Slider, you can control how fast the time in your Replay passes.The minimum Speed value is 0.1 times the normal Minecraft Tick Speed, and the maximum Speed is 8 times as fast.

The Play/Pause button, Speed Slider and Replay Timeline hightlighted

3.2.2 Jumping in Time

To the right of the Speed Slider, there is the Replay Timeline.
On the Replay Timeline, you see a yellow cursor indicating your current position in the Replay.By clicking somewhere on this Timeline, you will travel in time towards the specified point in time.Please note that it takes longer to do larger steps in time or to jump backwards in time (see also ).

5.4 Compatibility with other Mods

5.4.2 Shaders Mod

Karyonix’ Shaders Mod is no longer compatible with Minecraft Forge starting with 1.9.4. As such it is not compatible with the Replay Mod either.
Please use Optifine instead.

5.4.3 Custom Main Menu

The Custom Main Menu mod is often used in mod packs to customize their Main Menu with a button layout fitting the background image, links to their website / bug tracker and similar.
If you are familiar with it, the button id for the Replay Mod is: 17890234 (text: ).

Due to the nature of this Custom Main Menu mod, buttons added to the Main Menu by 3rd party mods like the Replay Mod will not show up by default.Thus, to access the Replay Viewer/Editor/Center, you need to manually configure the position for those buttons.To do so, you need to modify the Custom Main Menu configuration file.
Usually, you can find it at (if you’re using a mod pack launcher, it normally has its own .minecraft folder).For an explanation of this config file, have a look at Custom Main Menu’s page.

You can find a list of already modified config files here.

5.4.6 OldAnimationsMod

In case your Minecraft crashes when you are using both ReplayMod and OldAnimationsMod, try removing OldAnimationsMod.

5.4.7 Orange’s 1.7 Animations

If you use ReplayMod with shaders and 1.7 Animations you may see floating water and glass. Remove 1.7 Animations to resolve this.

5.4.9 Baritone

The Baritone mod can cause a crash when you’re trying to load a replay. If you experience such problems, try running without Baritone.

5.4.10 RandomPatches

Minecraft may crash if you try to use RandomPatches together with ReplayMod. Try removing RandomPatches if Minecraft crashes on startup.

5.4.11 Sodium

ReplayMod can record when Sodium is installed but will crash during render. Disable Sodium before rendering, it can be re-enabled after that.

5.4.12 LiteLoader

LiteLoader is known to cause issues due to the mixin version it contains.

You can use MultiMC to workaround this problem.

The MultiMC function requires that your computer has a default editor for json files associated.

1: Create your instance then edit the instance2: Click 3: Click 4: Click ; use as name and as uid5: Select the new ReplayMod and click 6: Replace the contents with one of the below snippets7: Save and close the text editor8: Move ReplayMod up until it is above LiteLoader9: Remove the ReplayMod jar from the mods folder if you installed it previously.

Snippet for 1.8.9

Snippet for 1.12.2

The MultiMC interface to place ReplayMod above LiteLoader.

The properties for the new Empty.

3.2 Controlling Time

3.2.1 Replay Speed

In the upper left corner of you screen, there is a Play/Pause button (Shortcut: ), using which you can entirely pause the time of the Replay.All Entities, Particles and Block Updates will be frozen until you resume. You can fly through a paused Replay as usual.

Next to the Play/Pause Button, there is a Speed Slider. Using the Speed Slider, you can control how fast the time in your Replay passes.The minimum Speed value is 0.1 times the normal Minecraft Tick Speed, and the maximum Speed is 8 times as fast.

The Play/Pause button, Speed Slider and Replay Timeline hightlighted

3.2.2 Jumping in Time

To the right of the Speed Slider, there is the Replay Timeline.
On the Replay Timeline, you see a yellow cursor indicating your current position in the Replay.By clicking somewhere on this Timeline, you will travel in time towards the specified point in time.Please note that it takes longer to do larger steps in time or to jump backwards in time (see also ).

Recording

Recording Replays is the core feature of the Replay Mod.

Recording a Replay is really simple: If enabled in the Replay Settings, the Mod will automatically record all of your gaming sessions.
You will be notified that the Recording started by a Chat Message. Chat Messages can be disabled in the Replay Settings.
In the upper left corner, a Recording Indicator will be displayed unless disabled in the Replay Settings while you are recording.

While Recording, you can set Event Markers using the M key.

Upon exiting your Server/Singleplayer World, you might be asked to wait a couple of seconds until saving the Replay has been finished.
Congratulations, your Replay is now accessible via the Replay Viewer!

Frequently Asked Questions

For how long can I record?

Theoretically, a Replay File can be up to 24 days, 20 hours, 30 minutes and 23 seconds long — which is a timespan you’ll probably never reach.

How many chunks around me does the Mod record?

If you’re playing in Singleplayer, all of the loaded chunks within your Render Distance are recorded.If you’re on a server, this depends on the view-distance setting in the server.properties file, which is set to 11 Chunks by default.

The Replay Mod of course records every loaded, not only the rendered chunks. Therefore, chunks behind your back are recorded as well.

Why can’t I start recording in the middle of a session?

Due to the way the Replay Mod works, you need to start recording when joining a Server or World — otherwise some data which the Replay Files need is missing.

How does recording affect my FPS?

Usually, recording a Replay does not affect your framerate, and it also doesn’t lead to lag on servers.We’ve tested the Mod on a low-end notebook with only 3GB of ram, and everything worked fine.

3.1 Movement

3.1.1 Basic Controls

While in the Replay, you can freely move around using the movement keys ( by default).
You can move through block similar to Spectator Mode.

Using the Mouse Wheel, you can modify your flying speed. Scrolling up causes you to fly faster, while scrolling down slows you down.

If you prefer the camera to be controlled similar to vanilla Creative Mode, you can change that in the Replay Settings.

3.1.2 Camera Roll

While in a Replay, you can tilt the Camera.

By default, pressing will tilt the screen clockwise, and pressing will tilt the screen counterclockwise.Using , you can reset the Camera Roll.

When holding the key ( key on Mac) while tilting, you can tilt slower and more precisely.

Hint: Most of the Keybindings mentioned in this documentation can be changed in Minecraft’s Control Menu.

A Screenshot taken with a tilted camera

3.1.3 Spectating Entities

You can spectate any living entitiy (including players) while in a Replay. When looking at an entity, a crosshair will be visible.

By right-clicking, you will start spectating the entity. If you want to stop spectating the entity, use your Sneak Key ().

1.2 Installing FFmpeg

To render your creations with Replay Mod you will need to have FFmpeg installed.

1.2.1 Windows

Download the latest FFmpeg release from https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-essentials.zip.

In your folder, create a folder. Extract the downloaded .zip file into this folder. The FFmpeg executable should end up at .

Notes for alternative launchers

• Twitch launcher by default installs Minecraft instances in C:\Users\username\Twitch\Minecraft\Instances\instancename\
• GD Launcher by default installs Minecraft instances in C:\Users\username\AppData\Roaming\gdlauncher_next\instances\instancename\
• MultiMC by default installs Minecraft instances in C:\Program Files (x86)\MultiMC\instances\Instancename\.minecraft\

For these launchers, make sure FFmpeg exists in (Twitch / GD) or (MultiMC)

1.2.2 Mac OSX

On OSX, you can install FFmpeg with Homebrew using .

Alternatively, you can download the latest static build from https://ffmpeg.org/ and copy the FFmpeg executable to .

1.2.3 Linux

On Linux, you can install FFmpeg using your system’s package manager, for example using .
If in doubt, consult the documentation of your distribution.

Frequently Asked Questions

For how long can I record?

Theoretically, a Replay File can be up to 24 days, 20 hours, 30 minutes and 23 seconds long — which is a timespan you’ll probably never reach.

How many chunks around me does the Mod record?

If you’re playing in Singleplayer, all of the loaded chunks within your Render Distance are recorded.If you’re on a server, this depends on the view-distance setting in the server.properties file, which is set to 11 Chunks by default.

The Replay Mod of course records every loaded, not only the rendered chunks. Therefore, chunks behind your back are recorded as well.

Why can’t I start recording in the middle of a session?

Due to the way the Replay Mod works, you need to start recording when joining a Server or World — otherwise some data which the Replay Files need is missing.

How does recording affect my FPS?

Usually, recording a Replay does not affect your framerate, and it also doesn’t lead to lag on servers.We’ve tested the Mod on a low-end notebook with only 3GB of ram, and everything worked fine.

3.2 Controlling Time

3.2.1 Replay Speed

In the upper left corner of you screen, there is a Play/Pause button (Shortcut: ), using which you can entirely pause the time of the Replay.All Entities, Particles and Block Updates will be frozen until you resume. You can fly through a paused Replay as usual.

Next to the Play/Pause Button, there is a Speed Slider. Using the Speed Slider, you can control how fast the time in your Replay passes.The minimum Speed value is 0.1 times the normal Minecraft Tick Speed, and the maximum Speed is 8 times as fast.

The Play/Pause button, Speed Slider and Replay Timeline hightlighted

3.2.2 Jumping in Time

To the right of the Speed Slider, there is the Replay Timeline.
On the Replay Timeline, you see a yellow cursor indicating your current position in the Replay.By clicking somewhere on this Timeline, you will travel in time towards the specified point in time.Please note that it takes longer to do larger steps in time or to jump backwards in time (see also ).

Development

Branches

TL;DR:
Main development happens on the branch, snapshots are built from this branch.
The branch contains the most recent release.

The branch is solely to be used for the file that contains a list of all versions
used by the clients to check for updates of this mod.

The Preprocessor

To support multiple Minecraft versions with the ReplayMod, a JCP-inspired preprocessor is used:

        //#if MC>=11200
        // This is the block for MC >= 1.12.0
        category.addDetail(name, callable::call);
        //#else
        //$$ // This is the block for MC < 1.12.0
        //$$ category.setDetail(name, callable::call);
        //#endif

Any comments starting with will automatically be introduced / removed based on the surrounding condition(s).
Normal comments are left untouched. The branch is optional.

Conditions can be nested arbitrarily but their indention shall always be equal to the indention of the code at the line.
The shall be aligned with the inner-most .

    //#if MC>=10904
    public CPacketResourcePackStatus makeStatusPacket(String hash, Action action) {
        //#if MC>=11002
        return new CPacketResourcePackStatus(action);
        //#else
        //$$ return new CPacketResourcePackStatus(hash, action);
        //#endif
    }
    //#else
    //$$ public C19PacketResourcePackStatus makeStatusPacket(String hash, Action action) {
    //$$     return new C19PacketResourcePackStatus(hash, action);
    //$$ }
    //#endif

Code for the more recent MC version shall be placed in the first branch of the if-else-construct.
Version-dependent import statements shall be placed separately from and after all other imports.
Common version dependent code (including the fml and forge event bus) are available as static methods/fields in the class.

The source code in is generally for the most recent Minecraft version and is automatically passed through the
preprocessor when any of the other versions are built (gradle projects , , etc.).
Do NOT edit any of the code in as it is automatically generated and will be overwritten without warning.

You can change the version of the code in if you wish to develop/debug with another version of Minecraft:

./gradle :1.9.4:setCoreVersion # switches all sources in src/main to 1.9.4

If you do so, you’ll also have to refresh the project in your IDE.

Make sure to switch back to the most recent branch before committing!
Care should also be taken that switching to a different branch and back doesn’t introduce any uncommitted changes (e.g. due to different indention, especially in case of nested conditions).

Some files may use the same preprocessor with different keywords.
If required, more file extensions and keywords can be added in the block of the script.

Versioning

• No , the ReplayMod does not provide any external API
• «Updating to a new Minecraft version» should not increment , we maintain one version of the ReplayMod
  for each version of Minecraft and all these versions share the same feature set (and most bugs). We therefore try to
  keep the version name the same for all of them (with the exception of of course). This also means that the
  «Multiple Minecraft Version» section does not apply.
• For pre-releases the shorter is used instead of

When a new version is (pre-)release, a new commit modifying the file should be added and the
file in the branch should be updated. To simplify this process the gradle task can
be used: . It will create the commit and update the version.json
accordingly.

Care should be taken that the updated is not pushed before a jar file is available on the
download page (or Jenkins) as it will inform the users of the update.

3.2 Controlling Time

3.2.1 Replay Speed

In the upper left corner of you screen, there is a Play/Pause button (Shortcut: ), using which you can entirely pause the time of the Replay.All Entities, Particles and Block Updates will be frozen until you resume. You can fly through a paused Replay as usual.

Next to the Play/Pause Button, there is a Speed Slider. Using the Speed Slider, you can control how fast the time in your Replay passes.The minimum Speed value is 0.1 times the normal Minecraft Tick Speed, and the maximum Speed is 8 times as fast.

The Play/Pause button, Speed Slider and Replay Timeline hightlighted

3.2.2 Jumping in Time

To the right of the Speed Slider, there is the Replay Timeline.
On the Replay Timeline, you see a yellow cursor indicating your current position in the Replay.By clicking somewhere on this Timeline, you will travel in time towards the specified point in time.Please note that it takes longer to do larger steps in time or to jump backwards in time (see also ).