thirdpartymirrors/Zelda64Recomp
1
0
Fork 0
mirror of https://github.com/Zelda64Recomp/Zelda64Recomp.git synced 2026-04-28 05:01:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update BUILDING.md

Browse source
This commit is contained in:
David Chavez 2024-05-18 01:54:49 +02:00 • committed by GitHub
parent 246610ec1a
commit b1916a8393
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
BUILDING.md
View file

@ -1,10 +1,13 @@
# Building Guide
> [!NOTE]
> The need for an elf file from the Majora's Mask decompilation is temporary and will be removed in the future.
This guide will help you build the project on your local machine. The process will require you to provide two items:
- A decompressed ROM of the US version of the game.
- An elf file created from [this commit](https://github.com/zeldaret/mm/tree/23beee0717364de43ca9a82957cc910cf818de90) of the Majora's Mask decompilation.
The steps cover: acquiring these, running the required processes and finally building the project.
These steps cover: acquiring these, running the required processes and finally building the project.
## 1. Clone the Zelda64Recomp Repository
This project makes use of submodules so you will need to clone the repository with the `--recurse-submodules` flag.
@ -79,4 +82,5 @@ cmake --build build-cmake --target Zelda64Recompiled -j$(nproc) --config Release
Voilà! You should now have a `Zelda64Recompiled` file in the `build-cmake` directory!
_Note: In the game itself, you should be using a standard ROM, not the decompressed one._
> [!IMPORTANT]
> In the game itself, you should be using a standard ROM, not the decompressed one.