Making a mod package: Difference between revisions

Making a mod package (view source)

Revision as of 14:21, 10 January 2013

2,747 bytes added , 10 January 2013

AEI2-packages

Admin

Bureaucrats, Administrators

292

edits

@@ Line 1: / Line 1: @@
 __TOC__
+== Package format 2.0 ==
+=== Mod_Info.cfg ===
+ AEInstallVersion ->  2.0
+ NameOfMod -> Improved Weapons
+ Creator -> Geyser/Loser/Iritscen/Gumby
+ ModVersion -> 1.1
+ Conflicts -> 11000,23050
+ Depends -> 45000
+ Readme -> Improves the appearence and mechanics of existing Oni weapons. \n \n Currently contains...
+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 " '''*'''.
+; '''Conflicts'''
+: Package numbers of mods this mod will not work with at the same time. Multiple entries separated by ",".
+; '''Depends'''
+: Package numbers of mods this mod depends on to function. Multiple entries separated by ",".
+=== 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.
+ExampleMod(.zip)
+     / Mod_Info.cfg
+     / oni
+         / common
+             / level''#''_Final
+                 / ...
+         / win_only
+             / level''#''_Final
+                 / ...
+         / mac_only
+             / level''#''_Final
+                 / ...
+     / bsl
+         / common
+             / tctf_ii
+                 / ...
+         / win_only
+             / tctf_ii
+                 / ...
+         / mac_only
+             / 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:
+ / 12345ExampleMod
+     / Mod_Info.cfg
+     / oni
+         / common
+             / level0_Final
+                 / 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.
+== Package format 1.1 ==
 The Anniversary Edition comes with a set of mods in the "package" format. This new [[Anniversary Edition/Framework|framework]] also allows modders to make third-party mods that will install easily into the Edition. You can start your package by copying an existing AE package and modifying it to save time, but in any case you'll need to learn how a package is made:
@@ Line 91: / Line 170: @@
-==package numbering==
+== Package numbering ==
 Please read on '''[[Anniversary_Edition/Framework#Package_numbering|HERE]]'''.
+=== [http://mods.oni2.net/mods/Package used numbers] ===
-==[http://mods.oni2.net/mods/Package used numbers]==
 AE packages are marked with an asterisk (*).<br>Placeholders are marked with two asterisk (**).