Skip to content

Commit fcd5cd9

Browse files
committed
Updated README
- brought back gradle.properties
1 parent a4a7010 commit fcd5cd9

File tree

3 files changed

+23
-18
lines changed

3 files changed

+23
-18
lines changed

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,4 @@ build
2020
# other
2121
eclipse
2222
run/
23-
logs/
24-
gradle.properties
23+
logs/

README.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This mod is currently only for Forge 1.12.2 and will update/downgrade once 1.12.
1010
1111
# Credits
1212
Author of the original mod: [tr7zw](https://github.com/tr7zw/MC-TASmod)
13-
Main Author: Scribble
13+
Main Mod Author: Scribble
1414

1515
Contributions by: famous1622, Pancake
1616

@@ -21,19 +21,19 @@ Savestate idea: [bspkrs, MightyPork](https://github.com/bspkrs-mods/WorldStateCh
2121
Special thanks: Darkmoon, The Minecraft TAS Community
2222
# Features
2323
## Playback
24-
This mod can record and play back:
25-
- The entire keyboard, minus TASmod specific keys (see below).
24+
This mod can record and play back
25+
- The entire keyboard, minus TASmod keybinds (see below).
2626
- Gui-Screens like crafting, the pause menu and the main menu! (Except the keybinding screen)
2727
- Any screen size and window size (No warranties here...)
2828

2929
### Commands
30-
`/record` - Starts to record your input, hit the same command again to stop recording
31-
`/play` - Starts to play back a the stored inputs
32-
`/save <filename>` - Saves stored inputs to a file
33-
`/load <filename>` - Load inputs from file
30+
`/record` - Start a recording. This will record inputs to RAM. Closing the game will empty these inputs.
31+
`/play` - Start to play back the stored inputs.
32+
`/save <filename>` - Save stored inputs to a file.
33+
`/load <filename>` - Load inputs from file.
3434
`/clearinputs` - Delete all stored inputs, use this before starting a brand new recording.
3535
`/record` - will resume the recording and not clear the inputs first.
36-
`/playuntil <tickCount>` - Stops the next recording at the specified tick number, then switches to a recording. Run this command then start a playback via `/play`
36+
`/playuntil <tickCount>` - Stops the next playback at the specified tick number, then switches to a recording. Run this command then start a playback via `/play`.
3737

3838
`/fullrecord, /fullplay` - Same as record/play however it will quit to the main menu first.
3939
`/restartandplay <filename>` - Quits Minecraft completely. When restarting, the specified file will be loaded and played back, when the menu appears.
@@ -42,25 +42,28 @@ This mod can record and play back:
4242

4343
## Savestate
4444
### Commands
45-
`/savestate` - Prints a full guide to the savestate command in chat
45+
`/savestate` - Prints a full guide to the savestate command in chat.
4646
### Keybinds
4747
<kbd>J</kbd> - Make a new savestate.
48-
<kbd>K</kbd> - Load the most recent savestate
48+
<kbd>K</kbd> - Load the most recent savestate.
4949

5050
## Tickratechanger (Slowdown)
5151
### Commands
5252
`/tickrate <ticks/second>` - Changes the game speed. Default is 20, anthing below will slow the game down, anything above will speed it up.
5353
### Keybinds
54-
<kbd>F8</kbd> - Enter "Tickrate 0". The game is paused but you can still look around
54+
<kbd>F8</kbd> - Enter "Tickrate 0". The game is paused but you can still look around.
5555
<kbd>F9</kbd> - While in tickrate 0, advance the tick by 1. By holding keyboardkeys, you can make inputs while tickadvancing.
5656

5757
## Multiplayer support
58-
> **Note:** This is **NOT** a clientside mod, a server side installation is required a.k.a This doesn't work on Hypixel, 2b2t etc. And will **NEVER** be suppoted
58+
<p style="color: red; font-size: 1.3em"><b>Important:</b> This is <b>NOT</b> a clientside mod, a server side installation is required a.k.a This doesn't work on Hypixel, 2b2t etc. These servers will <b>NEVER</b> be supported.</p>
5959

6060
Record TASes with friends! Needs operator permissions to run tasmod related commands.
6161
/savestate can be used to manage savestates.
6262

63-
> **Note:** /fullrecord, /fullplay and /restartandplay do not work in multiplayer at this time
63+
> **Note:** /fullrecord, /fullplay and /restartandplay are not guaranteed to work in multiplayer at this time.
64+
65+
## HUD
66+
When ingame, hitting <kbd>F6</kbd> will show you options for customising your HUD, with monitoring options and more. Even more options are available when KillTheRNG is installed.
6467

6568
# Development
6669
## Setup
@@ -69,12 +72,12 @@ Record TASes with friends! Needs operator permissions to run tasmod related comm
6972
- Use gradle version 4.10.3
7073
- Use [JDK 8](https://adoptium.net/en/temurin/releases/?version=8)
7174
3. Run gradle tasks `setupDecompWorkspace` then `eclipse`.
72-
4. *Optional but recommended:* Run gradle task `downloadKTRNG` (in the tasmod category) to download KillTheRNG to the run/mods folder.
75+
4. *Optional but recommended:* Run gradle task `downloadKTRNG` (in the "tasmod" category) to download KillTheRNG to the run/mods folder.
7376

7477
## Running
75-
The task `eclipse` should've genererated to launch configs: `TASmod_Client.launch` and `TASmod_Server.launch`. Select it then click the run or debug button in your IDE.
78+
The task `eclipse` should've generated to launch configs: `TASmod_Client.launch` and `TASmod_Server.launch`. Select it, then click the run or debug button in your IDE.
7679

7780
> **Note:** Additional setup is required for the server to actually start, like changing the eula.txt and setting `online-mode` to false in server.properties.
7881
7982
## Building
80-
Build the mod using the gradle task `build` (or alternatively `shadowJar`)
83+
Build the mod using the gradle task `build` (or alternatively `shadowJar`).

gradle.properties

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Sets default memory used for gradle commands. Can be overridden by user or command line properties.
2+
# This is required to provide enough memory for the Minecraft decompilation process.
3+
org.gradle.jvmargs=-Xmx3G

0 commit comments

Comments
 (0)