Making a mod package: Difference between revisions

4. If you have [[OniSplit|.oni]] files in your mod, you make a folder named "oni" inside your package folder. If you have [[BSL|.bsl]] files, make a folder named "bsl". If you have [[Making a patch mod|XML patches]] (.oni-patch files), make a folder named "patches". If you have other kinds of files, place them in a folder called "plain" and then a subfolder with the name of a folder under the AE/ directory for the files to be copied into (this is generally only done by tool packages, not mods). See section "Folder structure" under the [[#Mods|Mods]] or [[#Tools|Tools]] section for an illustration of the required hierarchy.

6. If your mod alters data which the AE globalizes into level0_Final, make a "level0_Final" folder inside oni/ or patches/. For every level that your mod uses, make a "levelX_Final" (e.g. "level1_Final") folder inside oni/ or patches/. However, a BSL mod uses the names of the IGMD subfolder(s) that the script(s) will go into, e.g. a script that is meant for Chapter 1 goes in bsl/EnvWarehouse/. If you include a subfolder in oni/ that does not exist in AE Oni's GameDataFolder, or a subfolder in bsl/ that does not exist in AE Oni's GameDataFolder/IMGD/, the folder will be created, thus allowing a mod to add a a new level.

7. Put the appropriate types of files inside their respective levelX_Final/ directories. Check the section "Folder structure" again to make sure you did it right! Zip up the package. Make sure you use a zip program that preserves the executable bit when packaging a tool. The name of the zip file does not matter to the AEI; after it downloads and expands the .zip on the user's computer, it will title the expanded folder using the text you entered in the "Mod name" field when uploading the mod to the {{OMD}}.

====Mod_Info.cfg====

*Tools can now be placed in packages and installed like mods.

*.oni files which can be exported to XML can now have individual data fields altered using scripts, in order to allow multiple mods to affect the same files.

*A single package can now support both platforms at once (using "common", "mac_only" and "win_only" sub-directories).

: The "public" name of the mod. This should be more or less identical to whatever you entered in the "Mod name" field when uploading this mod to the Depot '''*'''.

: Package numbers of mods which this mod will not work with if they are installed at the same time. Multiple entries separated by ",".

: Package numbers of mods that this mod requires in order to function. Multiple entries separated by ",".

: If the mod adds a new level, this flag allows you to unlock that level in [[persist.dat]] so the player can access it on the Load Game screen. Multiple level numbers can be given separated by ",". Note that an [[ONLD]] for a new level must be supplied by the mod, or else it won't be displayed in the Load Game dialog.

====Folder structure====

Compared to the folder structure of AEI 1.1 packages, AEI 2.0 packages have one additional level of folders to allow one mod package to separate files by platform. Note that, for mods, the "plain/" directory can only contain a GameDataFolder/ subfolder; mods are not allowed to place files outside this directory.

Folders without content can be left out, so a basic mod that only modifies level 0 and only works on Macs will look like this:

===Tools===

====Mod_Info.cfg====

: Path to the executable file if it should be added to the Tools menu of the AEI. Probably mostly useful for GUI-based tools. Do not forget to add the path to the file in relation to the AE/ folder.

: Type of the executable. Important if the executable has to be run by a specific interpreter like .NET. Allowed values are:

:: ''WinExe'' - Normal Windows executable (.exe); only supported for Windows-only packages (the AEI assumes this is the type if ''ExeName'' ends in ".exe" and ''ExeType'' is not given as ''DotNet'')

:: ''DotNet'' - .NET binary, executed by the .NET Framework on Windows and by Mono in Mac OS X and Linux

: Specify the working directory for the executable specified by ''ExeName''. Allowed values are:

====Folder structure====

The folder "plain/" is for files that are not game data or BSL, such as executables, text files, etc. Files/folders within "plain/[platform]/" are relative to the base folder of the AE, so this example would put the file in "AE/Tools/OniSplit.exe" on both platforms. Note that while "plain/" can be used for mod packages too, only files placed in a subfolder called GameDataFolder/ will actually be moved to that location, as mods are not allowed to install files outside that directory.