Actions

User

Difference between revisions of "MainMemory/S2LVL INI File Setup"

From Sonic Retro

< User:MainMemory
m
m
Line 10: Line 10:
 
* ''S2'' - [[Sonic the Hedgehog 2 (16-bit)|Sonic 2]]
 
* ''S2'' - [[Sonic the Hedgehog 2 (16-bit)|Sonic 2]]
 
* ''S3K'' - [[Sonic the Hedgehog 3|Sonic 3]], [[Sonic & Knuckles]], [[Sonic 3 & Knuckles]]
 
* ''S3K'' - [[Sonic the Hedgehog 3|Sonic 3]], [[Sonic & Knuckles]], [[Sonic 3 & Knuckles]]
* ''SKC'' - [[Sonic & Knuckles Collection]]
+
* ''SKC'' - [[Sonic & Knuckles Collection]] - This setting causes SonLVL to operate in little endian mode, and should not be used when working with a [[Mega Drive]] game.
* ''SCDPC'' - [[Sonic CD]] PC
+
* ''SCDPC'' - [[Sonic CD]] PC - This setting causes SonLVL to operate in little endian mode, and should not be used when working with a [[Mega Drive]] game.
  
 
===Compression Formats===
 
===Compression Formats===

Revision as of 11:31, 3 October 2011

SonLVL uses INI files to define both the levels in a game and the objects available in the game and each level. INI files are simple text files that can be opened with a text editor such as Notepad.

Main INI

This file defines the version of the Sonic engine, the file containing object definitions for the whole game, and the levels available for editing.

Engine Versions

Whenever a setting asks for an "EngineVersion", use one of the following settings that SonLVL supports:

Compression Formats

Whenever a setting asks for a "CompressionFormat", use one of the following settings that SonLVL supports:

  • Uncompressed - The file is not compressed.
  • Nemesis - The file is Nemesis compressed.
  • Kosinski - The file is Kosinski compressed.
  • KosinskiM - The file is Kosinski Moduled compressed. Only used in S3K and SKC.
  • Enigma - The file is Enigma compressed.
  • SZDD - The file is SZDD compressed. Only used in SCDPC.

Global Settings

These settings affect all levels.

version=EngineVersion - This setting chooses the default data types used. If omitted, S2 will be used by default.
objlst=filename - Specifies an INI file with definitions for objects that are loaded in all levels, as well as Rings for S2 and S3K, and Start Position definitions.

Levels

Each level section starts with a line [Level Name Zone Act Number]. The text inside the brackets will be used as the name of the level in SonLVL. No two levels can have the same name. Backslashes will be used to create submenus in the Choose Level menu, for example, [Sonic 3\Angel Island Zone Act 1] puts the level "Angel Island Zone Act 1" in a "Sonic 3" menu.