zeldaret/oot
Oot
This project is a game decompilation project consisting of a reconstructed C source codebase and the systems used for binary reconstruction. It provides a human-readable version of a commercial game title created through static and dynamic analysis to facilitate technical study and modification.
The project utilizes a containerized build environment to ensure reproducible compilation and consistent toolchain versions across different host operating systems. It includes a game binary reconstructor that translates original machine code into source code and a system for compiling the codebase into multiple regional and platform-specific binaries.
The toolchain covers cross-compilation pipelines and build variant management, using a specific GCC toolchain to target hardware architectures different from the host. Additional capabilities include metadata-driven technical documentation generation and interactive container shells for manual analysis and debugging.
Features
- Binary-to-Source Porting - Implements a system to translate original machine code binaries back into readable C source code.
- Binary Decompilers - Translates original machine code back into human-readable C source code through static analysis of binary patterns.
- Cross-Compilation Toolchains - Implements a build pipeline using a specific GCC toolchain to generate binaries for a target hardware architecture different from the host.
- Cross-Platform Toolchain Setups - Sets up consistent, containerized build environments to compile complex legacy projects without local compiler dependencies.
- Containerized Toolchains - Packages the entire compilation toolchain within container images to ensure a consistent build environment across different host systems.
- Toolchain Provisioning - Automates the installation of compilers and cross-compilers within containers to ensure environment consistency.
- Containerized Build Systems - Automates the compilation process within isolated container environments to guarantee consistency across host operating systems.
- Binary-to-Source Mappings - Provides precise mapping between original game binary offsets and their corresponding reconstructed source code lines.
- Game Console Decompilers - Translates legacy game binaries back into human-readable source code to facilitate study and modification of internal logic.
- C Source Codebases - Provides a complete reconstructed C source codebase for the game.
- Compiler Toolchains - Utilizes a specialized GCC toolchain to compile the reconstructed source code for technical modification.
- Reproducible Build Environments - Uses container images to provide a reproducible build environment, removing the need for local toolchain installation.
- Analysis Build Variants - Allows adjustment of compilation settings and target versions to prepare the codebase for detailed analysis.
- Documentation Generators - Extracts structural information and metadata from the codebase to generate formatted technical documentation for analysis.
- Technical Documentation - Extracts metadata and source structure to produce searchable technical documentation maintained alongside the code.
- Containerized Build Environments - Utilizes Docker to provide a reproducible and isolated environment for the compilation toolchain.
- Game Binary Analysis - Enables the study of game structure and behavior via source code reconstruction and technical documentation.
- Regional Binary Targeting - Generates platform-specific executables by linking source code with different sets of regional asset files.
- Regional Game Versioning - Compiles source code into multiple binaries to support different regional releases and platform-specific assets.
- Retro Game Modding - Enables the creation of custom game versions by modifying reconstructed source code and recompiling the binary.
- Binary Cross-Compilation - Compiles the reconstructed source into multiple regional and platform-specific executable binaries.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
