mirror
/
firebeat
mirror of https://github.com/DragonMinded/firebeat.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update readme to reflect new patch utility.

This commit is contained in:
Jennifer Taylor 2019-06-26 22:55:55 +00:00
parent 534d80e820
commit 8e8388daf7
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -30,13 +30,13 @@ Images can be ripped and burned again using your favorite image reading/writing
Inside the `utils` directory you will find Python3 code that performs a variety of actions. The target version of Python3 I used was 3.6, but any version newer than this will work as well. The code is organized in a way that will hopefully promote reuse in other areas where it may be useful.
* `exe_utils` - Utilities for working with Firebeat EXE files. Run with `--help` to see full options. Can take a `HIKARU.EXE` or `FIREBEAT.EXE` and unpack it to its raw PPC form, as described in the executable format above. This is suitable for decompiling or applying hex edits to change behavior or text. Can also take a raw PPC binary and repack it to a Firebeat EXE file that is accepted on real hardware. Use this to repack binaries that you have edited. Note that PPP binaries are more complex, so when working with them be sure to use the `--ppp` flag. Can also take two Firebeat EXE files and output the diff of their PPC code as a list of patch offsets.
* `exe_utils` - Utilities for working with Firebeat EXE files. Run with `--help` to see full options. Can take a `HIKARU.EXE` or `FIREBEAT.EXE` and unpack it to its raw PPC form, as described in the executable format above. This is suitable for decompiling or applying hex edits to change behavior or text. Can also take a raw PPC binary and repack it to a Firebeat EXE file that is accepted on real hardware. Use this to repack binaries that you have edited. Note that PPP binaries are more complex, so when working with them be sure to use the `--ppp` flag. Can also take two Firebeat EXE files and output the diff of their PPC code as a list of patch offsets. Can also take a Firebeat EXE file and a list of patch offsets and apply the patches to the EXE file.
* `bin_utils` - Utilities for working with raw PPC binaries that have been extracted. Run with `--help` to see full options. Can take two binaries and output the diff between them as a list of patch offsets.
* `bin_utils` - Utilities for working with raw PPC binaries that have been extracted. Run with `--help` to see full options. Can take two binaries and output the diff between them as a list of patch offsets. Can also take a binary and a list of patch offsets and apply the patches to the binary file.
## 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.
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`.
### Beatmania III Append 7thMIX