Speedrun-Tricks-Visual-Helper

A mod that changes the color of the knight to indicate when they can do an action which can help learning skips. It shows when fireball, dash, or wall jumping are available and also when the knight is facing left or right (to see turnarounds). You can switch what action causes the color change by pressing the key that was binded to ChangeModeKey in the GlobalSettings file.

How its meant to be used

It is meant to be used as a indicator for how well you are doing the skips after you have finished them. It is not for helping do the skips in real time because: 1) reaction time and 2) input lag.

How to use

• Download the Modding API.
• From the releases tab, download the version that corresponds to your game version (Current Patch or 1.2.2.1) and place it in the Mods folder.
• Run the game once with the mod installed and verify that it is installed by seeing if it appears on the top left of the title screen. Then close the game and open the .json file in the saves folder.
• Add an acceptable input in ChangeModeKey to add a key bind for changing modes. e.g. ChangeModeKey = "b".
• Open the game and press the bound key to switch between modes.

Modes Currently Available:

1. Turnaround:

• It shows a different color when facing right and left
• e.g. of use -> To help identify how much you're spending drifting in the wrong direction.

2. Fireball

• It shows when you can fireball.
• e.g. of use -> Show if you're wasting frames while doing fireball skips.

3. Dash

• It shows when you can dash.
• e.g. of use -> practicing timing dashes.
• Note: if the color doesn't change when you chain dashes, it means you dashed within 1 frame after completing the dash (so that's the optimal dash timing). If you see white flashes, your timing is a bit off.

4. WallJump

• It shows when you can wall jump
• e.g. of use -> QGA skip

5. Jump

• It shows when you can jump

6. Attack

• It shows when you can attack

7. Inventory

• It shows when you can open inventory
• e.g. of use -> pacticing current patch inventory drops

Additional Options Explanation

• Current_Mode_Name_AlwaysVisible -> if false, the "Mode : {Mode}" Text disappears after 3 seconds. if true, stays there forever.
• Color_true -> Color of knight when you can't do something.
• Color_false -> Color of knight when you can't do something.
• Turnaround_OnlyinAir -> if true, only changes color in the air.
• Fireball_OnlyinAir -> if true, only changes color in the air.
• Dash_OnlyonGround -> if true, only changes color while on the ground.

Notes (So it doesnt clog up the readme)

To get to the Hollow knight folder / hollow_knight.app:

• Steam: Go to your Library -> Right Click Hollow Knight -> Click on Properties-> Local Files -> Browse.
• GoG: Select the symbol next to the play button -> Click on Manage Installation -> Show Folder.

Mods Folder

• Windows: Hollow Knight\hollow_knight_Data\Managed\Mods.
• Mac: hollow_knight.app\contents\Resources\Data\Managed\Mods.

Saves Folder

• Windows: %APPDATA%\..\LocalLow\Team Cherry\Hollow Knight\.
• Mac: ~/Library/Application Support/unity.Team Cherry.Hollow Knight/.

Downloading Modding API

• If on current patch:
  • Use the Modinstaller.
• if 1.2.2.1:
  • Download the latest Modding API from here
  • If on windows:
    • Place it in Hollow Knight\hollow_knight_Data\Managed.
  • If on mac:
    • Place it in hollow_knight.app\contents\Resources\Data\Managed\.

Future Updates

• Mode for showing if able to attack
• Mode for showing if able to jump