Skip to content

AbsoluteStratos/CasinoKnight

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Casino Knight

Discord OS License

Demo gif

Let's go gambling! This mod adds in a new casino building with two slot machines in Dirtmouth where our addicted hero can waste all his geo. Will you win it big?

This is a follow up intermediate mod to my first beginner mod Fart Knight. I had this idea randomly and decided to wastefully sink in several weekends working out how to get my vision into the game and I'm pretty happy with the result. Similar to my previous mod, I want to document this the learnings I had creating what I consider an intermediate mod for Hollow Knight. Many of the features of this mod can be quickly extended to create entirely new levels, change the look of existing scenes and more.

This mod has the following features:

  • A simple mod menu created using Satchel BetterMenus
  • Modifying an existing scene by loading in a asset bundle exported from Unity
  • Creating a new scene loaded from an asset bundle exported from Unity
  • Creating a new gate from an existing scene to a new scene, including a door way
  • Development pattern for using existing HK game assets inside your mod
  • Development pattern for modifying HK game assets via FSM graphs to create custom behavior
  • Integrating complex sprite animations using Unity animator controllers and scripting

Documentation

Some rough notes taken documenting various items:

Code Walkthrough

Interested in the code / mod development but need some help? Check out the walkthrough video which provides a more detailed break down of each feature (click the image 🚀):

Hollow Knight Mod Walkthrough

Repository Layout

CasinoKnight
├── bin                     # Compiled project files
├── docs                    # Documentation files
├── etc                     # Miscellaneous stuff
├── src                     # Source folder
│   ├── Resources           # Packed asset bundles
│   ├── ModClass.cs         # Core mod class for hooking on Modding API
│   ├── ModMenu.cs          # Building function for Custom Mod Menu
│   ├── GlobalSettings.cs   # Data-structure for global state / settings
│   ├── Log.cs              # Simple logging utils
│   ├── CasinoExterior.cs   # Casino exterior loading and logic
│   ├── CasinoInterior.cs   # Casino interior loading and logic 
│   ├── SlotHandler.cs      # Slot machine logic and behavior
│   └── CasinoKnight.csproj # C# project file
└── CasinoKnight.sln        # Visual Studio solution file

Resources

Not used but cool:

Dependencies

Support

For issues / bugs, I probably won't fix them but feel free to open an issue. The modding discord has a lot of very helpful and active devs there which can also answer various questions but don't bug them about this mod.