Game-Decompilation/botw
1
0
Fork 0
mirror of https://github.com/zeldaret/botw.git synced 2024-11-26 22:50:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Contributing: Mention how to import types into the IDB

Browse Source
This commit is contained in:
Léo Lam 2022-06-21 22:43:07 +02:00
parent 36cd120d26
commit 9f25b2ec73
No known key found for this signature in database
GPG Key ID: 0DF30F9081000741
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Contributing.md
View File

@ -166,10 +166,12 @@ Note that you will need to import names and types manually and you will not be a
* If your Linux distro or system (e.g. macOS) does not package clang-format 12, you can download it from [the LLVM project website here](https://releases.llvm.org/download.html)
## Importing names from the decomp source code
## Importing names or types from source code
In IDA, run the `tools/common/rename_functions_in_ida.py` script (File > Script file...) to import names from the decomp source code back into the IDA database. This can be done as often as you want.
To import types into the IDB, you can use [classgen](https://github.com/leoetlino/classgen) ([binary builds available here](https://github.com/leoetlino/classgen/releases/latest)) or IDA Pro 7.7's Clang-based header parser (less convenient).
## Code style
BotW has 40MB of code and contributors *need* to read and modify existing parts of the codebase very often: inconsistencies lead to a loss of efficiency, and we literally cannot afford that considering our small number of contributors. To avoid wasting time on formatting issues, we use clang-format to automatically enforce a consistent coding style.