more readme stuff

This commit is contained in:
rjkiv
2025-07-27 20:41:41 -07:00
parent 9f334b0eee
commit 0cd84adaa4
+7
View File
@@ -14,6 +14,9 @@ with other decompilation tools like [objdiff](https://github.com/encounter/objdi
Much like the original GC/Wii decomp toolkit, jeff aims to automate as much of the decompilation setup process as possible,
allowing developers to spend less time configuring a project and more time focusing on what matters most in a decomp: matching code.
I had made jeff with the goal of starting up a [decomp for Dance Central 3](https://github.com/rjkiv/dc3-decomp),
but realized the potential jeff has to work with several other Xbox 360 games, and thus, tried to add support for that to the best of my ability.
**DISCLAIMER**: Although I genuinely tried my best to get jeff working with the pool of xexes I had to test with,
**I make absolutely zero guarantees that this will work out of the box with every last Xbox 360 game! Expect bugs!**
@@ -36,6 +39,10 @@ This is NOT meant to be run on its own, but rather part of a build system, such
There are multiple different kinds of jump table versions that MSVC likes to use, and the code that detects them is rather hacky.
The code checks for a specific sequence of known instructions and infers the jump table type from there.
This can result in some jump tables being "guessed" or missed during function detection.
- When parsing .map files, the last split of a section will not get added.
This is because during development, I found that the last split would sometimes conflict with the inferred boundaries of nearby objects/symbols, which would cause errors.
So, if you are using jeff and your game has a map, you will have to remember to manually add the last split of each of your exe's sections.
- Parsing/applying .pdb files is not currently supported.
- Because this was forked from encounter's GC/Wii toolkit, there is naturally still a lot of loose GC/Wii tailored code in this codebase that needs removing/refactoring.
## Want to contribute?