aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 29 insertions, 1 deletions
diff --git a/README.md b/README.md
index 6e949b1..72cede1 100644
--- a/README.md
+++ b/README.md
@@ -49,7 +49,11 @@ Note that `--set-level 5,all` operates three separate parameters that could be d
Individual letter/balloon control is not implemented at this time.
## Dependencies
-Just python3.
+For the library and cli, just python3.
+
+For the graphical frontend:
+
+ sudo apt-get install python3-tkinter python3-pil.imagetk
## Building
N/A
@@ -67,6 +71,28 @@ The binary contents are stored in little-endian, which makes visual inspection o
![Screenshot of profile selection screen showing three names: "Hexedit," "4fun and," and "Profit."](.images/scrot-hexedit-for-fun-and-profit-srb.png "Screenshot of profiles with fun names")
+## Graphical frontend
+There is an included python tcl/tk frontend:
+
+ ./srb_tk.py
+
+The tool loads the default "Profile 1.sav" file right away. Clicking any widget effects an immediate change to the checksum. To save the file, you must select "Save" from the menu.
+
+![Screenshot of graphical savegame editor](.images/scrot-savegame-editor-graphical.png "Screenshot of the savegame editor with a completed profile on display")
+
+## Credits
+Unless a graphic was taken from the game, any icons come from icons8.
+
+<a target="_blank" href="https://icons8.com/icon/9336/aircraft">Main program icon</a> icon by <a target="_blank" href="https://icons8.com">Icons8</a>
+<a target="_blank" href="https://icons8.com/icon/8Sk1THlBUpC6/hay-bale">Hay Bale</a> icon by <a target="_blank" href="https://icons8.com">Icons8</a>
+<a target="_blank" href="https://icons8.com/icon/23346/wooden-beer-keg">Barrel</a> icon by <a target="_blank" href="https://icons8.com">Icons8</a>
+<a target="_blank" href="https://icons8.com/icon/IjFwYfQ6Hmgc/geyser">Geyser</a> icon by <a target="_blank" href="https://icons8.com">Icons8</a>
+<a target="_blank" href="https://icons8.com/icon/17358/pumpkin">Pumpkin</a> icon by <a target="_blank" href="https://icons8.com">Icons8</a>
+<a target="_blank" href="https://icons8.com/icon/dwzqRjO6XcTN/battery">Battery</a> icon by <a target="_blank" href="https://icons8.com">Icons8</a>
+
+## License
+GPL 3.0. Contributions welcome!
+
## References
1. <https://bgstack15.ddns.net/blog/posts/2024/03/22/initial-research-for-hacking-savegame-files-for-snoopy-vs-the-red-baron/>
@@ -75,3 +101,5 @@ The binary contents are stored in little-endian, which makes visual inspection o
4. <https://gist.github.com/Lauszus/6c787a3bc26fea6e842dfb8296ebd630>
5. <https://stackoverflow.com/questions/46109815/reversing-the-byte-order-of-a-string-containing-hexadecimal-characters>
6. [Walkthrough for Snoopy vs. the Red Baron](https://gamefaqs.gamespot.com/pc/930591-snoopy-vs-the-red-baron/faqs/46161)
+
+Too many to list here. See the References heading in each file for more.
bgstack15