Useful Command-line Parameters

E02 supports several Command-Line options that affect the startup of the program. A launcher program ("launch.exe") is included for for Windows systems, which automatically sends some of these Command-Line parameters based on the settings used.

A DOS program will only accept up to 10 parameters, so to avoid this limitation, the "macro.txt" file must be used. To use "macro.txt" to pass long Command-Lines to the DOS version, first, create the file, and then place inside of it the complete Command-Line, as it would be typed at the prompt. It must end with both a space and an enter keypress to be parsed properly. To start the program using "macro.txt", use the following string:

E02DOS -macro

(The above does not apply to other versions.)

In any of the given examples, "E02DOS" may be replaced with the appropriate filename to run other versions.

Parameters that pertain strictly to the Level Ripper are listed separately. Some of the Parameters listed below may also be used in conjunction with the Level Ripper parameters to move directly into an editing situation instead of letting the program exit when ripping is finished, and restarting it manually.

A complete listing of non-Level Ripper Command-Line options is as follows:

• -game
  
  This parameter will start the specified game. It must be accompanied by the name of the game's "Game Listing File".
  
  The name itself is all that is necesary, do not include the full path. The ".gdf" extension is optional, it doesn't have to be included.
  
  
  E02DOS -game gdffile
  
  E02DOS -game default.gdf
  
  E02DOS -game default
  
  
  
• -warp
  
  (Not available for "packed" games)
  
  This parameter will cause the game to start on a different "level", with different startup player characters, and on any of the available "Screen Modes" (0 - Normal, 2 - Split-Screen). It must be accompanied by the Zone and Act IDs of the desired level, the player character IDs of the desired characters (255 for player 2 will disable it), and the desired gameplay mode.
  
  Bear in mind that it is entirely possible that some of these settings will be overridden by any Script Function that runs once the program starts.
  
  
  E02DOS -warp zoneID actID player1ID player2ID playtype
  
  E02DOS -warp 0 0 0 255 0
  
  
  
• -vmode
  
  This parameter allows for selecting one of the DOS version's alternate display modes:
  
  0 - Standard 320x200. This mode has the fastest performance, although art is "stretched" vertically due to the aspect ratio, and 24 lines are cut from the bottom.
  
  1 - Emulated 320x224 via 640x480 Post-Stretch. This mode uses a 640x480 video mode to simulate a 320x224 mode by letting the buffer renderer stretch the screen after it is drawn.
  
  2 - Emulated 320x224 via 640x480 Post-Stretch With "Scanlines". This mode uses a 640x480 video mode to simulate a 320x224 mode by letting the buffer renderer stretch the screen after it is drawn, skipping every other row to save time. This mode is faster than mode 1.
  
  3 - Emulated 320x224 via 640x480 Pre-Stretch (Default). This mode uses a 640x480 video mode to simulate a 320x224 mode by stretching the art in-RAM before drawing to the buffer, and rendering the buffer to the screen by duplicating each horizontal pixel line. In most cases, this is faster than modes 1 and 2.
  
  4 - Emulated 320x224 via 640x480 Pre-Stretch With "Scanlines". This mode uses a 640x480 video mode to simulate a 320x224 mode by stretching the art in-RAM before drawing to the buffer, and inserting a blank horizontal line between each horizontal line copied to the screen from the buffer. This mode is faster than mode 3, and in most cases, is also faster than modes 1 and 2.
  
  
  E02DOS -vmode new_mode
  
  E02DOS -vmode 0
  
  
  
• -editor
  
  (Not available for "packed" games)
  
  This parameter will send the program directly into the Level Editor as soon as the game and level are loaded. It would generally be used in conjunction with the "-warp" and/or "-game" parameters to edit a specific level of a specific game.
  
  
  E02DOS -warp zoneID actID player1ID player2ID playtype -editor
  
  E02DOS -warp 0 0 0 255 0 -editor
  
  
  
• -editfiles
  
  This parameter will start the program in non-gameplay mode, entering the Level Editor immediately after loading the given files. The Object Editor, the Sprite Editor, and gameplay will not be available in this mode, so the files do not have to be in a game set. The parameter must be accompanied by the name of the tile and level files that should be loaded.
  
  
  E02DOS -editfiles tilefile levelfile
  
  E02DOS -editfiles rip.til rip.lev
  
  
  
• -paldump
  
  This parameter will load an image file and dump the requested part of its palette into a text file in the format of a "Func_Set_Palette_Range" Script Command, ready for copying into any Function that needs to manipulate the palette.
  
  The dump can produce either "DOS" colors (5-bit values, 0-63) or "Windows" colors (8-bit values, 0-255) by using the "D" and "W" mode switches
  
  
  E02DOS -paldump picfilename startindex endindex mode
  
  E02DOS -paldump image.pcx 0 63 D
  
  
  
• -palshift
  
  This parameter will load an image file and shift a section of its palette so that it starts at a different index, correcting the image itself to reference the colors from their new positions. Output is saved to "sh000000.tga"
  
  
  E02DOS -palshift picfilename startindex endindex offset
  
  E02DOS -palshift image.pcx 64 127 -64
  
  
  
• -pack
  
  This parameter will "pack" the files in the given folder into an encrypted "game.e02" file, which may be used instead of raw game folder files, and will protect the game from modification and cheating by not only obfuscating the data, but also disabling editors, the warp command, and debugging hotkeys. This file will be automatically placed into the given folder, and will take precedence over the individual files that were used to build it
  
  
  E02DOS -pack gamefolder
  
  E02DOS -pack example