3.0 Release

3.0 Release

Author: AmazingAmpharos

.gitattributes

@@ -0,0 +1,2 @@
+/data/rom_patch.txt binary
+/data/symbols.json binary

.gitignore

@@ -1,3 +1,13 @@
 .*.sw*
 .sw*
 *.pyc
+/.vs
+settings.sav
+ARCHIVE.bin
+output/*
+*.z64
+*.z64.bak
+*.pyo
+*.spec
+dist/
+build/

ASM/.gitattributes

@@ -0,0 +1,2 @@
+*.bin binary
+/build/* binary

ASM/.gitignore

@@ -1,5 +1,5 @@
 /inject
 /roms/*
-/temp/*
+/c/*.o
 armips*
 !.gitkeep

ASM/README.md

@@ -1,8 +1,13 @@
-- Download the armips assembler: <https://github.com/Kingcom/armips> and put the
-  executable in the `scripts` directory, or somewhere in your PATH
+- Download the armips assembler: <https://github.com/Kingcom/armips> and put
+  the executable in the `scripts` directory, or somewhere in your PATH
 - Put the ROM you want to patch at `roms/base.z64`
-- Run `python3 scripts/build.py`, which will create `roms/patched.z64`
-- To update the front-end patch file, run:
-  ```python3 scripts/rom_diff.py roms/base.z64 roms/patched.z64 ../data/base2current.json```
+- Run `python scripts/build.py`, which will:
+  - create `roms/patched.z64`
+  - update `../data/rom_patch.txt` and `../data/symbols.json`
 
-To generate debugging symbols for the Project 64 debugger, run `python3 scripts/build.py --pj64sym 'path_to_pj64/Saves/THE LEGEND OF ZELDA.sym'`
+To generate debugging symbols for the Project 64 debugger, use the `--pj64sym`
+option:
+`python scripts/build.py --pj64sym 'path_to_pj64/Saves/THE LEGEND OF ZELDA.sym'`.
+
+To recompile the C modules, use the `--compile-c` option. This requires the
+N64 development tools to be installed: <https://github.com/glankk/n64>