Project

Project Layout

Top-level highlights

Common modules (based on file names in the repo):

• App lifecycle: main.cpp, mainLoop.*, gameTime.*
• Rendering:
  • renderer.*, rendererBGFX.cpp
  • bgfxGlue.*
  • Shaders: *_ps.sc, *_vs.sc, *.varying.def.sc
  • Post-processing: postProcessing.*, ssao_*.sc, blur_*.sc, composite_*.sc, brightpass_*.sc
• UI / menus:
  • startupMenu.*, systemMenu.*, controlsMenu.*
  • ImGui glue: imguiBGFX.*
• Input: input.*
• Gameplay / world:
  • room.*, actorList.*, object.*, inventory.*, life.*, sequence.*
• Resources / archives:
  • fileAccess.*, pak.*, hqr.*, unpack.*
  • HD assets: hdArchive.*, hdBackground.*, hdBackgroundRenderer.*
• Audio:
  • music.*
  • osystemAL.*, osystemAL_*, osystemSDL.cpp
• Diagnostics:
  • debugger.*, exceptionHandler.*, debugFont.*
• Versioning: version.*

Where to start reading code

1. main.cpp → entry point
2. mainLoop.* → update/render loop
3. renderer* → rendering pipeline
4. room/life/sequence → gameplay state
5. fileAccess/pak/hqr → data loading