Katawa Shoujo - Game Boy Advance Port

A faithful adaptation of Katawa Shoujo for the GBA, powered by the Butano framework. Includes Python tools to convert assets and scripts from the Katawa Shoujo: Re-Engineered project.

   

Screenshots

FMVs also included!

---

Features

• Visual Novel Gameplay optimized for GBA.
• The entire OST carefully adapted for the GBA.
• Video Cutscenes fits alongside the game.
• Tools for converting assets and scripts.
• Huge bitmaps to display backgrounds with more than 1024 tiles (used for events).

---

Requirements

1. DevkitARM (Setup Guide)
   • Windows: Use DevkitPro Installer.
   • macOS/Linux: Install via devkitpro-pacman.

     sudo dkp-pacman -S devkitARM

   • Verify: arm-none-eabi-gcc --version
2. Python 3.12 for tools.
3. Butano fork with custom audio integrated (uses branch katawa). Should be placed to ../butano relative to this repository.
4. libsavgba should be placed to ../libsavgba relative to this repository.
5. For CLion IDE users:
   • Install compiledb
     • macOS:

       brew install compiledb

     • Linux:

       pip install --user compiledb

   • Generate compile_commands.json:

     compiledb make -j$(nproc)

   • Import the project in CLion as a Compilation Database project
   • Configure the devkitARM toolchain in CLion (see devkitARM setup guides)

---

Contribution

1. Fork the repository.
2. Clone the forked repository.
3. Create a branch for your feature.
4. Test your changes on emulators and hardware.
5. Submit a pull request.

---

Credits

• Four Leaf Studios for creating Katawa Shoujo.
• Butano Framework by GValiente for the GBA development framework.
• ulc-codec by Aikku93 for the Ultra-low-complexity MDCT Audio Codec.
• 8ad by Damian Yerrick.
• GBA-image-tools by HorstBaerbel for the DXTV video codec.
• libsavgba by laqieer for Flash saving abilities.
• Katawa Shoujo: Re-Engineered by Fleeting Heartbeat Studios for the great adaptation Katawa Shoujo to the modern Ren'Py engine.

Special Thanks

Some tools and projects may no longer be part of the current build, but they played a meaningful role in earlier stages of development. Their ideas, inspiration, and technical foundations helped shape this project, and for that, I'm truly grateful:

• afska for the GSM Player Butano integration and supporting the development process.
• libagmv by RyandracusCodesGames for the AGMV video codec.
• GSM Player by Damian Yerrick for the GBA audio player.

---

License

This project is not affiliated with Four Leaf Studios and Fleeting Heartbeat Studios.

The code is licensed under the Mozilla Public License 2.0, while the original assets are under by their original CC-BY-NC-ND license.