Update README.md

README.md

@@ -1,5 +1,5 @@
 # zombies-utils
-##### Download latest release: [v1.2.5](https://github.com/Stachelbeere1248/zombies-utils/releases/tag/v1.2.5).
+##### Download latest release: [v1.3.0-pre5](https://github.com/Stachelbeere1248/zombies-utils/releases/tag/v1.3.0-pre5).
 Hello, I am currently working on this mod. More features will come. For now it has:
 - An accurate timer + Automatic splitting
 - Tracking of splits & segment PBs (with custom categories)
@@ -7,16 +7,26 @@ Hello, I am currently working on this mod. More features will come. For now it h
 - 1 chat macro
 - Spawntime (no aa colors yet, but Rocket Launcher mode)
 #### Disclaimers
-- If you are using a Hypixel language other than english the mod may not work entirely. Use /lang en.
+- If you are using a Hypixel language other than the selected one the mod may not work entirely. Check config.
 ## For Users
-The timer automatically splits every round. The Personal-Best-recorder automatically distinguishes between maps and difficulties.
+The timer automatically splits every round. The PB/Segment recorder automatically distinguishes maps and difficulties, but not player count.
 ### Config
-- SLA Launcher: if on, sets and displays SLA when the mod starts the timer
-- short SLA: if on, hides inactive windows & rooms from the SLA display
-- chat macro: the text to be sent when pressing the respective keybind (-> control settings), DO NOT use "§" as symbol
-- default category name: the category to be tracked until /category is used
-- Rocket Launcher offset: The amount of ticks to be added to wave-spawn times during RL mode
-- passed Waves: Whether to show or hide spawn-times for previous waves.
+- Language: The selected Hypixel language. Currently supports EN,FR,DE.
+- Timer:
+  - Default Category: The record-category to be selected when starting the game.
+  - Paste Delta: Whether to include +- relative to PB when clicking the round summaries to paste it in chat.
+  - PB Announcements: Whether to show **\*\*\*NEW PERSONAL BEST\*\*\*** on PB in summaries.
+- SST:
+  - Enabled: Enables / disables this feature.
+  - Auditory: A List of tick offsets that a sound should be played. Default (-40, -20, 0) means 2s and 1s in advance, as well as on spawn.
+  - RL pre-timing: During RL mode, how much SST times sohuld be offsetted. Defaults to 1.4s earlier. Affects HUD as well as auditory.
+  - Truncate: Whether to show passed rounds in the HUD.
+- SLA:
+  - Enabled: Whether the SLA HUD should automatically be shown when starting a game.
+  - Truncate: Whether inactive windows and rooms should be shown.
+- Macro Message: The Message to be sent when pressing the Chat Macro Key. Do NOT use "§" as symbol.
+- Player Visibility: Whether to show players even if they are within a 4 block radius or not.
+- CPS Counter: A simple CPS Counter which shows the amount of clicks within the last 20 gameticks.
 ### Commands
 - /category \<name> - Switches to the category called name. All recorded times are bound to its category. Tabcomplete suggests already existing categories, but you can insert a new (clean) one as well.
   - Examples:
@@ -33,10 +43,10 @@ The timer automatically splits every round. The Personal-Best-recorder automatic
 - /zombiesutils \<timer>
   - /zombiesutils timer \<kill|split>
     - /zombiesutils timer kill - Stops the running timer completely
-    - /zombiesutils timer split \<round> - Splits as if \<round> was passed, not recommended to use as it might create impossible PBs
-- /qz \<de|bb|aa> - sends you to a new game of Dead End, Bad Blood or Alien Arcadium
+    - /zombiesutils timer split \<round> - Splits as if \<round> was passed, not recommended to use as it might create impossible PBs.
+- /qz \<de|bb|aa|p> - sends you to a new game of Dead End, Bad Blood, Alien Arcadium or Prison
 ### Hotkeys
 - Chat Macro: sends the message specified in the config
 - RL Mode: Toggle usage of the rocket launcher mode spawn-time offset.
 ### Extra
-- Managing split-categories: In your minecraft folder is a folder called "zombies" which contains the folder "splits". You can simply rename or delete the folders inside "splits". You can also edit your splits, the data is stored in ticks inside the MAP_DIFFICULTY.times files, a simple text editor should be able to edit it (UTF-16 encoded text).
+- Managing split-categories: In your game directory is a folder called "zombies" which contains the folder "splits". You can simply rename or delete the folders inside "splits". You can also edit your splits, the data is stored as a list of ticks inside the MAP_DIFFICULTY.times files, a simple text editor (such as Notepad on Windows) should be able to edit it (UTF-16 encoded text). The other subfolder, runs, logs all the splits for every run you play.