Difference between revisions of "MainMemory/S2LVL INI File Setup"
From Sonic Retro
< User:MainMemory
MainMemory (talk | contribs) m (→Engine Versions) |
MainMemory (talk | contribs) m |
||
| Line 1: | Line 1: | ||
| − | + | 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== | ==Main INI== | ||
| Line 25: | Line 25: | ||
These settings affect all levels. | These settings affect all levels. | ||
| − | <tt>version=''EngineVersion''</tt> - This setting chooses the default data types used.<br /> | + | <tt>version=''EngineVersion''</tt> - This setting chooses the default data types used. If omitted, S2 will be used by default.<br /> |
| − | <tt>objlst=''filename''</tt> - Specifies an INI file with definitions for objects that are loaded in all levels. | + | <tt>objlst=''filename''</tt> - Specifies an INI file with definitions for objects that are loaded in all levels, as well as [[Ring]]s for S2 and S3K, and Start Position definitions. |
===Levels=== | ===Levels=== | ||
| − | Each level section starts with a line <tt><nowiki>[</nowiki>''Level Name Zone Act Number''<nowiki>]</nowiki></tt>. The text inside the brackets will be used as the name of the level in | + | Each level section starts with a line <tt><nowiki>[</nowiki>''Level Name Zone Act Number''<nowiki>]</nowiki></tt>. 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, <tt><nowiki>[Sonic 3\Angel Island Zone Act 1]</nowiki></tt> puts the level "Angel Island Zone Act 1" in a "Sonic 3" menu. |
Revision as of 11:27, 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:
- S1 - Sonic 1
- S2NA - Sonic 2 Nick Arcade
- S2 - Sonic 2
- S3K - Sonic 3, Sonic & Knuckles, Sonic 3 & Knuckles
- SKC - Sonic & Knuckles Collection
- SCDPC - Sonic CD PC
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.