The get_modding_guide tool provides built-in documentation on these topics. Topics marked with new were derived from patterns found across the community mod ecosystem.
A note on guides: MCPs like this live and die on how up-to-date and well-written the modding guides and references are. It will eventually figure things out with self-debugging, but adding to this database is key to being more efficient. If you use it for a project, please have it write out additional guides and push them to the repo!
| Topic | Description |
|---|---|
getting_started |
Prerequisites, quick start, key concepts |
cards |
CardModel, pools, dynamic vars, OnPlay, localization |
relics |
RelicModel, hooks, images, localization |
powers |
PowerModel, stacking, buff/debuff |
potions |
PotionModel, OnUse, potion pools |
monsters |
MonsterModel, move state machines, scenes |
encounters |
EncounterModel, room types, act pools |
events |
EventModel, choices, outcomes |
harmony_patches |
Prefix, postfix, targeting, common patterns |
localization |
JSON structure, SmartFormat, dynamic vars |
console |
Dev console commands and testing |
hooks |
All 144 hooks by category with signatures |
pools |
Card/relic/potion pool system |
building |
dotnet build, PCK export, installation |
debugging |
Remote debugging, logging, common issues |
project_structure |
Recommended layout, .csproj settings |
multiplayer_networking |
INetMessage, sending/receiving, transfer modes, message batching |
godot_ui_construction |
Programmatic Controls, StyleBox, themes, focus chains, hover tips, tweens |
reflection_patterns |
AccessTools, Traverse, __makeref struct mutation, cached FieldInfo |
advanced_harmony |
IL transpilers, async patching, multi-method targeting, prefix control |
save_file_format |
Save file locations, JSON schema, custom mod save data |
game_log_parsing |
godot.log format, regex patterns, in-code logging |
combat_deep_dive |
Intent system, damage pipeline, all Command APIs (DamageCmd, PowerCmd, etc.) |
custom_keywords_and_piles |
[CustomEnum] keywords, KeywordProperties, custom PileType routing |
mod_config_integration |
BaseLib SimpleModConfig, reflection bridge, manual JSON config |
resource_loading |
PCK vs DLL resources, fallback chains, assembly loading, intent atlas paths |
rng_and_determinism |
Rng class, RunRngSet, seed management, deterministic sub-seeds |
accessibility_patterns |
TTS integration, focus navigation, screen reader support, high contrast |