Game-Decompilation/tp
1
0
Fork 0
mirror of https://github.com/zeldaret/tp.git synced 2024-11-30 08:41:13 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

pr template, update README (#387)

Browse Source
This commit is contained in:
Pheenoh 2023-07-24 02:55:22 -04:00 committed by GitHub
parent cb8bf4a489
commit bc59794141
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 31 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
.github/pull_request_template.md vendored Normal file
View File

@ -0,0 +1,16 @@
## CC0 License Agreement
<!--
By submitting this pull request, I agree to comply with the terms of the Creative Commons Zero v1.0 Universal (CC0) Public Domain Dedication License for my contributions to this project.
I dedicate any and all copyright interest in this contribution to the public domain. I make this dedication for the benefit of the public at large and to the detriment of my heirs and successors. I intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this contribution under copyright law.
To the best of my knowledge and belief, my contribution is either originally created by me, or is derived from a source that also released its contents under CC0 or a compatible license.
I understand that this project and its maintainers are not responsible for enforcing the CC0 license, and I release them from any potential liability related to my contribution.
-->
- [ ] I agree to the terms of the CC0 License.
<!--
Please check the checkbox above to indicate your agreement.
-->

112
README.md
View File

@ -1,113 +1,28 @@
# The Legend of Zelda: Twilight Princess ![Code Progress] ![Dol Progress] ![Rels Progress]
# The Legend of Zelda: Twilight Princess <br /> ![Code Progress] ![Dol Progress] ![Rels Progress]
[Code Progress]: https://img.shields.io/endpoint?label=Code&url=https%3A%2F%2Fprogress.deco.mp%2Fdata%2Ftwilightprincess%2Fgcn_usa%2Fdefault%2F%3Fmode%3Dshield%26measure%3Dcode
[Dol Progress]: https://img.shields.io/endpoint?label=Dol&url=https%3A%2F%2Fprogress.deco.mp%2Fdata%2Ftwilightprincess%2Fgcn_usa%2Fdefault%2F%3Fmode%3Dshield%26measure%3Ddol
[Rels Progress]: https://img.shields.io/endpoint?label=Rels&url=https%3A%2F%2Fprogress.deco.mp%2Fdata%2Ftwilightprincess%2Fgcn_usa%2Fdefault%2F%3Fmode%3Dshield%26measure%3Drels
This repo contains a WIP decompilation of The Legend of Zelda: Twilight Princess (GCN USA).
More information about the project can be found here: https://zsrtp.link
<!--ts-->
* [Progress](./Progress.md)
* [Project Setup](#project-setup)
* [Building The Game](#building-the-game)
* [Clean Directories](#clean-directories)
* [Project Overview](#project-overview)
* [Contributing](./docs/Contributing.md)
* [FAQ](https://zelda64.dev/games/tp)
* [Progress](https://zsrtp.link/progress)
* [Project Setup](https://zsrtp.link/contribute/installation#set-up-dependencies)
* [Building The Game](https://zsrtp.link/contribute/installation#building)
* [Cleanup](https://zsrtp.link/contribute/installation#cleanup)
* [Contributing](https://zsrtp.link/contribute)
* [FAQ](https://zsrtp.link/aboutp)
<!--te-->
Project Setup
=================
1. Clone down project
```bash
git clone https://github.com/zeldaret/tp
```
2. Place a copy of NTSC-U GCN Twilight Princess in the root directory and call it `gz2e01.iso` (find this on your own)
3. Then run the setup script
```bash
./tp setup
```
Building The Game
-----
1. To build a playable game, complete the [Project Setup](#project-setup) steps, then run
```bash
make game
```
The completed build is under `build/dolzel2/game/sys/main.dol`
Build DOL
```bash
make
```
(Note that any time you run make you can add the -j# argument where # is the amount of threads your system has in order to greatly speed up build times)
Build RELs
```bash
make rels
```
The completed RELs will be under `build/dolzel2/rel`
Extract Game Assets
```bash
make assets
```
Create Expected Directory
1. Run `make`
2. Run:
```bash
./tp expected
```
Clean Directories
-----
Clean RELs
```bash
make clean_rels
```
Clean Game Directory
```bash
make clean_game
```
Clean Build Directory
```bash
make clean_all
```
Clean Dol
```bash
make clean
```
Project Overview
=================
```
tp/
├── .github # Github actions for this project.
├── .devcontainer # Files required to use a container as a full-feature dev environment in vscode (optional).
├── .github # Github actions and PR templates for this project.
├── asm # The assembly for unmatched functions.
├── defs # Python modules used by dol2asm.
├── docs # Notes and documentation about this project.
@ -122,10 +37,13 @@ tp/
├── Makefile # Makefile for the project containing various targets.
├── Progress.md # Markdown file that displays the current progress of the project.
├── README.md # The file you're currently reading.
├── asmdiff.sh # Bash script to diff two functions using objdump and diff based on their input addresses.
├── diff.py # Python script to diff two functions.
├── diff_settings.py # Settings for the diff.py script.
├── dolzel2.sha1 # SHA1 of the dol.
├── include_link.mk # Makefiles to include in the main Makefile.
├── makewibo.sh # Bash script used with objdiff to force it to build with wibo.
├── obj_files.mk # Object files to include in the main Makefile.
├── sha1sums.json # JSON file containing SHA1 checksums of the DOL and RELs.
└── tp # Bash script used to call the main tp python script in tools directory.
```