diff options
| author | Aetias <aetias@outlook.com> | 2024-10-19 09:29:00 +0200 |
|---|---|---|
| committer | Aetias <aetias@outlook.com> | 2024-10-19 09:29:00 +0200 |
| commit | be640e984d6cb93d803d7fe45eba96f441b58ec8 (patch) | |
| tree | 6d694589121409e02ad26c0357e6138609f2f3d5 | |
| parent | b7905ab6602ae89b5c9fabfd83a364ad0186fe8d (diff) | |
Update docs
| -rw-r--r-- | INSTALL.md | 4 | ||||
| -rw-r--r-- | README.md | 6 | ||||
| -rw-r--r-- | docs/decompiling.md | 5 |
3 files changed, 8 insertions, 7 deletions
@@ -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. @@ -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. diff --git a/docs/decompiling.md b/docs/decompiling.md index c01ba1cf..88b32032 100644 --- a/docs/decompiling.md +++ b/docs/decompiling.md @@ -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:  |