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

readme: Clarify project scope (and excluded libraries)

This commit is contained in:
Léo Lam 2021-06-15 00:04:33 +02:00
parent 950db241d3
commit 79505a1b23
No known key found for this signature in database
GPG Key ID: 0DF30F9081000741
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -14,6 +14,22 @@ Considering the large size of the executable (~40MB), it is not expected to reac
As a result, the project is unlikely to produce a working executable in the near future. It will help with understanding and reverse engineering the game even in its incomplete state, but it will **not** help with playing BotW or porting the game to other platforms, which is **explicitly a non-goal**.
## Scope
* Main executable (main NSO)
* *Breath of the Wild* code
* Actual game code (`Game` / uking:: namespace)
* Framework/engine code (`KingSystem` / ksys:: namespace)
* Statically linked libraries
* First-party libraries (e.g. sead, agl, EventFlow, etc.)
* NintendoSDK inlined utilities
* Any other statically linked library, except:
* libcurl
* NintendoSDK-NEX
* Havok (physics engine)
Excluded libraries will not be fully decompiled but may be partly re-implemented or decompiled, and (reverse-engineered) headers will still be provided so that the rest of the codebase can still use those libraries.
## Frequently Asked Questions
### What is (matching) decompilation?