How neparij/katawa-shoujo-agb works
This repository is a Game Boy Advance adaptation of Katawa Shoujo. The main player-facing flow is visual-novel play: the scene manager coordinates dialogue, backgrounds, characters, transitions, menus, and saved progress, with music and video playback alongside gameplay. Separate converter tools transform upstream scripts, translations, definitions, and character art for the port. The README also documents oversized event backgrounds and the adapted OST. The supplied excerpts show only parts of runtime wiring; omitted relationships are not inferred.
Main entry points: scenemanager.cpp Scene manager · main.py Converter commands · sound_manager.cpp Sound manager · menu_ingame_pause.cpp.h Pause and saves menus
Components 20
Game Runtime
- Scene manager
src/scenemanager.cpp - Dialogue UI
src/dialogbox.cpp.h - Pause and saves menus
src/menu/menu_ingame_pause.cpp.h - Game state
src/globals.h
Game Content
- Scenario definitions
include/definitions.h - Background catalog
include/background_metas.h - Huge backgrounds
src/ks_huge_bgs_manager.cpp - Character sprite catalog
include/character_sprite_meta.h
Save System
- Save data
src/savefile/save_file.cpp
Audio Video
- Sound manager
src/sound_manager.cpp - Audio mixer
src/sound/sound_mixer.h - 8AD audio player
src/sound/player_8ad.iwram.c - ULC audio player
src/sound/player_ulc.iwram.c - Video playback
src/videoplayer/video_player.cpp - DXTV player
src/dxtvplayer/videoplayer.cpp
Conversion Tools
- Converter commands
tools/converter/src/main.py - Scenario reader
tools/converter/src/scenario_reader.py - Sprite converter
tools/converter/src/character_sprite/character_sprite.py - Graphics tool
tools/ks_graphics_tool.py
Other components
- Player
Connections 19
- Player → Scene manager: plays through
- Scene manager → Dialogue UI: manages dialogue
- Scene manager → Pause and saves menus: dispatches menus
src/scenemanager.cpp - Scene manager → Game state: updates state
src/scenemanager.cpp - Scene manager → Save data: uses save data
src/scenemanager.cpp - Scene manager → Background catalog: uses backgrounds
- Scene manager → Character sprite catalog: uses sprite metadata
- Scene manager → Huge backgrounds: supports events
- Pause and saves menus → Save data: reads save slots
- Scene manager → Sound manager: controls sound
src/scenemanager.cpp - Sound manager → Audio mixer: uses mixer
src/sound_manager.cpp - Sound manager → 8AD audio player: dispatches effects
- Sound manager → ULC audio player: dispatches music
- Scene manager → Video playback: uses video
src/scenemanager.cpp - Video playback → DXTV player: delegates playback
src/videoplayer/video_player.cpp - Converter commands → Scenario reader: reads scripts
tools/converter/src/main.py - Converter commands → Sprite converter: converts sprites
tools/converter/src/main.py - Converter commands → Graphics tool: generates graphics
- Converter commands → Scenario definitions: produces game content