Update readme with utility descriptions for new utilities.

This commit is contained in:
Jennifer Taylor 2021-06-10 04:30:20 +00:00
parent cabb4495aa
commit 9d6f753cb7
1 changed files with 7 additions and 0 deletions

View File

@ -41,6 +41,13 @@ Inside the `utils` directory you will find Python3 code that performs a variety
* `bin_utils diff` - Can take two binaries and output the diff between them as a list of patch offsets.
* `bin_utils patch` - Can take a binary and a list of patch offsets and apply the patches to the binary file.
* `dallas_crc` - Simple utility that can replicate an iButton CRC for the laser-etched ROM ID written on the iButton itself.
* `dongle_dump_utils` - Utilities for crafting dongle dumper executables that run on a Firebeat.
* `dongle_dump_utils check` - Check an existing executable to see if it is a dumper, and if so what game it is set up to dump.
* `dongle_dump_utils password` - Update an existing dumper executable to contain the passwords to dump a particular game.
* `dongle_dump_utils validate` - Perform a simple validation over a reconstructed dongle dump to check it for sanity.
## Patch Offsets
The following are patch offsets that you can apply to a raw PowerPC image that has been extracted. The number on the left of the colon is the hex offset where you should make the change, and the numbers on the right of the colon are the before and after values at that location. To use any of these, obtain an image of the game, copy the Firebeat EXE out of the image, decompress it using the `exe_utils unpack` command, apply the edits using your favorite hex editor, recompress the image using `exe_utils pack` and then replace the Firebeat EXE in the image you obtained the original from. Alternatively, you can use `exe_utils patch` to patch a Firebeat EXE directly, or `bin_utils patch` to patch an unpacked PPC image. Patch offsets can be generated by diffing two Firebeat EXE files with `exe_utils diff` or by diffing two PPC binaries with `bin_utils diff`.