All Projects → devinacker → exhal

devinacker / exhal

Licence: MIT License
Compression and decompression tools for NES, SNES, and Game Boy games by HAL Laboratory

Programming Languages

c
50402 projects - #5 most used programming language
Makefile
30231 projects

Projects that are alternatives of or similar to exhal

xkas-plus
fork of the xkas (v14) cross assembler
Stars: ✭ 20 (-62.96%)
Mutual labels:  nes, snes, romhacking, rom-hacking
MOLE
(On hiatus untill untill further notice) RetroMole Core
Stars: ✭ 20 (-62.96%)
Mutual labels:  nes, snes, romhacking, rom-hacking
Provenance
iOS & tvOS multi-emulator frontend, supporting various Atari, Bandai, NEC, Nintendo, Sega, SNK and Sony console systems… Get Started: https://wiki.provenance-emu.com |
Stars: ✭ 4,732 (+8662.96%)
Mutual labels:  gameboy, nes, snes
kale
Kirby's Adventure Level Editor (C++ / Qt)
Stars: ✭ 31 (-42.59%)
Mutual labels:  nes, romhacking, rom-hacking
Ctf Game Challenges
A curated list of Game Challenges from various CTFs
Stars: ✭ 97 (+79.63%)
Mutual labels:  gameboy, nes
Cartreader
A shield for the Arduino Mega that can back up video game cartridges.
Stars: ✭ 590 (+992.59%)
Mutual labels:  gameboy, nes
klo-gba.js
🧢 Reverse engineering tool for the Klonoa's GBA game
Stars: ✭ 124 (+129.63%)
Mutual labels:  romhacking, rom-hacking
Rom Properties
ROM Properties Page shell extension
Stars: ✭ 210 (+288.89%)
Mutual labels:  gameboy, nes
Retrograde Android
Play retro video games on your Android TV!
Stars: ✭ 114 (+111.11%)
Mutual labels:  gameboy, nes
first nes
Create your own games for the Nintendo Entertainment System! This "starter" game is easily extensible for your own projects. Includes references.
Stars: ✭ 94 (+74.07%)
Mutual labels:  nes, romhacking
Yarhl
Yet Another ROM Hacking Library
Stars: ✭ 48 (-11.11%)
Mutual labels:  romhacking, rom-hacking
tilemap-studio
A tilemap editor for Game Boy, Color, Advance, DS, and SNES projects. Written in C++ with FLTK.
Stars: ✭ 247 (+357.41%)
Mutual labels:  gameboy, snes
6502.Net
A .Net-based Cross-Assembler for Several 8-Bit Microprocessors
Stars: ✭ 44 (-18.52%)
Mutual labels:  nes, snes
Retro Go
Retro emulation for the ODROID-GO
Stars: ✭ 73 (+35.19%)
Mutual labels:  gameboy, nes
PokemonBattleEngine
A C# library that can emulate Pokémon battles.
Stars: ✭ 92 (+70.37%)
Mutual labels:  romhacking, rom-hacking
Esplay Retro Emulation
Retro Emulation Collection for ESPlay Hardware, an ESP32 based game console
Stars: ✭ 183 (+238.89%)
Mutual labels:  gameboy, nes
apultra
Free open-source compressor for apLib with 5-7% better ratios
Stars: ✭ 84 (+55.56%)
Mutual labels:  compression, gameboy
epicedit
Epic Edit, Track Editor for Super Mario Kart (SNES)
Stars: ✭ 30 (-44.44%)
Mutual labels:  snes, romhacking
awesome-emu-resources
A curated list of emulator development resources
Stars: ✭ 26 (-51.85%)
Mutual labels:  gameboy, nes
nescafe
NES emulator written in C# 🎮 ☕
Stars: ✭ 39 (-27.78%)
Mutual labels:  nes

exhal / inhal

HAL Laboratory NES/SNES/GB (de)compression tools
(version 1.21)
by Devin Acker (Revenant), 2013-2015 https://github.com/devinacker

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.

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.

The compression routine used by inhal is very fast and capable of producing output which is smaller than that of HAL's original compressor.

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!)

To use exhal (the decompressor):
exhal romfile offset outfile

To insert compressed data into a ROM:
inhal [-fast] infile romfile offset

To write compressed data to a new file:
inhal [-fast] -n infile outfile

Offsets can be specified in either hexadecimal (recommended) or decimal.

Using the -fast switch results in compression which is about 3 to 4 times faster, but with slightly larger output data. Use this if you don't care about data sizes being 100% identical to the original compressed data.

This is a list of games which are known to use the supported compression method, or are assumed to, based on a binary search of the games' ROMs:

  • Adventures of Lolo (NES/GB)
  • Adventures of Lolo 2 (NES)
  • Adventures of Lolo 3 (NES)
  • Alcahest (SNES)
  • Arcana / Card Master (SNES)
  • EarthBound / Mother 2 (SNES)
  • Ghostbusters II (GB)
  • HAL's Hole in One Golf / Jumbo Ozaki no Hole in One (SNES)
  • HyperZone (SNES)
  • Itoi Shigesato no Bass Tsuri No. 1 (SNES)
  • Kirby no KiraKira Kids (SNES)
  • Kirby Super Star (SNES)
  • Kirby's Adventure (NES)
  • Kirby's Dream Course / Kirby Bowl (SNES)
  • Kirby's Dream Land (GB)
  • Kirby's Dream Land 2 (GB)
  • Kirby's Dream Land 3 (SNES)
  • Kirby's Pinball Land (GB)
  • Kirby's Star Stacker / KiraKira Kids (GB)
  • NES Open Tournament Golf (NES)
  • New Ghostbusters II (NES)
  • Othello World (SNES)
  • Okamoto Ayako to Match Play Golf (SNES)
  • Revenge of the Gator / 66 Hiki no Wani Daikoushin (GB)
  • SimCity (SNES) [unused?]
  • SimCity 2000 (SNES)
  • Special Tee Shot (BS-X)
  • Super Famicom Box BIOS (SNES)
  • Trax / Totsugeki! Ponkotsu Tank (GB)
  • Vegas Stakes (SNES/GB)

Also note, unfortunately, that exhal cannot automatically detect or locate compressed data. The included file "gamenotes.txt" contains an incomplete list of decompression routine addresses to make searching easier.

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)

Contact me

Special thanks to

  • andlabs for helping me make the list of supported games
  • BMF54123 for naming the programs
  • Tiiffi and Anthony J. Bentley for misc. build fixes
  • You for downloading (and using?) my software
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].