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

readme: Add information about the status of the project 

And clarify that it cannot be used to play BotW, and that it does not
contain any copyrighted content from the RomFS.
This commit is contained in:
Léo Lam 2020-08-30 01:53:22 +02:00
parent 2826bcde7c
commit 880e1678e3
No known key found for this signature in database
GPG Key ID: 0DF30F9081000741
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -4,8 +4,16 @@ This is a decompilation of U-King v1.5.0 (Switch).
File names, class or function names and the file organization come from leftover strings. Unlike some other first-party games such as *Super Mario Odyssey*, all known public versions of U-King are completely stripped, so most names are just more or less educated guesses. File names, class or function names and the file organization come from leftover strings. Unlike some other first-party games such as *Super Mario Odyssey*, all known public versions of U-King are completely stripped, so most names are just more or less educated guesses.
This repository only contains source code; it cannot be used to play *Breath of the Wild* and does *not* include any RomFS content.
## 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 other small, mostly self-contained components (e.g. LevelSensor).
*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 requires working on those libraries first.
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.
## Building ## Building
Building this project requires: Building this project requires: