falso
/
botw
mirror of https://github.com/zeldaret/botw.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update readme information

This commit is contained in:
Léo Lam 2020-12-10 23:08:34 +01:00
parent ae23585ed2
commit ecd1b9b486
No known key found for this signature in database
GPG Key ID: 0DF30F9081000741
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -8,7 +8,7 @@ File names, class or function names and the file organization come from leftover
## Status
Currently, the focus is on decompiling AI classes and other small, mostly self-contained components (e.g. LevelSensor).
Currently, the focus is on decompiling AI classes and KingSystem framework code.
Because meaningfully splitting the code is not feasible, the built executable currently only contains functions that have been decompiled and no effort is being made to put functions and data at the correct addresses.
@ -38,6 +38,8 @@ Using Linux (or WSL) is recommended but not required. The rest of this guide ass
On subsequent builds, just run `ninja -C build` from the project root.
**THIS WILL NOT PRODUCE A PLAYABLE GAME.**
## Contributing
To contribute to the project, you will also need:
@ -55,8 +57,6 @@ Using a decompiler is strongly recommended for efficiency reasons. If you have I
Feel free to join the [Zelda Decompilation](https://discord.zelda64.dev/) Discord server if you have any questions.
*Note to contributors:* *Breath of the Wild* heavily relies on software libraries like [sead](https://github.com/open-ead/sead) which are statically linked. Given that most of BotW's dependencies have not been fully decompiled yet, decompiling any non-trivial part of the game might require working on those libraries first.
### How to decompile
0. Open the executable in the disassembler of your choice.