Difference between revisions of "Afkhound LST injection format"

Latest revision as of 00:40, 25 March 2014

For installing mods using this format, you can jump straight to #Darkhound's lst_insert.exe.

Introduction

The Afkhound LST injection format is a macro specification for injecting information into LST files for several Illusion games. Originally developed for Sexy Beach 3, it continues to be used for School Mate and Artificial Girl 3. It was originally proposed by Afker, and later revised by Darkhound.

There is currently no version number for this specification format.

The specification

The specification assumes the location of all LST files to be modified is implicitly understood (possibly specified via an .ini file).

• For the base Sexy Beach 3, the LST files are stored in "(Sexy Beach 3 installation path)\data\sb3_0000.pp"
• For Sexy Beach 3 with Character Add-on disc installed, the LST files are stored in "(Sexy Beach 3 installation path)\data\sb3x_1000.pp"
• For School Mate, the LST files are stored in "(School Mate installation path)\data\sm_01_00.pp"

If you are using a tool, make sure to read the tool's readme on how it handles this assumption.

The specification should be stored in a tab-deliminated text file, with the following elements in each line:

• The .lst file to be edited
• The actual line number to edit within the .lst file (start counting from 0)
• The "column" within the .lst file to start replacement (start counting from 0)
• The values to replace with (tab-deliminated, for as many values as specified, leaving unchanged all the values before the specified column & after the specified number of values )
  • Example: to change value 5 and 7, but not value 6, two tabs have to be insterted behind one another in the mod file

Tools

Darkhound's lst_insert.exe

• Description: This tool injects data into LST files according to the format.
• Current version: 0.5c (available here)
• Notes for SB3 Character Add-on expansion: In order for this tool to work with the expansion, the .ini file needs to be manually edited, so that the value for the entry "sb3_0000" is changed from "(Sexy Beach 3 installation path)\data\sb3_0000\" to "(Sexy Beach 3 installation path)\data\sb3x_1000\", and make sure you have unpacked sb3x_1000.pp using IluPack.exe first. Future versions may auto-detect the installation of expansion and avoid the need for manually adjusting the setting.

• For School Mate, make sure the full path of the folder is specified (and have the "\" at the end).

Darkhound's lst_compare.exe

• Description: This tool creates a text file in the Afkhound LST injection format, by comparing an input LST file with the "base" LST file of the same name whose location is specified by the ini file.
• Current version: 0.3 (Available here)
• Notes for SB3 Character Add-on expansion: same as lst_insert.exe above.

• For School Mate, make sure the full path of the folder is specified (and have the "\" at the end).