Making a mod package: Difference between revisions

no edit summary
(Depends/Conflicts)
No edit summary
Line 3: Line 3:
== Package format 2.0 ==
== Package format 2.0 ==


=== Mod_Info.cfg ===
=== Mods ===
 
==== Mod_Info.cfg ====
  AEInstallVersion ->  2.0
  AEInstallVersion ->  2.0
  NameOfMod -> Improved Weapons
  NameOfMod -> Improved Weapons
Line 39: Line 41:




=== Folder structure ===
==== Folder structure ====
Compared to the folder structure of AEI1.1-packages AEI2 packages have one additional level of folders within the /oni and /bsl folder to allow for one mod-package to support both platforms. So if a mod contains sounds for PC and MacOS you just put the OS-dependent files within the appropriate folder in either win_only or mac_only.
Compared to the folder structure of AEI1.1-packages AEI2 packages have one additional level of folders within the /oni and /bsl folder to allow for one mod-package to support both platforms. So if a mod contains sounds for PC and MacOS you just put the OS-dependent files within the appropriate folder in either win_only or mac_only.


Line 64: Line 66:
             / tctf_ii
             / tctf_ii
                 / ...
                 / ...
    / plain
        / common
            / Tools
                / Onisplit.exe
        / win_only
        / mac_only


Folders without content can be left out, so a basic mod with only level0-.oni-files without different files for Win vs MacOS will look like this:
Folders without content can be left out, so a basic mod with only level0-.oni-files without different files for Win vs MacOS will look like this:
Line 79: Line 75:
                 / myFile.oni
                 / myFile.oni


The additional folder ''/plain'' is for files not related to mods. This way you can also package tools and have them installable through the AEI2. Files/folders within "plain/$platform/" are relative to the base folder of the Edition, so the example would put the file in "$VanillaOni/Edition/Tools/Onisplit.exe" on both platforms.
 
=== Tools ===
 
==== Mod_Info.cfg ====
AEInstallVersion ->  2.0
NameOfMod -> Onisplit
Creator -> Neo
ModVersion -> 0.9.77.0
Readme -> Management of Oni's .dat files
 
Explanation of fields in the Config: (Entries marked with an asterisk ('''*''') are only used if the mod is not yet listed on the depot)
 
; '''AEInstallVersion'''
: What version of the Installer is needed to read this package.
 
; '''NameOfMod'''
: The "public" name of the mod. It can be anything you like, but should be written in an easily understandable manner '''*'''.
 
; '''ModVersion'''
: The version of the mod '''*'''.
 
; '''Creator'''
: The name(s) that you want to get credit for the mod '''*'''.
 
; '''Readme'''
: The read-me text. You can make linebreaks by using " \n " '''*'''.
 
==== Folder structure ====
 
00000OniSplit(.zip)
    / Mod_Info.cfg
    / plain
        / common
            / Tools
                / Onisplit.exe
        / win_only
        / mac_only
 
The folder ''/plain'' is for files not related to mods. Files/folders within "plain/$platform/" are relative to the base folder of the Edition, so the example would put the file in "$VanillaOni/Edition/Tools/Onisplit.exe" on both platforms.


== Package format 1.1 ==
== Package format 1.1 ==