Sonic the Hedgehog Rev 0 ROMulan Package

Sonic the Hedgehog Rev 0 ROMulan Package

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

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

Tile Paging and Shared Level Data
Animated Tiles and Palettes
Loops and Crossing Paths
Spin Tunnels
Level Boundaries
Labyrinth Zone Current Tunnels
Fixed and Dynamic Water Heights
Boss Arenas

Special Options

Level Music Playlist
Level Boundaries
Loop and Spin Tunnel Chunk IDs
Starting Level and Level Progression Order
Cheat Codes

Level TitleCard Names

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 0 of "Sonic the Hedgehog" and give it the filename "sonic.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.

/Project - This is the primary folder containing Object Listing Files and a full set of SonED2 Standard Level and Sonic 1 Special Stage Project Files for Sonic the Hedgehog, 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 and Sonic 1 Special Stage Editors

s1obj.lst	-	Object Listing File, which defines Object descriptions, setting data, and in-editor graphic displays
s1obj1.pcx	-	Graphic file containing some of the global Object graphics
s1obj2.pcx	-	Graphic file containing some of the Object graphics for Green Hill Zone
s1obj3.pcx	-	Graphic file containing some of the Object graphics for Marble Zone
s1obj4.pcx	-	Graphic file containing more Object graphics for Marble Zone
s1obj5.pcx	-	Graphic file containing some of the Object graphics for Spring Yard Zone
ssobj.lst	-	Sonic 1 Special Stage Object Listing File, which defines Map "Object" descriptions and in-editor graphic displays
ssobj1.pcx	-	Graphic file containing the Sonic 1 Special Stage Map "Object" graphics

end.sep	-	Ending GHZ Scene (Good)
end2.sep	-	Ending GHZ Scene (Bad)
fz.sep	-	Final Zone
ghz1.sep	-	Green Hill Zone Act 1
ghz2.sep	-	Green Hill Zone Act 2
ghz3.sep	-	Green Hill Zone Act 3
lz1.sep	-	Labyrinth Zone Act 1
lz2.sep	-	Labyrinth Zone Act 2
lz3.sep	-	Labyrinth Zone Act 3
mz1.sep	-	Marble Zone Act 1
mz2.sep	-	Marble Zone Act 2
mz3.sep	-	Marble Zone Act 3
sbz1.sep	-	Scrap Brain Zone Act 1
sbz2.sep	-	Scrap Brain Zone Act 2
sbz3.sep	-	Scrap Brain Zone Act 3
slz1.sep	-	Star Light Zone Act 1
slz2.sep	-	Star Light Zone Act 2
slz3.sep	-	Star Light Zone Act 3
ss1.sep	-	Special Stage 1
ss2.sep	-	Special Stage 2
ss3.sep	-	Special Stage 3
ss4.sep	-	Special Stage 4
ss5.sep	-	Special Stage 5
ss6.sep	-	Special Stage 6
syz1.sep	-	Spring Yard Zone Act 1
syz2.sep	-	Spring Yard Zone Act 2
syz3.sep	-	Spring Yard Zone Act 3

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

Game Notes

Tile Paging and Shared Level Data

Animated Tiles and Palettes

Loops and Crossing Paths

This game uses a one-path collision system, meaning that Chunks within the level layout must be actively changed during gameplay to accomplish Loops. Other crossing path types are not supported by this game's specific implementation.

Each Zone in this game can be given two Chunk IDs to define as "Loops". These Chunks must be followed immediately by a visibly-identical copy, with the original having solidity filled in on the right half, and the copy having solidity filled in on the left half (For example, if Chunks 4 and 8 are "Loop" Chunks, they must be made solid on the right side, and must also have copies in Chunks 5 and 9, made solid on the left side). The original and copy are swapped back and forth in-game depending on which side the player is moving toward them from.

When placing these Chunks into the Level Layout, they must be "flagged". This can be accomplished in SonED2 by hovering over the Chunk within the Level Layout and pressing spacebar. The Status view will then add the word "(Loop)" to the displayed Chunk ID. When "grabbing" a Chunk from the layout that has already been "flagged", drawing that Chunk to the layout will automatically draw it as "flagged".

If the Chunk IDs for "Loops" in a modified level are not the same as the IDs used in the unmodified level, the "

Loop and Spin Tunnel Chunk IDs

inopts.txt

Spin Tunnels

Each Zone in this game can be given two Chunk IDs to define as "Spin Tunnels". These Chunks will force the player to spin, and apply rightward velocity if he decelerates to 0 while still in collision with the Chunk.

If the Chunk IDs for "Spin Tunnels" in a modified level are not the same as the IDs used in the unmodified level, the "

Loop and Spin Tunnel Chunk IDs

inopts.txt

Level Boundaries

Upper and lower Level Boundaries (the area within which the screen is allowed to scroll across the level during gameplay) are dynamically changed during gameplay in many cases, however, the leftmost and rightmost boundaries are not.

Initial (and persistent) horizontal level start and end settings for each level can be changed by modifying the "

Level Size Array

inopts.txt

Labyrinth Zone Current Tunnels

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

Secondary Music Playlist

inopts.txt

Note: The "Secondary Music Playlist" does not and should not contain a "Final Zone" entry.

Level Boundaries

Level Size Array

inopts.txt

WORD	4, XStart, XEnd, YStart, YEnd, $60

4	-	This entry is unused, but required


XStart	-	The leftmost world position that the screen is allowed to scroll to within the level. This value is only overridden by Boss Arenas.


XEnd	-	The rightmost world position that the screen is allowed to scroll to within the level. This value is only overridden by Boss Arenas.


YStart	-	The uppermost world position that the screen is allowed to scroll to within the level. This value is generally overridden throughout gameplay by dynamic screen relocation.


YEnd	-	The lowermost world position that the screen is allowed to scroll to within the level. This value is generally overridden throughout gameplay by dynamic screen relocation.


$60	-	This entry is unused, but required

Level Y Looping

YLoop

YStart

Loop and Spin Tunnel Chunk IDs

inopts.txt

	BYTE Loop1+LoopFlag, Loop2+LoopFlag, Tunnel1, Tunnel2

Loop1	-	The ID number of a Chunk to define as a "Loop". This can only be a standard Loop, not a "P"-shaped Loop.


Loop2	-	The ID number of a Chunk to define as a "Loop". This can be a standard loop, or a "P"-shaped Loop (as seen in Star Light Zone).


Tunnel1	-	This is the ID number of a Chunk to define as a "Spin Tunnel".


Tunnel2	-	This is the ID number of a Chunk to define as a "Spin Tunnel".

LoopFlag

must

NoLoop

NoTunnel

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

Input State Bits

, Code_End, Code_End2

Input_Invalid

Level TitleCard Names

TCardMapData

incard.txt

BYTE

BYTE	YOff, MWidth?? + MHeight??, 0, TCTilePos_?, XOff

YOff	-	The Y offset from the TitleCard's position at which this letter should be placed. Generally, this should remain "$F8".


MWidth?? + MHeight??	-	Add together the names of the Width and Height "Defines" that describe the pixel size of the desired letter.


0	-	This value should remain "0".


TCTilePos_?	-	The name of the "Define" that corresponds with the desired letter.


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

XOff