Skip to content

Commit 6143186

Browse files
committed
update documentation for v1.20
1 parent a3b9b3a commit 6143186

File tree

2 files changed

+20
-10
lines changed

2 files changed

+20
-10
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# exhal / inhal
22
**HAL Laboratory NES/SNES/GB (de)compression tools**
3-
**(version 1.10)**
3+
**(version 1.20)**
44
by Devin Acker (Revenant), 2013
55
https://github.com/devinacker
66

77
exhal and inhal are tools designed to decompress and recompress/insert data used by several NES, SNES and Game Boy games developed by HAL Laboratory.
88

99
Due to the design of the original decompression algorithm (and hardware limitations), the size of a file to be compressed is limited to 64 kilobytes (65,536 bytes). Please note that depending on which system you are working with, the actual useful limit may be much smaller.
1010

11-
Files compressed using exhal can often be smaller than their original compressed forms in the source ROMs, likely due to some shortcuts taken by the original development tools. In addition, version 1.10 nicely optimizes the compression process and is about 4x faster than before.
11+
The compression routine used by inhal is very fast and capable of producing output which is smaller than that of HAL's original compressor.
1212

13-
Source code is available at https://github.com/devinacker and is released under the terms of the MIT license. See COPYING.txt for legal info.
13+
Source code is available at https://github.com/devinacker and is released under the terms of the MIT license. See COPYING.txt for legal info. You are welcome to use compress.c in your own projects (if you do, I'd like to hear about it!)
1414

1515
**To use exhal (the decompressor):**
1616
exhal romfile offset outfile
@@ -62,6 +62,11 @@ Also note, unfortunately, that exhal cannot automatically detect or locate compr
6262

6363
These tools were originally used in the development of my Kirby's Dream Course editor. I hope you find your own exciting use for them. (I'm not the only Kirby hacker in the West, right? *sob*)
6464

65+
## Changes
66+
67+
* **v1.20**: index byte triples using uthash for even faster searching, nicer error handling
68+
* **v1.10**: index byte pairs for faster searching during compression, misc bug fixes
69+
6570
## Contact me
6671

6772
* Email : d at revenant1.net
@@ -77,5 +82,5 @@ These tools were originally used in the development of my Kirby's Dream Course e
7782

7883
* andlabs for helping me make the list of supported games
7984
* BMF54123 for naming the programs
80-
* Tiiffi for misc. Mac OS X build fixes
85+
* Tiiffi and Anthony J. Bentley for misc. build fixes
8186
* You for downloading (and using?) my software

README.txt

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
exhal / inhal
22
HAL Laboratory NES/SNES/GB (de)compression tools
3-
(version 1.10)
3+
(version 1.20)
44
by Devin Acker (Revenant), 2013
55
https://github.com/devinacker
66

@@ -11,12 +11,12 @@ Due to the design of the original decompression algorithm (and hardware limitati
1111
a file to be compressed is limited to 64 kilobytes (65,536 bytes). Please note that depending on
1212
which system you are working with, the actual useful limit may be much smaller.
1313

14-
Files compressed using exhal can often be smaller than their original compressed forms in the
15-
source ROMs, likely due to some shortcuts taken by the original development tools. In addition,
16-
version 1.10 nicely optimizes the compression process and is about 4x faster than before.
14+
The compression routine used by inhal is very fast and capable of producing output which is smaller
15+
than that of HAL's original compressor.
1716

1817
Source code is available at https://github.com/devinacker and is released under the terms of the
19-
MIT license. See COPYING.txt for legal info.
18+
MIT license. See COPYING.txt for legal info. You are welcome to use compress.c in your own projects
19+
(if you do, I'd like to hear about it!)
2020

2121
To use exhal (the decompressor):
2222
exhal romfile offset outfile
@@ -73,6 +73,11 @@ to make searching easier.
7373
These tools were originally used in the development of my Kirby's Dream Course editor. I hope you
7474
find your own exciting use for them. (I'm not the only Kirby hacker in the West, right? *sob*)
7575

76+
Changes:
77+
78+
v1.20: index byte triples using uthash for even faster searching, nicer error handling
79+
v1.10: index byte pairs for faster searching during compression, misc bug fixes
80+
7681
Contact me:
7782

7883
Email : d at revenant1.net
@@ -87,5 +92,5 @@ Special thanks to:
8792

8893
- andlabs for helping me make the list of supported games
8994
- BMF54123 for naming the programs
90-
- Tiiffi for misc. Mac OS X build fixes
95+
- Tiiffi and Anthony J. Bentley for misc. build fixes
9196
- You for downloading (and using?) my software

0 commit comments

Comments
 (0)