# Contributing to Triforce Triforce is a native PC port of the Switch 2 *The Legend of Zelda: Ocarina of Time* remake. The game's code is translated to C and built on your own PC from your own copy of the game; the system and the graphics are rebuilt natively, with the graphics replayed on Vulkan. No emulator is involved. Triforce builds on the open-source Hookshot project (GPL-3.0), and its code keeps that license. This page covers what to send, how to build and test it, and the rules that keep the project out of trouble. The [development guide](docs/development.md) has the full pipeline and its commands; the [design notes](docs/design.md) have the architecture. ## The rule with no exceptions **No game files, keys, or anything made from them leave your PC.** The repository does not contain the game and never will. That includes: - the `.nup`, `romfs`, `exefs`, `.nso`, `.nca`, `.nsp`, `.xci` or `.nsz`/`.xcz` files, and any title keys; - `work/` and everything in it: the extracted dump, `image.bin`, the translated C, test builds, runs and screenshots; - `Triforce.exe`, `triforce_vk.dll`, `triforce_shaders.bin`, `triforce_programs.bin` (and `.idx`), `triforce_pipelines.bin`, `mkw_vk_pipelines.bin` and every other file a build or a run makes; - saves (`user/`), `triforce_options.ini`, `triforce_env.txt` and `language.txt`. Do not open an issue or a pull request asking where to get the game, how to decrypt it, or for someone else's files. A screenshot, a video and `triforce_log.txt` are fine and often necessary; the log holds no game data. `.gitignore` covers most of this, but check `git status` before you commit. If you are not sure whether a file is game data, leave it out. ## Reporting a problem Open an [issue](https://github.com/ruckus7382sfgsgdf/CBeta0.2/issues) and include: - the Triforce version (the release name, or the first line of `triforce_log.txt`); - your graphics card, its driver version, and your Windows version; - where you were in the game and what you did; - the logs: - **a game problem:** `triforce_log.txt` from your game folder (the folder with `Triforce.exe`). If you started the game again after the problem, send `triforce_log.1.txt` too: each start keeps the four runs before it as `triforce_log.1.txt` (the last) to `triforce_log.4.txt`. - **a freeze:** `triforce_hang.txt` from the game folder as well, when it is there. After 20 seconds without a frame the game writes down where each of its threads was (addresses in the program, no game data). - **something seen in play:** press **F8** when you see it, and send the folder it names (`captures\-