How tsukihimates/tsukihime-translation works
This project is an open‐source translation and patch repository for “Tsukihime – A Piece of Blue Glass Moon,” a game originally created by Type‐Moon. Its purpose is to provide translated game content by reading, processing, and then repackaging original assets into a patch that users can apply to their copy of the game. The system is not a full-stack web application but rather a file‐system–based, modular patch project that integrates extraction tools, data processing scripts, and mod packaging.
Main Components
• Resources & Original Data:
– “images”, “videos”, “script”, “system_strings” directories hold the game’s assets (graphics, user interface assets, game CG, video files, and text/dialogue lines).
– “Ryujinx_mods”, “allscr”, and accompanying subdirectories provide the translated mod data and processed script text.
• Tools and Patch Generation:
– The “tools” directory (and its subdirectories such as “patcher”, “layeredfs”, “add_font_effects.py”) contains scripts and tools for processing the data files. These are used to extract, transform, and inject the new translations into the game’s file formats.
• Workflow & Build/Validation:
– Files in “.github/workflows” (like “script_lint.yml”) and configuration files like “.gitignore” indicate CI/CD or automated checking steps.
• Documentation and Guidelines:
– The “README.md” and “Editing_Guidelines.md” offer contextual and usage documentation to guide users and developers.
• Data Processing Flow:
– Start with original resource files (assets and scripts) stored in “script”, “images”, “videos”, etc.
– Extraction tools (e.g., deepLuna, QuickBMS, Mangetsu, and those in “tools/patcher”) process these files.
– The processed data is then stored in intermediary directories such as “allscr/retimed” or directly in mod folders like “Ryujinx_mods.”
– Translation text files (from the “script” folder) and system strings (from “system_strings”) are integrated via the patcher tools.
• Mod Packaging:
– The output of the transformation is organized under mod directories, ready to be applied in emulators (e.g., Ryujinx) or the game’s engine.
• CI/CD or Script Linting:
– The GitHub Actions workflows add an extra layer of validation or automation through tasks such as linting scripts.
Architectural Patterns and Design Principles
• Modularity:
– Each asset type (scripts, images, videos) is maintained in its own directory, allowing independent processing.
• File-based Processing Pipeline:
– The project works as a series of scripted steps (extraction, modification, repackaging) that mirror a pipeline architecture.
• Separation of Concerns:
– Tooling (in “tools”) is kept separate from asset data (in “images”, “script”, “videos”) and from build automation (in “.github/workflows”), ensuring clarity and maintainability.