Fast read: keep SoulScorch Engine and HomeSoulDB next to each other, keep mod content inside mods, and keep cloud deployment concerns outside the engine repo.
Step 1. Keep the repos side by side
The engine and the docs or API repo are easiest to reason about when they sit next to each other. That keeps mod registry changes, wiki changes, and runtime fixes moving together without mixing concerns into one codebase.
Contributions/ |- SoulScorch-Engine/ |- HomeSoulDB/
Step 2. Learn the three layers
Engine layer
Gameplay, notes, cameras, states, cutscenes, scripts, and rendering all live inside SoulScorch Engine.
Mod layer
Most project-specific content should live in a mod folder with its own assets, metadata, and scripts.
Service layer
HomeSoulDB and HomeSoul Cove handle discovery, stand metadata, jam rosters, and online-facing API features.
Step 3. Pick your first goal
| Goal | Where to focus |
|---|---|
| Make a simple song mod | Assets, charts, metadata, and the beginner modding path |
| Add custom behavior | SoulScript, HScript, Lua, or Iris in the scripting layer |
| Build a bigger game | Custom states, menus, stages, events, packaging, and broader project structure |
| Put it online | HomeSoulDB catalog data, HomeSoul Cove stand metadata, Cloudflare deployment |