mirror/ph
1
0
Fork 0
mirror of https://github.com/zeldaret/ph synced 2026-05-23 06:54:18 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Aetias
2024-10-19 09:29:00 +02:00
parent b7905ab660
commit be640e984d
3 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
INSTALL.md
+3 -1
View File
@@ -27,7 +27,7 @@ python tools/setup.py
```
5. Run the Ninja configure script:
```shell
python tools/configure.py
python tools/configure.py <eur|usa>
```
> [!IMPORTANT]
@@ -37,6 +37,8 @@ python tools/configure.py
> For Linux users: If you plan to use Wibo instead of Wine, run `configure.py` with `-w <path/to/wibo>`.
6. Put one or more base ROMs in the [`/extract/`](/extract/README.md) directory of this repository.
Now you can run `ninja` to build a ROM for the chosen version.
### Matching the base ROM
**This is optional!** You only need to follow these steps if you want a matching ROM.
README.md
+3 -3
View File
@@ -1,10 +1,10 @@
# The Legend of Zelda: Phantom Hourglass
**Work in progress!** This project aims to recreate source code for ***The Legend of Zelda: Phantom Hourglass*** by decompiling
assembly code by hand. **The repository does not contain assets or assembly code.** To build the ROM, you must own an existing
**Work in progress!** This project aims to recreate source code for ***The Legend of Zelda: Phantom Hourglass*** by decompiling its code by hand. **The repository does not contain assets or assembly code.** To build the ROM, you must own an existing
copy of the game to extract assets from.
**Note:** The project targets the European and American versions, and other versions might be supported later.
> [!NOTE]
> The project targets the European and American versions, and other versions might be supported later.
## How to install
See [INSTALL.md](INSTALL.md) for instructions on how to install the project.
docs/decompiling.md
+2 -3
View File
@@ -20,10 +20,9 @@ again. Remember to make a pull request of any progress you made on the source fi
partially decompiled code.
## Decompiling a source file
We use the object diffing tool [`objdiff`](https://github.com/encounter/objdiff) to track differences between C++ and assembly
code.
We use the object diffing tool [`objdiff`](https://github.com/encounter/objdiff) to track differences between our decompiled C++ code and the base ROM's code.
1. [Download the latest release.](https://github.com/encounter/objdiff/releases/latest)
1. Run `configure.py` and `ninja` to generate `objdiff.json` in the `/config/<version>/arm9/` directories.
1. Run `configure.py <eur|usa>` and `ninja` to generate `objdiff.json` in the repository root.
1. In `objdiff`, set the project directory to one of the mentioned `arm9/` directories.
1. Select your source file in the left sidebar:
![List of objects in objdiff](images/objdiff_objects.png)