Skip to content

Commit 0866706

Browse files
committed
Update sm64extend README to include 0.2.1 release changes
1 parent 07fc20e commit 0866706

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

release/sm64extend.README.txt

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## sm64extend 0.2: Super Mario 64 ROM Extender
1+
## sm64extend: Super Mario 64 ROM Extender
22
- accepts Z64 (BE) or V64 (byte-swapped) ROMs as input
33
- works with both US and Japanese ROMs (other tools may not)
44
- decompresses all MIO0 blocks from ROM to extended area
@@ -7,18 +7,20 @@
77
- configurable MIO0 block alignment (default 1 byte)
88
- changes all 0x18 level commands to 0x17
99
- creates MIO0 headers for all 0x1A level commands
10+
- optionally dump compressed and uncompressed MIO0 data to files
1011
- optionally fills old MIO0 blocks with 0x01
1112
- updates assembly reference to MIO0 blocks
1213
- recalculates ROM header checksums
1314

1415
### Usage
1516
```
16-
sm64extend [-s SIZE] [-p PADDING] [-a ALIGNMENT] [-f] [-v] FILE [OUT_FILE]
17+
sm64extend [-s SIZE] [-p PADDING] [-a ALIGNMENT] [-d] [-f] [-v] FILE [OUT_FILE]
1718
```
1819
Options:
1920
-s SIZE Size of the extended ROM in MB (default: 64).
2021
-p PADDING Padding to insert between MIO0 blocks in KB (default = 32).
2122
-a ALIGNMENT Byte boundary to align MIO0 blocks (default = 1).
23+
-d dump MIO0 blocks to files in 'mio0files' directory
2224
-f Fill old MIO0 blocks with 0x01.
2325
-v Verbose output.
2426

@@ -47,6 +49,9 @@ Pad 64 KB between blocks, align blocks to 16-byte boundaries, fill old MIO0 bloc
4749
sm64extend -p 64 -a 16 -f sm64.z64 sm64_output.ext.z64
4850
```
4951
### Changelog:
52+
v0.2.1: add dump option and ROM validity checks
53+
- add dump (-d) command line option
54+
- add more ROM validity checks on input file
5055
v0.2: more options, error checking, and allow extending SM64 (J)
5156
- add fill (-f) command line option
5257
- add more error checking up front and while extending

0 commit comments

Comments
 (0)