Sonic the Hedgehog 2 Rev 1 ROMulan Package

Sonic the Hedgehog 2 Rev 1 ROMulan Package

The files contained herein are for use with ROMulan and SonED2, to provide a means of editing the levels of Revision 1 of "Sonic the Hedgehog 2".

Please visit the official forum for discussion on mods made using this package, to submit additions to the scripts, or to report any errors in the official distribution.

Setup and Basic Usage

File Listing

Game Notes

Shared Level Data and Unused Level Slots
Animated Tiles and Palettes
Loops, Crossing Paths, and Plane Priority
Spin Tunnels
Level Boundaries
Fixed and Dynamic Water Heights
Boss Arenas

Special Options

Level Music Playlist
Level Boundaries
Starting Level and Level Progression Order
Cheat Codes

Level TitleCard Names

Letter Art Loading
Name Display

Setup and Basic Usage

This script set is "non-destructive". This means that the input game files will never need to be restored, as the Injection process never modifies them. Thus, all changes are applied to a clean copy of the game, and saved to a different file. The only time any of the initial steps will need to be repeated is if the separated data files have become corrupt, in which case, the Split will need to be performed again.

One-Time Setup Steps

Unpack all files from this archive into their own folder. The full path name of this folder must not contain any spaces
Place in the same folder a copy of Revision 1 of "Sonic the Hedgehog 2" and give it the filename "sonic2.bin"
Run the included Batch File "split.txt" using ROMulan or SonED2's built-in ROMulan functionality to retrieve the game's data

Every Time Level Editing Steps

Using SonED2's "Open Project" option in the "File" menu, navigate to the "Projects" folder included with this fileset and open any of the included Project Files to edit its corresponding level
Make any changes using SonED2 as described in its own documentation
Use SonED2's "Save Project" option by selecting it in the "File" menu or pressing F3 to save the changes to their respective files (This is important as the edited data is SonED2-internal; ROMulan expects to find all necessary data in the files listed by the injector script)

Other Modifications

With the proper knowledge of the game, other changes can be made by modifying the two Batch Files and/or the Injector File "inmain.txt" as described by the ROMulan documentation. For relevant information, see the "Game Notes" section.
Some game settings are already available for modification in the Injector File "inopts.txt". See the "Special Options" section for details.
The names of the Zones as presented on the "TitleCards" may be modified through the Injector File "incard.txt". See the "Level TitleCard Names" section for details.

Every Time Finalization Steps

Run the included Batch File "inject.txt" using ROMulan or SonED2's built-in ROMulan functionality to inject the changes into the game
The file "inject.bin" will have been created and placed in the same folder as the "inject.txt" script. The process is now complete

File Listing

This section provides a complete listing of the folders and files included with this package, each with a brief description. Note that other files and folders will also appear in this folder after "split.txt" has been run, which belong to the data that was extracted from the game.

/_dlls - DLLs used by "derecmp.exe" for data compression and decompression

Enigma.dll	-	DLL used by "derecmp.exe", containing functions for compressing and decompressing data with the "Enigma" format
Kosinski.dll	-	DLL used by "derecmp.exe", containing functions for compressing and decompressing data with the "Kosinski" format
Nemesis.dll	-	DLL used by "derecmp.exe", containing functions for compressing and decompressing data with the "Nemesis" format

/Project - This is the primary folder containing Object Listing Files and a full set of SonED2 Standard Level Project Files for Sonic the Hedgehog 2, based on the data created by "split.txt"

/objdef - Object Listing Files and supporting graphics files that define the Objects used in Sonic the Hedgehog for SonED2's Object Editor

s2obj.lst	-	Object Listing File, which defines Object descriptions, setting data, and in-editor graphic displays
s2obj1.pcx	-	Graphic file containing some of the global Object graphics
s2obj10.pcx	-	Graphic file containing some of the Object graphics for Emerald Hill Zone
s2obj20.pcx	-	Graphic file containing some of the Object graphics for Aquatic Ruin Zone

00_EHZ1.sep	-	Emerald Hill Zone Act 1
00_EHZ2.sep	-	Emerald Hill Zone Act 2
01_1.sep	-	Zone 01 Act 1 (Unused)
01_2.sep	-	Zone 01 Act 2 (Unused)
02_WZ1.sep	-	Wood Zone Act 1 (Unused)
02_WZ2.sep	-	Wood Zone Act 2 (Unused)
03_1.sep	-	Zone 03 Act 1 (Unused)
03_2.sep	-	Zone 03 Act 2 (Unused)
04_MTZ1.sep	-	Metropolis Zone Act 1 (04 Act 1)
04_MTZ2.sep	-	Metropolis Zone Act 2 (04 Act 2)
05_MTZ1.sep	-	Metropolis Zone Act 3 (05 Act 1)
05_MTZ2.sep	-	Metropolis Zone Act 4 (05 Act 2 - Unused)
06_WFZ1.sep	-	Wing Fortress Zone Act 1
06_WFZ2.sep	-	Wing Fortress Zone Act 2 (Unused)
07_HTZ1.sep	-	Hill Top Zone Act 1
07_HTZ2.sep	-	Hill Top Zone Act 2
08_HPZ1.sep	-	Hidden Palace Zone Act 1 (Unused)
08_HPZ2.sep	-	Hidden Palace Zone Act 2 (Unused)
09_1.sep	-	Zone 09 Act 1 (Unused)
09_2.sep	-	Zone 09 Act 2 (Unused)
0A_OOZ1.sep	-	Oil Ocean Zone Act 1
0A_OOZ2.sep	-	Oil Ocean Zone Act 2
0B_MCZ1.sep	-	Mystic Cave Zone Act 1
0B_MCZ2.sep	-	Mystic Cave Zone Act 2
0C_CNZ1.sep	-	Casino Night Zone Act 1
0C_CNZ1_2P.sep	-	Casino Night Zone Act 1 (2P Mode Objects Layout)
0C_CNZ2.sep	-	Casino Night Zone Act 2
0C_CNZ2_2P.sep	-	Casino Night Zone Act 2 (2P Mode Objects Layout)
0D_CPZ1.sep	-	Chemical Plant Zone Act 1
0D_CPZ2.sep	-	Chemical Plant Zone Act 2
0E_DEZ1.sep	-	Death Egg Zone Act 1
0E_DEZ2.sep	-	Death Egg Zone Act 2 (Unused)
0F_ARZ1.sep	-	Aquatic Ruin Zone Act 1
0F_ARZ2.sep	-	Aquatic Ruin Zone Act 2
10_SCZ1.sep	-	Sky Chase Zone Act 1
10_SCZ2.sep	-	Sky Chase Zone Act 2 (Unused)

derecmp.exe	-	This program is used for decompressing and recompressing the Hill Top Zone and Sky Chase Zone Tilesets before and after applying their respective patches


fixheadr.exe	-	This program is used to correct the size and checksum header information after Injection


incard.txt	-	This is the "Injector File" that contains modifiable information for setting up the "Title Cards" that provide Zone names


inject.txt	-	This is the "Batch File" that is used to initiate Injection


injmain.txt	-	This is the "Injector File" that contains the information for placing the modified data back into the game file


inopts.txt	-	This is the "Injector File" that contains various modifiable options for the game


split.txt	-	This is the "Batch File" that is used to split data from the game file


tilpatch.exe	-	This program is used to create proper Tilesets for Hill Top Zone and Sky Chase Zone by applying their respective patches to the extracted data

Game Notes

Shared Level Data and Unused Level Slots

Tiles are shared between every Act of any one Zone. Modifying them for one Act will modify them for every other Act within the same Zone.

In an unmodified game, Emerald Hill Zone and Wing Fortress Zone share Tile data with Hill Top Zone and Sky Chase Zone, respectively, and are overlayed with special patch data to replace only certain Tiles. This would normally cause modifications to either Zone to appear in the other, however, this script set duplicates these Tilesets and causes each Zone to use its own. It also pre-applies the Tileset patches and disables in-game patching to allow for proper viewing and editing of the patched levels.

An unmodified game also has space allocated for 5 unused Zones, and 4 unused second acts. Normally, these levels load most of their data from existing, used levels, however, this script set duplicates the re-used data and causes these unused Zones and Acts to each use their own dataset, and also includes Project Files for modifying these levels. They may now be used to extend the game, and each of the unused Zones may be given their own set of level graphics.

The "

Next Level" array

inopts.txt

Animated Tiles and Palettes

Loops, Crossing Paths, and Plane Priority

Spin Tunnels

Level Boundaries

For the most part, Level Boundaries (the area within which the screen is allowed to scroll across the level during gameplay) are not dynamically altered in this game, meaning that the initial (and persistent) settings can be modified.

The "

Level Size Array

inopts.txt

Hill Top Zone Earthquakes

Fixed and Dynamic Water Heights

Boss Arenas

Boss events are triggered by hardcoded player position tests, and the Boss Objects themselves test for and set absolute positions within the level. This is not accounted for in the current script set version; the level positions at which the Boss is triggered and the position values used by the Boss Object for movement are not available for editing.

The level can, however, be made to end before the Boss area by decreasing the corresponding XEnd setting within the "

Level Size Array

inopts.txt

Special Options

Level Music Playlist

inopts.txt

plus $80

+ MakeMusicID

Level Boundaries

Level Size Array

inopts.txt

WORD	XStart, XEnd, YStart, YEnd

XStart	-	The leftmost world position that the screen is allowed to scroll to within the level


XEnd	-	The rightmost world position that the screen is allowed to scroll to within the level


YStart	-	The uppermost world position that the screen is allowed to scroll to within the level


YEnd	-	The lowermost world position that the screen is allowed to scroll to within the level

Level Y Looping

YLoop

YStart

Starting Level and Level Progression Order

Starting Level

inopts.txt

Zone and Act to go to when starting a new game

"Next Level" array

inopts.txt

Data Defines

Cheat Codes

inopts.txt

, Code_End

Code_Invalid

Level TitleCard Names

Letter Art Loading

Load Data

incard.txt

Letter Graphics VRAM Tile Offset Data

TCCustomStart

Name Display

TCardMapData

incard.txt

WORD

BYTE	MWidth?? + MHeight??, TCTilePos_? + MPHigh, TCTilePos_? / 2 + MPHigh, XOff

MWidth?? + MHeight??	-	Add together the names of the Width and Height "Defines" that describe the pixel size of the desired letter. A Y offset can be applied to the letter by also adding "YOff * 16 + " to the beginning of the entry, where "YOff" is the value by which to offset the letter from the Titlecard position on the Y axis. Generally, there should be no Y offset, however.


TCTilePos_? + MPHigh	-	The name of the "Define" that corresponds with the desired letter, plus the define "MPHigh" to give the letter "High" priority.


TCTilePos_? / 2 + MPHigh	-	The same as the previous entry, except that the "Define" for the letter (its VRAM position) is divided by two, for use in the split-screen mode.


XOff	-	The X offset from the TitleCard's position at which this letter should be placed.

XOff