Skip to content

magneticpizza/DebugMod

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation


                                   FEATURES

  • A toggleable UI in-game that provides the following functions:
  • Cheats such as invincibility and noclip
  • The ability to unlock all charms or repair broken ones
  • Change which skills the player has
  • Change which items the player has
  • Give the player more of consumable resources such as geo and essence
  • Respawn bosses
  • Hold multiple dream gate positions
  • Change the player's respawn point to anywhere in the current scene
  • Recall to the set respawn point
  • Kill all enemies
  • Add HP bars to enemies
  • Draw collision boxes for enemies
  • Clone or delete any enemy
  • Set an enemy's health to 9999
  • Change the player's nail damage
  • Damage the player
  • Change the camera zoom level
  • Disable the in game HUD
  • Make the player invisible
  • Disable the lighting around the player
  • Disable the vignette drawn around the player
  • Change the time scale of the game

                              INSTALLATION

(STEAM/GOG, WINDOWS)

  1. Download the modding API for Hollow Knight 1.2.2.1 At the time of writing, 1.2.2.1-41 is the most up-to-date release: https://cdn.discordapp.com/attachments/298798821402607618/817653175586783242/Assembly-CSharp.dll
  2. Right click Hollow Knight in Steam -> Properties -> Local Files -> Browse Local Files OR In GOG galaxy 2 -> Click button to the right of Update -> Manage Installation -> Show Folder
  3. Create a backup of the game files located here
  4. Copy the contents of the modding API zip into this folder (Overwrite files when asked)
  5. Copy the contents of this zip into the folder (Overwrite files when asked)
  6. This mod should not affect saves negatively, but it is a good idea to back them up anyway. Saves are located at %AppData%..\LocalLow\Team Cherry\Hollow Knight\

How to build (for devs):

  1. Make a folder Source/References/, then
  2. add Assembly-CSharp.dll (with modding-api), and PlayMaker.dll, UnityEngine.dll and UnityEngine.UI.dll from your Hollow Knight/hollow_knight_Data/Managed/-folder

                                  SAVESTATE BASICS

Savestates

In order to acess the new save-states, bind Next Page and Prev Page to any keys you want (2nd page of binds in debug mod) You can select as many total pages you want (default: 10) in the DebugMod.GlobalSettings-1.2.2.1 in your saves folder. Prev/Next Page will scroll through these. After this, you can just do what you would do in normal debug mod to save and load states.

To use your old savestates, go to this folder %APPDATA%..\LocalLow\Team Cherry\Hollow Knight\Savestates-1221 copy the files in this folder into the folder labeled 0 ( if it doesn't exist, make it. ) Start the game and you will have your old saves plus 9 other pages full of empty slots by default.

If you have performance issues, please report it.

To use numpad for slot select; after installing debugmod, start and stop the game, then go to the Hollow Knight saves-directory and open the DebugMod.GlobalSettings-1.2.2.1 json-file. In that file find "NumPadForSaveStates", and change the corresponding value from 0 to 1.

To change the amount of available Savestate-slots per page (default: 6), find MaxSaveStates and set the corresponding value between 0 and 10 respective of how many slots you want.

Savestates files are located in %APPDATA%\..\LocalLow\Team Cherry\Hollow Knight\Savestates-1221\. They use the name format savestate<slot>.json. After saving a savestate to file, you can edit the name of that savestate. To do this, open the file in any text-editor, and the first variable/line should be something like "saveStateIdentifier": "<timestamp+area/scene name>",. Change <timestamp+area/scene name> inside the pair of "-s to whatever you want that savestate named in the select savestate in-game menu.

Quickslot:

The main savestate used. Not saved permanently, cleared when the game restarts.

Quickslot save to file

Specifies slot number, then saves the current Quickslot from temporary memory to a numbered json-file in the game save directory, overwriting any files with identical number as the selected one.

Load file to quickslot

Asks to specify slot number, then reads the json-file with that number from the game save directory and loads it into the Quickslot, overwriting any current savestate there.

Save new state to file

Specifies slot number, then makes a new savestate and saves to a json-file with the given slot number.

Load new state from file

Specifies slot number, then loads savestate from that file directly.

How to use room specific Savestates

  1. Make sure you are in one of the following rooms, as these are the only ones supported Room_Final_Boss_Core Deepnest_Spider_Town (you can check what room you are in by pressing f2 and reading 'scene name')
  2. Create a savestate in the said room.
  3. Open your hollow knight saveStates folder (%APPDATA%..\LocalLow\Team Cherry\Hollow Knight\Savestates-1221)
  4. Subtract 1 from the page of savestates you saved in, and open that folder. (example, saved in page 4, open folder named 3)
  5. Open the savestate.json, whatever number you pressed being the number it will be (example, pressed 4, open file named savestate4 with a text editor such as notepad)
  6. Change the value labeled useRoomSpecific to 1 to enable room specific savestates.(if you can't find it, search for 'useRoomSpecific' with Ctrl+f)
  7. Load the savestate.

                                  Known Issues

Savestates:

  • Charm effects not updating properly after loading savestates. Workaround: quitout and load back in or bench to manually apply the new charms.
  • UI not refreshing properly to remove obsolete vessel fragments
  • Soul meter stuck at full if in that state before loading
  • Softlocks if loading savestate during dream transitions
  • If loading savestate during transition visuals will not load. Either press 'esc' twice to get control of the knight and walk through a transition if this happens, or quit to menu and load back in before loading the savestate
  • (All savestates are loaded in RAM, which means fast loading from savestates fetched from files BUT potentially general performance issues)

                                      CREDITS

Seresharp
56
Yurihaia
Krythom
The Embraced One
Katie
KeinZantezuken
MyEyes/Firzen
Cerpintext
Mulhima
DemoJameson
ConstructiveCynicism

About

Debug Mod for Hollow Knight

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 100.0%