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

readme: Clarify how progress is tracked

This commit is contained in:
Léo Lam 2021-02-19 13:53:15 +01:00
parent dbd3fbb3d2
commit 9e3975a813
No known key found for this signature in database
GPG Key ID: 0DF30F9081000741
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -6,11 +6,17 @@ File names, class or function names and the file organization come from leftover
**This repository does not contain game assets or RomFS content and *cannot* be used to play *Breath of the Wild*.**
This project is only about the main executable which contains all game code and statically linked libraries. The RomFS and the SDK libraries are *out of the scope* of this project.
Progress: https://botw.link/progress
Just like other decompilation projects, progress is tracked by looking at the percentage of decompiled bytes (the number of decompiled bytes divided by the total code size).
## Goal
The goal of this project is to better understand game internals, aid with glitch hunting and document existing knowledge in something less fragile than an IDA database.
Considering the large size of the executable (~40MB), it is not expected to reach 100% progress within a reasonable timeframe. That's actually not really an objective since the KingSystem framework represents less than 50% of the executable. Nevertheless, this project still uses the percentage of decompiled bytes to track progress for the components we are interested in.
Considering the large size of the executable (~40MB), it is not expected to reach 100% progress within a reasonable timeframe.
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**.