Things are getting festive in Dirtmouth! This mod adds a new Christmas shop in Dirtmouth owned by a new NPC, Merrywisp. Our hero can buy various decorations for geo to bring some holiday cheer to this gloomy kingdom. Once fully decorated, take a moment to listen and relax under the glow of the tree. Happy holidays!
This is an intermediate/advanced mod that builds upon lessons from my previous intermediate and beginner mods, which I recommend checking out if you are new to modding. Development of this mod occurred over the course of two weeks, with most of the time spent working on the item/shop logic. This mod leans more heavily on Unity development than my previous projects, featuring custom assets, scenes, particle systems, animations, and more. You can check out the Unity project in my HKWorldEdit2 Fork.
This mod has the following features:
- A simple mod menu created using Satchel BetterMenus
- Modification of an existing scene with many new assets developed in Unity and loaded via an asset bundle
- Addition of a new scene (shop) with a transition from an existing scene
- A custom shop menu UI with new items tracked externally from the vanilla player data
- A new interactive NPC with custom dialogue
To show logs: https://hk-modding.github.io/api/articles/logs.html#in-game-console
CasinoKnight
├── bin # Compiled project files
├── docs # Documentation files
├── src # Source folder
│ ├── Resources # Packed asset bundles
│ ├── ChristmasShopSceneHandler.cs # Merrywisp's shop scene handler
│ ├── DirtmouthSceneHandler.cs # Dirtmouth scene modifier handler
│ ├── EasterEggHandler.cs # Easter egg handler
│ ├── Logger.cs # Logging utils
│ ├── ModClass.cs # Core mod class for hooking on Modding API
│ ├── ModData.cs # Mod data associated with a game save
│ ├── ModItems.cs # Custom item information and constants
│ ├── ModMenu.cs # Building function for Custom Mod Menu
│ └── ChristmasInDirtmouth.csproj # C# project file
└── ChristmasInDirtmouth.sln # Visual Studio solution file
- Modding Docs
- Hollow Knight Scene Names
- Hollow Knight Sprite Database
- OG NewScene Docs
- Unity 2020.2.2f1
- HKWorldEdit2
- Unity Asset Bundler Browser
- PlayMaker FSM Viewer Avalonia
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.