Game-Decompilation/dk64
1
0
Fork 0
mirror of https://gitlab.com/dk64_decomp/dk64.git synced 2024-11-23 07:01:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
7aab82a47b
dk64/tools/asm-differ
History
Donkey Kong 29119d6876 Initial Commit
2023-02-23 16:02:14 +10:30
..
.gitignore Initial Commit 2023-02-23 16:02:14 +10:30
diff.py Initial Commit 2023-02-23 16:02:14 +10:30
mypy.ini Initial Commit 2023-02-23 16:02:14 +10:30
README.md Initial Commit 2023-02-23 16:02:14 +10:30
screenshot.png Initial Commit 2023-02-23 16:02:14 +10:30

README.md

asm-differ

Nice differ for assembly code (MIPS and AArch64; should be easy to hack to support other instruction sets).

Dependencies

  • Python >= 3.6
  • python3 -m pip install --user colorama ansiwrap watchdog python-Levenshtein

Usage

Create a file diff-settings.sh in some directory (see the one in this repo for an example). Then from that directory, run

/path/to/diff.sh [flags] (function|rom addr)

Recommended flags are -mwo (automatically run make on source file changes, and include symbols in diff). See --help for more details.

Tab completion

argcomplete can be optionally installed (with python3 -m pip install argcomplete) to enable tab completion in a bash shell, completing options and symbol names using the linker map. It also requires a bit more setup:

If invoking the script exactly as ./diff.py, the following should be added to the .bashrc according to argcomplete's instructions:

eval "$(register-python-argcomplete ./diff.py)"

If that doesn't work, run register-python-argcomplete ./diff.py in your terminal and copy the output to .bashrc.

If setup correctly (don't forget to restart the shell), complete | grep ./diff.py should output:

complete -o bashdefault -o default -o nospace -F _python_argcomplete ./diff.py

Note for developers or for general troubleshooting: run export _ARC_DEBUG= to enable debug output during tab-completion, it may show otherwise silenced errors. Use unset _ARC_DEBUG or restart the terminal to disable.