Knuckles' Chaotix JU/(5) ROMulan Package

Knuckles' Chaotix JU/(5) ROMulan Package

The files contained herein are for use with ROMulan and SonED2, to provide a means of editing the levels of the Japanese/USA-region (region code "5") release of Knuckles' Chaotix.

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, Crossing Paths, and Plane Priority
Level Boundaries
Dynamic Level Changes
Boss Arenas
Emulator Compatibility with Modified Game

Special Options

Level Music Playlist
Cheat Codes

Setup and Basic Usage

This script set is "non-destructive". This means that the input game file will never need to be restored, as the Injection process never modifies it. 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 the Japanese/USA-region (code "5") release of Knuckles' Chaotix and give it the filename "kc.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)

Be aware that modifying some levels' Tilesets will effectively modify the tilesets of certain other levels, but not all levels within the same zone. See the "Game Notes" section for more information.

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 "injmain.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.

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 Project Files for Knuckles' Chaotix, based on the data created by "split.txt"

/AAZ - A full set of Project Files for "Amazing Arena"

1D.sep	-	Amazing Arena Act 1 Day
1M.sep	-	Amazing Arena Act 1 Morning
1N.sep	-	Amazing Arena Act 1 Night
1S.sep	-	Amazing Arena Act 1 Sunset
2D.sep	-	Amazing Arena Act 2 Day
2M.sep	-	Amazing Arena Act 2 Morning
2N.sep	-	Amazing Arena Act 2 Night
2S.sep	-	Amazing Arena Act 2 Sunset
3D.sep	-	Amazing Arena Act 3 Day
3M.sep	-	Amazing Arena Act 3 Morning
3N.sep	-	Amazing Arena Act 3 Night
3S.sep	-	Amazing Arena Act 3 Sunset
4D.sep	-	Amazing Arena Act 4 Day
4M.sep	-	Amazing Arena Act 4 Morning
4N.sep	-	Amazing Arena Act 4 Night
4S.sep	-	Amazing Arena Act 4 Sunset
5D.sep	-	Amazing Arena Act 5 Day
5M.sep	-	Amazing Arena Act 5 Morning
5N.sep	-	Amazing Arena Act 5 Night
5S.sep	-	Amazing Arena Act 5 Sunset

/BBZ - A full set of Project Files for "Botanic Base"

1D.sep	-	Botanic Base Act 1 Day
1M.sep	-	Botanic Base Act 1 Morning
1N.sep	-	Botanic Base Act 1 Night
1S.sep	-	Botanic Base Act 1 Sunset
2D.sep	-	Botanic Base Act 2 Day
2M.sep	-	Botanic Base Act 2 Morning
2N.sep	-	Botanic Base Act 2 Night
2S.sep	-	Botanic Base Act 2 Sunset
3D.sep	-	Botanic Base Act 3 Day
3M.sep	-	Botanic Base Act 3 Morning
3N.sep	-	Botanic Base Act 3 Night
3S.sep	-	Botanic Base Act 3 Sunset
4D.sep	-	Botanic Base Act 4 Day
4M.sep	-	Botanic Base Act 4 Morning
4N.sep	-	Botanic Base Act 4 Night
4S.sep	-	Botanic Base Act 4 Sunset
5D.sep	-	Botanic Base Act 5 Day
5M.sep	-	Botanic Base Act 5 Morning
5N.sep	-	Botanic Base Act 5 Night
5S.sep	-	Botanic Base Act 5 Sunset

/Entrance - A full set of Project Files for "World Entrance"

/Intro - A full set of Project Files for the introductory levels

1D.sep	-	Intro Cutscene Level and Intro Level 1 Day
1M.sep	-	Intro Cutscene Level and Intro Level 1 Morning
1N.sep	-	Intro Cutscene Level and Intro Level 1 Night
1S.sep	-	Intro Cutscene Level and Intro Level 1 Sunset
2D.sep	-	Intro Level 2 Day
2M.sep	-	Intro Level 2 Morning
2N.sep	-	Intro Level 2 Night
2S.sep	-	Intro Level 2 Sunset
3D.sep	-	Intro Level 3 Day
3M.sep	-	Intro Level 3 Morning
3N.sep	-	Intro Level 3 Night
3S.sep	-	Intro Level 3 Sunset
4D.sep	-	Intro Level 4 Day
4M.sep	-	Intro Level 4 Morning
4N.sep	-	Intro Level 4 Night
4S.sep	-	Intro Level 4 Sunset
5D.sep	-	Intro Level 5 Day
5M.sep	-	Intro Level 5 Morning
5N.sep	-	Intro Level 5 Night
5S.sep	-	Intro Level 5 Sunset

/MMZ - A full set of Project Files for "Marina Madness"

1D.sep	-	Marina Madness Act 1 Day
1M.sep	-	Marina Madness Act 1 Morning
1N.sep	-	Marina Madness Act 1 Night
1S.sep	-	Marina Madness Act 1 Sunset
2D.sep	-	Marina Madness Act 2 Day
2M.sep	-	Marina Madness Act 2 Morning
2N.sep	-	Marina Madness Act 2 Night
2S.sep	-	Marina Madness Act 2 Sunset
3D.sep	-	Marina Madness Act 3 Day
3M.sep	-	Marina Madness Act 3 Morning
3N.sep	-	Marina Madness Act 3 Night
3S.sep	-	Marina Madness Act 3 Sunset
4D.sep	-	Marina Madness Act 4 Day
4M.sep	-	Marina Madness Act 4 Morning
4N.sep	-	Marina Madness Act 4 Night
4S.sep	-	Marina Madness Act 4 Sunset
5D.sep	-	Marina Madness Act 5 Day
5M.sep	-	Marina Madness Act 5 Morning
5N.sep	-	Marina Madness Act 5 Night
5S.sep	-	Marina Madness Act 5 Sunset

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

kcobj.lst	-	Object Listing File, which defines Object descriptions, setting data, and in-editor graphic displays
kcobj1.pcx	-	Graphic file containing some of the global Object graphics

/SSZ - A full set of Project Files for "Speed Slider"

1D.sep	-	Speed Slider Act 1 Day
1M.sep	-	Speed Slider Act 1 Morning
1N.sep	-	Speed Slider Act 1 Night
1S.sep	-	Speed Slider Act 1 Sunset
2D.sep	-	Speed Slider Act 2 Day
2M.sep	-	Speed Slider Act 2 Morning
2N.sep	-	Speed Slider Act 2 Night
2S.sep	-	Speed Slider Act 2 Sunset
3D.sep	-	Speed Slider Act 3 Day
3M.sep	-	Speed Slider Act 3 Morning
3N.sep	-	Speed Slider Act 3 Night
3S.sep	-	Speed Slider Act 3 Sunset
4D.sep	-	Speed Slider Act 4 Day
4M.sep	-	Speed Slider Act 4 Morning
4N.sep	-	Speed Slider Act 4 Night
4S.sep	-	Speed Slider Act 4 Sunset
5D.sep	-	Speed Slider Act 5 Day
5M.sep	-	Speed Slider Act 5 Morning
5N.sep	-	Speed Slider Act 5 Night
5S.sep	-	Speed Slider Act 5 Sunset
BossD.sep	-	Speed Slider Boss Area Day
BossM.sep	-	Speed Slider Boss Area Morning
BossN.sep	-	Speed Slider Boss Area Night
BossS.sep	-	Speed Slider Boss Area Sunset

/Training - A full set of Project Files for the Training Levels

1D.sep	-	Training Level 1 Day
1M.sep	-	Training Level 1 Morning
1N.sep	-	Training Level 1 Night
1S.sep	-	Training Level 1 Sunset
2D.sep	-	Training Level 2 Day
2M.sep	-	Training Level 2 Morning
2N.sep	-	Training Level 2 Night
2S.sep	-	Training Level 2 Sunset
3D.sep	-	Training Level 3 Day
3M.sep	-	Training Level 3 Morning
3N.sep	-	Training Level 3 Night
3S.sep	-	Training Level 3 Sunset
4D.sep	-	Training Level 4 Day
4M.sep	-	Training Level 4 Morning
4N.sep	-	Training Level 4 Night
4S.sep	-	Training Level 4 Sunset

/TTZ - A full set of Project Files for "Techno Tower"

1D.sep	-	Techno Tower Act 1 Day
1M.sep	-	Techno Tower Act 1 Morning
1N.sep	-	Techno Tower Act 1 Night
1S.sep	-	Techno Tower Act 1 Sunset
2D.sep	-	Techno Tower Act 2 Day
2M.sep	-	Techno Tower Act 2 Morning
2N.sep	-	Techno Tower Act 2 Night
2S.sep	-	Techno Tower Act 2 Sunset
3D.sep	-	Techno Tower Act 3 Day
3M.sep	-	Techno Tower Act 3 Morning
3N.sep	-	Techno Tower Act 3 Night
3S.sep	-	Techno Tower Act 3 Sunset
4D.sep	-	Techno Tower Act 4 Day
4M.sep	-	Techno Tower Act 4 Morning
4N.sep	-	Techno Tower Act 4 Night
4S.sep	-	Techno Tower Act 4 Sunset
5D.sep	-	Techno Tower Act 5 Day
5M.sep	-	Techno Tower Act 5 Morning
5N.sep	-	Techno Tower Act 5 Night
5S.sep	-	Techno Tower Act 5 Sunset
BossD.sep	-	Techno Tower Boss Area Day
BossM.sep	-	Techno Tower Boss Area Morning
BossN.sep	-	Techno Tower Boss Area Night
BossS.sep	-	Techno Tower Boss Area Sunset

/Tutorial - A full set of Project Files for the Tutorial Levels

1.sep	-	Tutorial Level 1
2.sep	-	Tutorial Level 2
3.sep	-	Tutorial Level 3
4.sep	-	Tutorial Level 4
5.sep	-	Tutorial Level 5
6.sep	-	Tutorial Level 6
7.sep	-	Tutorial Level 7

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


inject.txt	-	This is the "Batch File" that is used to perform input data conversions and initiate Injection.


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


posfix.exe	-	This program is used to convert Chaotix initial screen position data into proper Player Start Locations for use with SonED2.


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


objyadj.txt	-	This program is used to adjust the Y positions in Object Layout Data for y-looping levels so that Objects are placed within the normal level area and may be used properly with SonED2

Game Notes

Tile Paging and Shared Level Data

Project Files
- Acts number 0, 1, 2, 3, 4, 5, and 6
- Times of day are in order of "M", "D", "S", and "N"
  
  As an example, the name "15MN.bin" means that this data is used in acts spanning 1 through 5, and times of day spanning Morning through Night.

Injector File

"LevelTile_Ptrs" - References pointers to the 8x8 Tile Page loading data

DWORD TilesPage0
DWORD TilesPage1
DWORD 0
DWORD TilesPage2
DWORD TilesPage3
DWORD $FFFFFFFF

TilesPage?	-	The name of the label immediately preceding the 8x8 Tile data to load for the given page


0	-	Terminates loading for the "Foreground" Pages and begins loading for the "Background" Pages


$FFFFFFFF	-	Terminates the tileset

"Level_Index"- References pointers to the 16x16 Block Page, 128x128 Chunk Page, and Level Layout loading data

DWORD BlocksPage0
DWORD BlocksPage1+LastPage
DWORD BlocksPage2
DWORD BlocksPage3+LastPage
DWORD ChunksPage0
DWORD ChunksPage1+LastPage
DWORD ChunksPage2
DWORD ChunksPage3+LastPage
DWORD FGLayout
DWORD BGLayout

BlocksPage?	-	The name of the label immediately preceding the 16x16 Block data to load for the given page


ChunksPage?	-	The name of the label immediately preceding the 128x128 Chunk data to load for the given page


??Layout	-	The names of the labels immediately preceding the Foreground layout data and Background layout data, respectively

"LevSize_Data"- References pointers to the level initial camera (and Player Start) position, layout size, and scroll boundaries

include	"PlaneStart.bin"
include	"PlaneSize.bin"
WORD	X2
WORD	X1
WORD	Y2
WORD	Y1

"PlaneStart.bin"	-	The path and filename of the data file containing the initial screen start location for the level. Also serves to generate Player Start position


"PlaneSize.bin"	-	The path and filename of the data file containing the map layout dimensions for the level


X2	-	The maximum X position that the screen can scroll to within this level during gameplay


X1	-	The minimum X position that the screen can scroll to within this level during gameplay


Y2	-	The maximum Y position that the screen can scroll to within this level during gameplay


Y1	-	The minimum Y position that the screen can scroll to within this level during gameplay

"MD_Palette_Index"- References pointers to the level palette data
"Solid_Index"- References pointers to the collision index data

Animated Tiles and Palettes

Loops, Crossing Paths, and Plane Priority

Level Boundaries

LevSize_Data

Dynamic Level Changes

Boss Arenas

Emulator Compatibility with Modified Game

"Set Config..."

"Options" menu

"32x" tab

a checkbox that reads "Fast 32x Timing"

This box must be checked

This option only exists in newer Kega releases.

Special Options

Level Music Playlist

inopts.txt

Cheat Codes

inopts.txt

Code_LevelSelectDebug

Code_AmyInSoundTest

1D.sep	-	World Entrance Day
1M.sep	-	World Entrance Morning
1N.sep	-	World Entrance Night
1S.sep	-	World Entrance Sunset
EndBoss.sep	-	Final Boss