mirror of https://github.com/encounter/dtk-template.git synced 2025-07-05 12:45:54 +00:00

Go to file

Luke Street 14c60bb5a5 Use phony targets & order_only for custom build rules

This deduplicates dependencies on custom build rules by writing
them once and using phony targets to collect them.

Uses order_only instead of implicit dependencies to avoid
rebuilding source files when a custom build rule is dirty.

Cleans up typing issues in ninja_syntax.py.

2024-10-29 23:41:18 -06:00

.github.example/workflows

Remove fetch-depth: 0 from CI checkout

2024-10-12 22:02:32 -06:00

.vscode

Add support for generating clangd compile_commands.json config (#38 )

2024-10-12 16:50:12 -06:00

assets

Document object_base and disc image support

2024-10-13 01:07:16 -06:00

config/GAMEID

Document object_base and disc image support

2024-10-13 01:07:16 -06:00

docs

Documentation updates

2024-09-17 19:20:51 -06:00

orig/GAMEID

Initial commit

2023-10-04 23:30:39 -04:00

tools

Use phony targets & order_only for custom build rules

2024-10-29 23:41:18 -06: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

Add support for generating clangd compile_commands.json config (#38 )

2024-10-12 16:50:12 -06:00

configure.py

Update tools (& sjiswrap v1.2.0 for GC 3.0+ support)

2024-10-27 16:33:26 -06:00

LICENSE

Relicense under CC0

2023-11-21 20:25:35 -05:00

README.example.md

Document object_base and disc image support

2024-10-13 01:07:16 -06:00

README.md

Update projects list

2024-06-20 22:46:43 -06: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

Discord: GC/Wii Decompilation (Come to #dtk for help!)
objdiff (Local diffing tool)
decomp.me (Collaborate on matches)
frogress (Decompilation progress API)
wibo (Minimal Win32 wrapper for Linux)
sjiswrap (UTF-8 to Shift JIS wrapper)

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.