Update docs
@@ -2,7 +2,14 @@
|
|||||||
## Installing the Replay Mod [replaymod]
|
## Installing the Replay Mod [replaymod]
|
||||||
The **ReplayMod** requires **Minecraft Forge** to be installed.
|
The **ReplayMod** requires **Minecraft Forge** to be installed.
|
||||||
|
|
||||||
For the use with the **Replay Mod**, we recommend using Forge Version `1.8-11.14.3.1450`, which can be downloaded [here](http://files.minecraftforge.net/maven/net/minecraftforge/forge/index_1.8.html)
|
Depending on your **Replay Mod** version we recommend the following **Forge** versions:
|
||||||
|
|
||||||
|
- Replay Mod 2.0.0 or later for Minecraft 1.11: Forge [1.11-13.19.1.2189](https://files.minecraftforge.net/maven/net/minecraftforge/forge/index_1.11.html)
|
||||||
|
- Replay Mod 2.0.0 or later for Minecraft 1.10.2: Forge [1.10.2-12.18.2.2099](https://files.minecraftforge.net/maven/net/minecraftforge/forge/index_1.10.2.html)
|
||||||
|
- Replay Mod 2.0.0 or later for Minecraft 1.9.4: Forge [1.9.4-12.17.0.1976](https://files.minecraftforge.net/maven/net/minecraftforge/forge/index_1.9.4.html)
|
||||||
|
- Replay Mod 2.0.0 or later for Minecraft 1.8: Forge [1.8-11.14.4.1563](https://files.minecraftforge.net/maven/net/minecraftforge/forge/index_1.8.html)
|
||||||
|
- Replay Mod 1.0.8 or older for Minecraft 1.8: Forge [1.8-11.14.3.1450](http://files.minecraftforge.net/maven/net/minecraftforge/forge/index_1.8.html)
|
||||||
|
|
||||||
Other Forge Versions might, but don't necessarily work.
|
Other Forge Versions might, but don't necessarily work.
|
||||||
|
|
||||||
If you don't know how to install Forge, follow [this tutorial](https://www.youtube.com/watch?v=4i7-RystzC4).
|
If you don't know how to install Forge, follow [this tutorial](https://www.youtube.com/watch?v=4i7-RystzC4).
|
||||||
@@ -37,26 +44,23 @@ If in doubt, consult the documentation of your distribution.
|
|||||||
## Compatibility with other Mods [compatibility]
|
## Compatibility with other Mods [compatibility]
|
||||||
### General information [general]
|
### General information [general]
|
||||||
In General, the Replay Mod _should_ be compatible with most Forge Mods.
|
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](http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/2327429-pixelcam-camera-studio-for-minecraft-1-8)
|
|
||||||
or the [CommandGroups Mod](http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/2443430-command-groups-mod-order-label-and-color-command)) usually work.
|
|
||||||
|
|
||||||
### Optifine [optifine]
|
|
||||||
The **Replay Mod** is compatible with `Optifine 1.8.0 HD U D5`, which can be downloaded at <https://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.
|
|
||||||
|
|
||||||
### Shaders Mod [shaders]
|
### Shaders Mod [shaders]
|
||||||
You can use the Replay Mod together with [karyonix' Shaders Mod](http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/1286604-shaders-mod-updated-by-karyonix),
|
[Karyonix' Shaders Mod](http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/1286604-shaders-mod-updated-by-karyonix)
|
||||||
but rendering videos results in **possible crashes** and **malformed videos**.
|
is no longer compatible with Minecraft Forge starting with 1.9.4. As such it is not compatible with the Replay Mod either.
|
||||||
Therefore, you have to **uninstall the Shaders Mod before rendering**.
|
Please use [Optifine](https://optifine.net/) instead.
|
||||||
|
|
||||||
## Troubleshooting [troubleshooting]
|
## Troubleshooting [troubleshooting]
|
||||||
If you need help installing the **Replay Mod** or **FFmpeg**, please read [this forum thread](https://www.replaymod.com/forum/thread/220)
|
If you need help installing the **Replay Mod** or **FFmpeg**, please read [this forum thread](https://www.replaymod.com/forum/thread/220)
|
||||||
by [bela333](https://www.replaymod.com/user/bela333) - it covers most of the problems that users encountered so far.
|
by [bela333](https://www.replaymod.com/user/bela333) - it covers most of the problems that users encountered so far.
|
||||||
|
|
||||||
|
## Settings [settings]
|
||||||
|
To access the **Replay Mod Settings** from the Main Menu click the **"Mods"** button, select the **Replay Mod** from the list and
|
||||||
|
the click the **"Config"** button.
|
||||||
|
|
||||||
|
When in a Replay, you can either bind a hotkey to the **Replay Mod Settings** in Minecraft's Control settings
|
||||||
|
or use the hotkey GUI by clicking on the arrow button in the lower left corner.
|
||||||
|
|
||||||
# Recording [recording]
|
# Recording [recording]
|
||||||

|

|
||||||
The **Recording Indicator** which is displayed while recording
|
The **Recording Indicator** which is displayed while recording
|
||||||
@@ -88,6 +92,8 @@ 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.
|
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**.
|
||||||
|
|
||||||
### Camera Roll [roll]
|
### Camera Roll [roll]
|
||||||

|

|
||||||
A Screenshot taken with a **tilted camera**
|
A Screenshot taken with a **tilted camera**
|
||||||
@@ -251,13 +257,15 @@ The **Keyframe Repository** with two **Path Presets**
|
|||||||
|
|
||||||
Using the `X` key, you can open the **Keyframe Repository**. Every Replay File has a separate Keyframe Repository which can contain several **Keyframe Presets**.
|
Using the `X` key, you can open the **Keyframe Repository**. Every Replay File has a separate Keyframe Repository which can contain several **Keyframe Presets**.
|
||||||
|
|
||||||
To save the Keyframes currently on your Timeline, click the **"Save current Path"** button.
|
To save the Keyframes currently on your Timeline, click the **"Save as..."** button.
|
||||||
You can change the Preset's name using the Text Input Field in the upper right corner.
|
You can change a Preset's name, select it from the list and click the **"Rename"** button.
|
||||||
To load a Keyframe Preset, select a Preset from the list on the left side and click the **"Load"** button.
|
To load a Keyframe Preset, select a Preset from the list and click the **"Load"** button.
|
||||||
Using the **"Remove"** button, you can permanently delete a Keyframe Preset from the **Keyframe Repository**.
|
Using the **"Remove"** button, you can permanently delete a Keyframe Preset from the **Keyframe Repository**.
|
||||||
|
|
||||||
## Custom Objects [objects]
|
## Custom Objects [objects]
|
||||||
|
|
||||||
|
> Custom Objects are not available in the 2.0.0 versions. They are expected to return eventually.
|
||||||
|
|
||||||
[YouTube](_Xdpg828fbE)
|
[YouTube](_Xdpg828fbE)
|
||||||
|
|
||||||
### Introduction [introduction]
|
### Introduction [introduction]
|
||||||
@@ -416,12 +424,10 @@ There are **7 Encoding Presets** you can choose from:
|
|||||||
|
|
||||||
### Advanced Settings [advanced]
|
### Advanced Settings [advanced]
|
||||||

|

|
||||||
The **Advanced Render Settings** Screen
|
The **Advanced Render Settings**
|
||||||
|
|
||||||
By clicking the **"Advanced Settings" Button** in the lower right corner, you can access more settings.
|
#### Render Nametags [nametags]
|
||||||
|
If you don't want to see Entity's Nametags in the rendered video, simply un-tick the checkbox. Hidden Nametags also include Nametags of **Armor Stands** and **Mobs**, **not only Players**!
|
||||||
#### Hide Nametags [nametags]
|
|
||||||
If you don't want to see Entity's Nametags in the rendered video, simply tick the checkbox. Hidden Nametags also include Nametags of **Armor Stands** and **Mobs**, **not only Players**!
|
|
||||||
|
|
||||||
#### Stabilize Camera [stabilize]
|
#### Stabilize Camera [stabilize]
|
||||||
This setting is only applicable for **Cubic Rendering** and **Equirectangular Rendering**.
|
This setting is only applicable for **Cubic Rendering** and **Equirectangular Rendering**.
|
||||||
@@ -443,14 +449,14 @@ Using a **Video Editing Software** like **Adobe After Effects** or **Sony Vegas*
|
|||||||
|
|
||||||
### Command Line Settings [commandline]
|
### Command Line Settings [commandline]
|
||||||

|

|
||||||
The **Command Line Render Settings** Screen
|
The **Command Line Render Settings**
|
||||||
|
|
||||||
|
|
||||||
> **Note**: This is for advanced users only. If you do not know what your're doing, leave these settings as they are.
|
> **Note**: This is for advanced users only. If you do not know what your're doing, leave these settings as they are.
|
||||||
|
|
||||||
The **Replay Mod** runs [FFmpeg](http://ffmpeg.org/) via the **Command Line** to encode videos.
|
The **Replay Mod** runs [FFmpeg](http://ffmpeg.org/) via the **Command Line** to encode videos.
|
||||||
|
|
||||||
You can customize both the **executed Command** and the **Command Line Arguments** in the **Command Line Settings** Tag of the **Render Settings Screen**.
|
You can customize both the **executed Command** and the **Command Line Arguments** in the **Command Line Settings** part of the **Render Settings Screen**.
|
||||||
|
|
||||||
#### Custom Command [command]
|
#### Custom Command [command]
|
||||||
If you leave the left input field blank, `ffmpeg` will be used as **command**. If you haven't set your **PATH variable** to link to your FFmpeg distribution, simply enter the full path to your FFmpeg executable (e.g. `C:/ffmpeg/ffmpeg.exe` or `/usr/local/bin/ffmpeg`).
|
If you leave the left input field blank, `ffmpeg` will be used as **command**. If you haven't set your **PATH variable** to link to your FFmpeg distribution, simply enter the full path to your FFmpeg executable (e.g. `C:/ffmpeg/ffmpeg.exe` or `/usr/local/bin/ffmpeg`).
|
||||||
@@ -532,7 +538,7 @@ 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**.
|
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.
|
This way, you can hide certain players from the Replay.
|
||||||
Above the individual checkboxes, there are two checkbox buttons - one to **hide all players** and one to **show all players**.
|
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 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),
|
If checked, invisible players will stay invisible after closing the Replay (this can of course be reverted),
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 50 KiB |
|
Before Width: | Height: | Size: 112 KiB After Width: | Height: | Size: 147 KiB |
|
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 51 KiB |
BIN
docs/img/player-overview.png
Normal file
|
After Width: | Height: | Size: 101 KiB |
|
Before Width: | Height: | Size: 62 KiB After Width: | Height: | Size: 85 KiB |
BIN
docs/img/rendersettings-advanced.png
Normal file
|
After Width: | Height: | Size: 147 KiB |
|
Before Width: | Height: | Size: 78 KiB After Width: | Height: | Size: 108 KiB |
BIN
docs/img/rendersettings-commandline.png
Normal file
|
After Width: | Height: | Size: 150 KiB |
|
Before Width: | Height: | Size: 76 KiB After Width: | Height: | Size: 110 KiB |
BIN
docs/img/rendersettings-video.png
Normal file
|
After Width: | Height: | Size: 140 KiB |