encounter
/
dtk-template
mirror of https://github.com/encounter/dtk-template.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Project template for decomp-toolkit
19 Commits 2 Branches 0 Tags 562 KiB
Python 100%
Go to file
Luke Street afb82c88dc Add GitHub Actions workflow template & documentation 2024-03-05 17:24:33 -07:00
.github.example/workflows Add GitHub Actions workflow template & documentation 2024-03-05 17:24:33 -07:00
.vscode.example Implement mypy fixes across all python files (#4) 2024-01-23 23:21:46 -07:00
assets Initial commit 2023-10-04 23:30:39 -04:00
config/GAMEID Minor documentation updates 2024-03-04 23:30:41 -07:00
docs Add GitHub Actions workflow template & documentation 2024-03-05 17:24:33 -07:00
orig/GAMEID Initial commit 2023-10-04 23:30:39 -04:00
tools Fix dtk binary feature (#18) 2024-03-04 23:19:57 -07:00
.flake8 Fix `pyright` complaints and run `black` (#12) 2024-02-29 11:21:44 -07:00
.gitattributes Sync various changes from other repos & minor updates 2023-11-21 20:14:25 -05:00
.gitignore Implement mypy fixes across all python files (#4) 2024-01-23 23:21:46 -07:00
LICENSE Relicense under CC0 2023-11-21 20:25:35 -05:00
README.example.md Minor documentation updates 2024-03-04 23:30:41 -07:00
README.md Add GitHub Actions workflow template & documentation 2024-03-05 17:24:33 -07:00
configure.py Support disabling asm overrides and fix lint errors (#17) 2024-03-04 22:13:39 -07:00

README.md

decomp-toolkit Project Template

If starting a new GameCube / Wii decompilation project, this repository can be used as a scaffold.

See decomp-toolkit for background on the concept and more information on the tooling used.

Documentation

General:

References

Projects using this structure:

Features

  • Few external dependencies: Just python for the generator and ninja for the build system. See Dependencies.
  • Simple configuration: Everything lives in config.yml, symbols.txt, and splits.txt.
  • Multi-version support: Separate configurations for each game version, and a configure.py --version flag to switch between them.
  • Feature-rich analyzer: Many time-consuming tasks are automated, allowing you to focus on the decompilation itself. See Analyzer features.
  • REL support: RELs each have their own symbols.txt and splits.txt, and will automatically be built and linked against the main binary.
  • No manual assembly: decomp-toolkit handles splitting the DOL into relocatable objects based on the configuration. No game assets are committed to the repository.
  • Progress calculation and upload script for frogress.
  • Integration with objdiff for a diffing workflow.
  • CI workflow template for GitHub Actions.

Project structure

  • configure.py - Project configuration and generator script.
  • config/[GAMEID] - Configuration files for each game version.
  • config/[GAMEID]/build.sha1 - SHA-1 hashes for each built artifact, for final verification.
  • build/ - Build artifacts generated by the the build process. Ignored by .gitignore.
  • orig/[GAMEID] - Original game files, extracted from the disc. Ignored by .gitignore.
  • orig/[GAMEID]/.gitkeep - Empty checked-in file to ensure the directory is created on clone.
  • src/ - C/C++ source files.
  • include/ - C/C++ header files.
  • tools/ - Scripts shared between projects.

Temporary, delete when done:

  • config/GAMEID/config.example.yml - Example configuration file and documentation.
  • docs/ - Documentation for decomp-toolkit configuration.
  • README.md - This file, replace with your own. For a template, see README.example.md.
  • LICENSE - This repository is licensed under the CC0 license. Replace with your own if desired.