Making a mod package: Difference between revisions

From OniGalore
Jump to navigation Jump to search
(Tools -> ExeType)
 
(33 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__TOC__
The [[Anniversary Edition]] installs mods that are made in a certain format -- the mod files must be placed in a specified hierarchy of folders with a text file that provides additional information. This arrangement of folders and files is simply called the '''mod package''' format.


== Package format 2.0 ==
==Package format 2.0==
The [[AEI]] 2 prefers the new 2.0 package format, but will also read 1.1 packages.


=== Mods ===
You can start your package by copying an existing AE package and modifying it to save time. To create a new mod package from scratch, use [[Vago (tool)|Vago's]] package wizard or follow these [[seven]] easy steps:


==== Mod_Info.cfg ====
1. Create a new folder with a name corresponding to your mod.
  AEInstallVersion -> 2.0
----
2. Pick a number for your mod. The five digit number corresponds to where in the load order your mod will be, but it also indicates the type of mod. Please leave some numeric space between your mod and other AE mods. See the [[#Package numbering|numbering section below]] to know how to number your mod.
----
3. Create a plain-text file named "Mod_Info.cfg" inside your new folder.  See section "Mod_Info.cfg" under the [[#Mods|Mods]] or [[#Tools|Tools]] section to learn what to put in the config file for that kind of package.
----
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.
----
5. Make a folder called "common" inside the oni/, bsl/, patches/ or plain/ folder for files which will work both in Windows and on Intel Macs. Make a folder called "win_only" or "mac_only" if you have files intended for only one platform or if certain files need to be in one format for Windows and one for macOS (such as sounds).
----
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}}.
 
'''Special note''': Be very careful when replacing (not adding) M3GM, TRAC and OBAN. With TRAC, you must include all of the child TRACs of the TRAC you are adding. With M3GM, you must also include the file that references the M3GM. With OBANs, you need to include the AKEV that links to them. There may be other file types that need their parents or children included.
 
===Mods===
====Mod_Info.cfg====
  AEInstallVersion -> 2.0
  NameOfMod -> Improved Weapons
  NameOfMod -> Improved Weapons
  Creator -> Geyser/Loser/Iritscen/Gumby
  Creator -> Geyser, Loser, Iritscen, Gumby
  ModVersion -> 1.1
  ModVersion -> 1.1
  IncompatibleWith -> 11000,23050
  IncompatibleWith -> 11100,23050
  DependsOn -> 45000
  DependsOn -> 45000
  UnlockLevel -> 25
  UnlockLevel -> 25
  Readme -> Improves the appearence and mechanics of existing Oni weapons. \n \n Currently contains...
  Readme -> Improves the appearance 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)
;Explanation of fields
Entries marked with an asterisk ('''*''') are only used if the mod is not yet listed on the Mod Depot. Otherwise, the AEI will display the versions of those fields that are found on the Depot's node for that mod.


; '''AEInstallVersion'''
; '''AEInstallVersion'''
: What version of the Installer is needed to read this package.
: What version of the Installer is needed to read this package. Here are the functional package-handling differences between 2.0 and 1.1 packages:
*The BSL -> Addon flag is now respected properly.
*DependsOn and IncompatibleWith flags added for mod interoperability.
*Tools can now be placed in packages and installed like mods.
*.oni files which can be exported to XML can now have individual elements altered using patch files or scripts, in order to allow multiple mods to affect the same resources.
*A single package can now support both platforms at once (using "common", "mac_only" and "win_only" sub-directories).


; '''NameOfMod'''
; '''NameOfMod'''
: The "public" name of the mod. It can be anything you like, but should be written in an easily understandable manner '''*'''.
: 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 '''*'''.


; '''ModVersion'''
; '''ModVersion'''
Line 30: Line 54:


; '''Readme'''
; '''Readme'''
: The read-me text. You can make linebreaks by using " \n " '''*'''.
: The read-me text. You can make line breaks by using " \n " '''*'''.


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


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


; '''HasBSL'''
; '''HasBSL'''
: If set to "Yes", the Installer considers your mod a scenario and takes steps to exclude other BSL scenario mods from being installed for the same level. If set to "Addon", the Installer allows your mod to be installed to any level without restriction. Of course not all third-party BSL add-ons are guaranteed to be compatible with each other, but this is an inherent risk in third-party modding. Mods with conflicting BSL files for a level should be stated within the ''Conflicts'' tag. If this tag is left out "Yes" is assumed by default if the mod contains bsl-folders.
: If set to "Yes" (or if this field is not supplied at all but your mod contains a bsl/ folder), the Installer considers your mod a standalone scenario and excludes other mods with bsl/ folders from being installed to the same level. The major limitation with BSL mods is that you cannot mix two mods containing .bsl files with the same names and expect any kind of good result, which is why the AEI will normally prevent these mods from combining or overwriting each other. However if you set the ''HasBSL'' field to "Addon", your mod will be treated as an addition to existing level scripts (vanilla or mod-originated). You are then responsible for listing any conflicting mods (ones for which your mod cannot be an addon) in the ''IncompatibleWith'' field.


; '''UnlockLevel'''
; '''UnlockLevel'''
: If this mod adds a new level this flag allows to unlock that level in [[persist.dat]]. Multiple level numbers can be given 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 ====
====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 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.


  12345ExampleMod(.zip)
  12345ExampleMod(.zip)
     / Mod_Info.cfg
     Mod_Info.cfg
     / oni
     oni/
         / common
         common/
             / level''#''_Final
             level''#''_Final/
                 / ...
                 *.oni
         / win_only
         win_only/
             / level''#''_Final
             level''#''_Final/
                 / ...
                 *.oni
         / mac_only
         mac_only/
             / level''#''_Final
             level''#''_Final/
                 / ...
                 *.oni
     / bsl
     patches/
         / common
         common/
             / tctf_ii
             level''#''_Final/
                 / ...
                 *.oni-patch
         / win_only
         win_only/
             / tctf_ii
             level''#''_Final/
                 / ...
                 *.oni-patch
         / mac_only
         mac_only/
             / tctf_ii
             level''#''_Final/
                 / ...
                 *.oni-patch
 
    plain/
Folders without content can be left out, so a basic mod with only level0-.oni-files for MacOS only will look like this:
        common/
/ 12345ExampleMod
        win_only/
    / Mod_Info.cfg
            GameDataFolder/
     / oni
                intro.bik
         / mac_only
        mac_only/
             / level0_Final
            GameDataFolder/
                 / myFile.oni
                intro.mov
     bsl/
        common/
            tctf_ii/
                *.bsl
         win_only/
            tctf_ii/
                *.bsl
        mac_only/
             tctf_ii/
                 *.bsl


=== Tools ===
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:
12345ExampleMod
    Mod_Info.cfg
    oni/
        mac_only/
            level0_Final/
                myFile.oni


==== Mod_Info.cfg ====
===Tools===
  AEInstallVersion -> 2.0
====Mod_Info.cfg====
  NameOfMod -> Onisplit
  AEInstallVersion -> 2.0
  NameOfMod -> OniSplit
  Creator -> Neo
  Creator -> Neo
  ModVersion -> 0.9.77.0
  ModVersion -> 0.9.82.0
  Readme -> Management of Oni's .dat files
  Readme -> Management of Oni's .dat files
  ExeName -> Tools/MyExe.exe
  ExeName -> Tools/OniSplit.exe
  ExeType -> DotNet
  ExeType -> DotNet
  WorkingDir -> Base
  WorkingDir -> Base
  IconName -> Tools/MyIcon.png
  IconName -> Tools/MyIcon.png


Explanation of fields in the Config: (Entries marked with an asterisk ('''*''') are only used if the mod is not yet listed on the depot)
;Explanation of fields
Entries marked with an asterisk ('''*''') are only used if the mod is not yet listed on the {{OMD}}, otherwise the AEI will display the version of those fields that is found on the mod's Depot node.


; '''AEInstallVersion'''
; '''AEInstallVersion'''
: What version of the Installer is needed to read this package.
: What version of the Installer is needed to read this package. All tool packages must say "2.0", as earlier AE Installers did not support tool packages.


; '''NameOfMod'''
; '''NameOfMod'''
Line 109: Line 151:


; '''ExeName'''
; '''ExeName'''
: Path to the executable file if it should be integrated in the tools menu of AEI. Probably mostly useful for GUI based tools. Do not forget to add the path to the file in relation to the Edition-base folder. (Optional tag)
: 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.


; '''ExeType'''
; '''ExeType'''
: Type of the executable. Important if the executable has to be run by a specific interpreter like .Net. Can be either one of:
: Type of the executable. Important if the executable has to be run by a specific interpreter like .NET. Allowed values are:
:: ''OSBinary'' - Normal binary which can be executed by itself (assumed by default)
:: ''OSBinary'' - Normal binary which can be executed by itself (assumed by default)
:: ''DotNet'' - .Net binary, executed by MS.NET on Windows, Mono on MacOS / Linux
:: ''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 macOS and Linux
:: ''Jar'' - Java .jar archive (assumed if ''ExeName'' ends in ".jar")
:: ''Jar'' - Java .jar archive (assumed if ''ExeName'' ends in ".jar")


; '''WorkingDir'''
; '''WorkingDir'''
: Specify the working directory for the executable specified by ''ExeName''. Can be either one of:
: Specify the working directory for the executable specified by ''ExeName''. Allowed values are:
:: ''Base'' - Working directory is the Edition folder (assumed by default)
:: ''Base'' - Working directory is the AE/ folder (assumed by default)
:: ''Exe'' - Working directory is the folder where the executable is located
:: ''Exe'' - Working directory is the folder where the executable is located
:: ''GDF'' - Working directory is the GameDataFolder
:: ''GDF'' - Working directory is GameDataFolder/


; '''IconName'''
; '''IconName'''
: Path to an icon for the tools menu. Must be in PNG format and between 16x16 and 32x32 in size. If not specified no icon will be used.
: Path to an icon for the [[AEI#Tools|AEI Tools menu]]. Must be in PNG format and between 16x16 and 32x32 in size. If not specified, no icon will be used.
 
==== Folder structure ====


====Folder structure====
  00000OniSplit(.zip)
  00000OniSplit(.zip)
     / Mod_Info.cfg
     Mod_Info.cfg
     / plain
     plain/
         / common
         common/
             / Tools
             Tools/
                 / Onisplit.exe
                 OniSplit.exe
         / win_only
         win_only/
         / mac_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 ==


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:
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.


==Package format 1.1 (deprecated)==
{{Divhide}}
This is the format of package that was preferred by the Installer that came with the 2010-05 AE. Format 1.0 is not explicitly documented here, but the differences between 1.0 and 1.1 are summarized below; 1.0 was the format used for packages when the AE 2009-07 was released.


1. Open up your Edition/install/packages folder.
===Mod_Info.cfg===
----
  AEInstallVersion -> 1.1
2. Create a new folder with a name corresponding to your mod. No spaces, please. The five digit number in front corresponds to where in the load order you want your mod to be. Please, leave some space between your mod and other AE mods. See [[Anniversary Edition/Framework#Package numbering|HERE]] to know how to number your mod.
----
3. Create (or copy) a config file named "Mod_Info.cfg" inside your new folder.
 
Sample:
 
  AEInstallVersion -> 1.1
  NameOfMod -> Improved Weapons
  NameOfMod -> Improved Weapons
  ModVersion -> 1.1
  ModVersion -> 1.1
Line 158: Line 192:
  Creator -> Geyser/Loser/Iritscen/Gumby
  Creator -> Geyser/Loser/Iritscen/Gumby
  HasOnis -> Yes
  HasOnis -> Yes
  Readme -> Improves the appearence and mechanics of existing Oni weapons. \n \n Currently contains...
  Readme -> Improves the appearance and mechanics of existing Oni weapons. \n \n Currently contains...


:;'''AEInstallVersion'''
:;'''AEInstallVersion'''
:What version of the Installer is needed to read this package. There are two significant releases of the Anniversary Edition Installer (AEI): 1.0 and 1.1. If you make a new package at this point, you should just set its AEInstallVersion to 1.1 to be safe. Following, for the sake of thorough documentation, are the functional package-handling differences between the versions:
:What version of the Installer is needed to read this package (choices are 1.0 and 1.1). 1.0 is [[wikipedia:Deprecation#Software|deprecated]], but for the sake of thorough documentation, here are the functional package-handling differences between the versions:
::1.0 (Edition 2009-07): Initial release.
::*Now supports BSL mods. This means that the HasBSL flag now works. See step 7.
::1.1 (Edition 2010-05):
::*No more division of level0_Final into level0_Character, level0_Textures, etc., and no more need for a double-path like level1_Final/level1_Final. See step 5.
:::*Now supports BSL mods. This means that the HasBSL flag now works. See step 7.
::*ModString is now deprecated in place of ModVersion.
:::*No more division of level0_Final into level0_Character, level0_Textures, etc., and no more need for a double-path like level1_Final/level1_Final. See step 5. The 1.0 package hierarchy still works, however.
::*Supports floating-point version numbers, like "ModVersion -> 1.1".
:::*ModString is now deprecated in place of ModVersion.
::*Supports platform-specific mods by use of Platform flag.
:::*Supports floating-point version numbers, like "ModVersion -> 1.1".
:::*Supports platform-specific mods by use of Platform flag.


:;'''NameOfMod'''
:;'''NameOfMod'''
Line 192: Line 224:


Flags not documented here are currently ignored by the Installer.
Flags not documented here are currently ignored by the Installer.
----
4. If you have .oni files, make a folder named "oni" inside your package folder. If you have .bsl files, make a folder named "bsl" inside the package folder.
----
5. If your mod modifies the global data in level0_Final, make a "level0_Final" folder inside "oni". For every level that your mod uses, make a "levelX_Final" folder inside "oni". (level1_Final, level2_Final, etc...) New levels are currently not detected.
----
6. A BSL mod uses the names of the IGMD subfolders the script(s) will go into, e.g. a script that is meant for Chapter 1 goes in bsl/EnvWarehouse/.
----
7. Put levelX (anything but level0) .oni files inside their respective levelX_Final/ directories.


You are done!  Sample mod directory:
You are done!  Sample mod directory:


===Folder structure===
81000TCTF3
81000TCTF3
:bsl
:bsl
Line 213: Line 238:
::level18_Final
::level18_Final
:::BINACJBOCharacter.oni
:::BINACJBOCharacter.oni
{{Divhide|end}}


----
==Package numbering==
'''Special Notes'''
So, how do you pick a number for your mod? Here's the ranges which are recommended. The numbers help keep things organized, as well as determine the order in which the mods are installed, but your mod will probably work correctly even if you don't pick a number from the right range -- unless you pick a number below 10000, which has special meaning for the AE Installer.
 
{|border="0"
*Be very careful when replacing (not adding) M3GM and TRAC, they can be a bit touchy. With TRAC, you must include all of the children of the TRAC you are adding. With M3GM, you must also include the file that references the M3GM. Whenever possible, copy the files from packages\Globalize instead of the default Oni files.
|-
 
| style="text-align:right"|'''0 -'''
 
| style="text-align:right"|'''7999'''
*New ONCCs should have this inside the ONCP:
|'''Reserved for [[Anniversary Edition/Core|core AE mods]]'''
 
|-
            <ONCPParticle>
| style="text-align:right"|'''8000 -'''
                <Name>glass_break</Name>
| style="text-align:right"|'''9999'''
                <Type>glass_break</Type>
|'''Reserved for tool packages'''
                <BodyPart>-1</BodyPart>
|-
            </ONCPParticle>
|'''10000 -'''
 
|'''19999'''
:If they do not, they will not be able to break glass when a user installs the glass-breaking AE mod.
|Weapons
 
|-
 
|'''20000 -'''
== Package numbering ==
|'''29999'''
Please read on '''[[Anniversary_Edition/Framework#Package_numbering|HERE]]'''.
|Characters, new textures for existing levels and characters
|-
|'''30000 -'''
|'''39999'''
|Particles
|-
|'''40000 -'''
|'''49999'''
|Animations (non-combat)
|-
|'''50000 -'''
|'''59999'''
|Animations (combat)
|-
|'''60000 -'''
|'''69999'''
|Sounds, Music
|-
|'''70000 -'''
|'''79999'''
|UI (menu screens, HUD, etc.)
|-
|'''80000 -'''
|'''89999'''
|New levels
|-
|'''90000 -'''
|'''99999'''
|Scenarios (BSL mods for other people's levels)
|}
Once you know which range to use, you should use the remaining digits to number your mod in a way that fits in with the other mod packages. For example, here's some hypothetical package numbers and what they tell you about the package:


41000 - a mod that tweaks animations


=== [http://mods.oni2.net/mods/Package used numbers] ===
41100 - this mod might be related to mod 41000, or else you are just looking for another free number and 42000, 43000 ... 48000, 49000 are taken
AE packages are marked with an asterisk (*).<br>Placeholders are marked with two asterisk (**).


Last update: Aug. 20, 2012
41010 - probably someone's addition or improvement to mod 41000


11000 Better Weapons (*)
41001 - must be an addition or improvement for mod 41000, or why else would they be numbered so closely?
11100 Three Dee Shells (3D bullet casing)
12000 New Weapons (*)
12010 Assualt Rifle
12100 ONIrules Weapons Collection 2
12300 Devastator
13000 Multi Use Explosive
21000 Upgraded ONCCs (*)
21200 Sentry Droid
21300 Guard Dogs
21400 Wraith Mod Squad / Wraith Squad
21500 Brutal AI
22000 New Characters
22005 Sam Mega Pack - Characters
22006 Sam Mega Pack - Conversion
22007 Sam Mega Pack - Levels(**)
22008 Custom Character Mega Pack BGI (Level modifications + Characters)(**)
22009 Custom Character Mega Pack BGI (Characters only)(**)
22010 Custom Character Mega Pack BGI (Level modifications only)(**)
22015 BGI Executives, Guards, Receptionist*
22016 BGI Sarai (**)
22017 BGI Agents
22018 BGI Troopers (**)
22019 BGI Jubei and Akane original version
22020 BGI Assassins (updated Jubei & Akane)(**)
22022 BGI Hydra (**)
22023 BGI Hammer
22024 BGI Typhoon(**)
22025 BGI Ninja Bot
22026 BGI Heavy Bot
22027 BGI Bat *
22028...
22029...
22030...
22110 White Chief
22111 Black Chief
22200 Konoko's Special Wardrobe
22300 Bozzman's TCTF
22500 Muro's Wardrobe
22390 RedBlackSwitch
22400 Blackops Syndicate by TOCS
22410 Konoko and Female Blackops
22450 Casual Tanker
22500 Daodanized Mukade
23000 Shinatama Too (*)
23100 Shinatama Bot
23150 Berserker Gally (Alita)
23200 Golden TCTF
23201 GoldenTCTF Fight
23205 Ultimate Griffin (**)
23210 ............. (?)
23300 James and Jamie Hasegawa
23400 Kyrie\Akirie (**)
23500 Casey
23580 Red Fury Variant 4
23590 GreyFury2.0
23595 Regenerating Tanker
23600 Kojiro 2.0
23605 Apollo (**)
23610 Hayate 2.0
23615 Hanako
23620 Thor*
23630 Mutant Jester
23640 RAYMAN (**)
23650 CHUCK NORRIS (**)
23660...
23670...
23680...
23690 Semi Mutant Muro (**)
23700 Mutant Konokos (**)
23900 Character Additives
23905 Skull Team Fight
24000 Severed Textures (*)
24100 HQ Training Textures
24104 HQ Airport Textures
24110 Vicious Reillys Konoko
24210 Yin Yang Fury
24220 StoneTank
24230 Metal Ninja
24240 Elite Tanker
24150 Konoko-Three-in-one
25000 Motoko
26000 Konoko HD
27000 Alita Last Order
28000 Griffin HD
29000 Character Retexture
29001 TCTF Package
24500 Better Consoles and Doors
24501 Better Warehouse and Training
31000 Glass Breaking Moves (*)
32000 Dangerous Glass (*)
32100 Complete Glass Mod
33000 Improved Weather (*)
34000 Exploding Barrel
34090 Blood
34100 Perceptible Blood
39000 Black Chenille (demo about black plus alpha issue)
42000 Dashing AI (*)
44000 Konoko Retextured
44001 Comguy Retextured Reflective
45000 Ninja Shadow Dash (*)
45500 Dash Blur (*)
46000 Prone Mode Revisited
50000 Jewel Fix
51000 Unlock All Moves (*)
52000 Andrashi TRAMs (*)
52100 Fixed TRAM
52200 Particle Trails
52230 Stunned Throws Fix
53000 Knockdown Revamp (*)
'''55000''' New Animations
'''55000''' Barabus Jetpack
55010 Barabus Draining Regeneration
56000 Mod Brick 1 Speed
60000 All Starlab
70000 HD Screens
70100 Mukade Clones
77700 Survival
77720 Crazy Casey
77721 Crazy Casey Final Battle
77730 Shins New Shoes
77770 Oni Zen Garden Roof
77771 Oni Zen Garden Arena
80100 Real Skies
80200 Arena of Hurt
80210 Junkyard
80220 Hexagon
80230 Muro's Lair - Mission 1
80240 Parkour Challenge
80260 De Dust Deluxe
80270 Boss Battle
80280 Old China
80300 Level Maze
83000 nyan cat
88000 TCTF Regional HQ MOD
90100 Titan Mode
90110 Aiport Assault 2 (v1)
99900 Door Lock Bombing (demo)
99901 Head Shot Mod (beta / POC)
99902 Muro Plasma
99903 Muro Kamehameha idea (**)


Okay, so now you get the idea, but how do you know which package numbers are free? Click [http://mods.oni2.net/mods/Package?order=field_package_number&sort=asc here] to see all used numbers on the Depot. You can also check the number by entering it into [[Vago (tool)|Vago's]] package creation wizard and clicking the Check button, and it will automatically check it for you. To see which level numbers (as in "levelX_Final") have been used already by new fan-made levels, see [[Creating a level#Fan-made levels|HERE]].


[[Category:Modding tutorials]]
[[Category:Modding tutorials]]

Latest revision as of 19:12, 10 November 2023

The Anniversary Edition installs mods that are made in a certain format -- the mod files must be placed in a specified hierarchy of folders with a text file that provides additional information. This arrangement of folders and files is simply called the mod package format.

Package format 2.0

The AEI 2 prefers the new 2.0 package format, but will also read 1.1 packages.

You can start your package by copying an existing AE package and modifying it to save time. To create a new mod package from scratch, use Vago's package wizard or follow these seven easy steps:

1. Create a new folder with a name corresponding to your mod.

2. Pick a number for your mod. The five digit number corresponds to where in the load order your mod will be, but it also indicates the type of mod. Please leave some numeric space between your mod and other AE mods. See the numbering section below to know how to number your mod.

3. Create a plain-text file named "Mod_Info.cfg" inside your new folder. See section "Mod_Info.cfg" under the Mods or Tools section to learn what to put in the config file for that kind of package.

4. If you have .oni files in your mod, you make a folder named "oni" inside your package folder. If you have .bsl files, make a folder named "bsl". If you have 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 or Tools section for an illustration of the required hierarchy.

5. Make a folder called "common" inside the oni/, bsl/, patches/ or plain/ folder for files which will work both in Windows and on Intel Macs. Make a folder called "win_only" or "mac_only" if you have files intended for only one platform or if certain files need to be in one format for Windows and one for macOS (such as sounds).

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 Oni Mod Depot.

Special note: Be very careful when replacing (not adding) M3GM, TRAC and OBAN. With TRAC, you must include all of the child TRACs of the TRAC you are adding. With M3GM, you must also include the file that references the M3GM. With OBANs, you need to include the AKEV that links to them. There may be other file types that need their parents or children included.

Mods

Mod_Info.cfg

AEInstallVersion -> 2.0
NameOfMod -> Improved Weapons
Creator -> Geyser, Loser, Iritscen, Gumby
ModVersion -> 1.1
IncompatibleWith -> 11100,23050
DependsOn -> 45000
UnlockLevel -> 25
Readme -> Improves the appearance and mechanics of existing Oni weapons. \n \n Currently contains...
Explanation of fields

Entries marked with an asterisk (*) are only used if the mod is not yet listed on the Mod Depot. Otherwise, the AEI will display the versions of those fields that are found on the Depot's node for that mod.

AEInstallVersion
What version of the Installer is needed to read this package. Here are the functional package-handling differences between 2.0 and 1.1 packages:
  • The BSL -> Addon flag is now respected properly.
  • DependsOn and IncompatibleWith flags added for mod interoperability.
  • Tools can now be placed in packages and installed like mods.
  • .oni files which can be exported to XML can now have individual elements altered using patch files or scripts, in order to allow multiple mods to affect the same resources.
  • A single package can now support both platforms at once (using "common", "mac_only" and "win_only" sub-directories).
NameOfMod
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 *.
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 line breaks by using " \n " *.
IncompatibleWith
Package numbers of mods which this mod will not work with if they are installed at the same time. Multiple entries separated by ",".
DependsOn
Package numbers of mods that this mod requires in order to function. Multiple entries separated by ",".
HasBSL
If set to "Yes" (or if this field is not supplied at all but your mod contains a bsl/ folder), the Installer considers your mod a standalone scenario and excludes other mods with bsl/ folders from being installed to the same level. The major limitation with BSL mods is that you cannot mix two mods containing .bsl files with the same names and expect any kind of good result, which is why the AEI will normally prevent these mods from combining or overwriting each other. However if you set the HasBSL field to "Addon", your mod will be treated as an addition to existing level scripts (vanilla or mod-originated). You are then responsible for listing any conflicting mods (ones for which your mod cannot be an addon) in the IncompatibleWith field.
UnlockLevel
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. 

12345ExampleMod(.zip)
    Mod_Info.cfg
    oni/
        common/
            level#_Final/
                *.oni
        win_only/
            level#_Final/
                *.oni
        mac_only/
            level#_Final/
                *.oni
    patches/
        common/
            level#_Final/
                *.oni-patch
        win_only/
            level#_Final/
                *.oni-patch
        mac_only/
            level#_Final/
                *.oni-patch
    plain/
        common/
        win_only/
            GameDataFolder/
                intro.bik
        mac_only/
            GameDataFolder/
                intro.mov
    bsl/
        common/
            tctf_ii/
                *.bsl
        win_only/
            tctf_ii/
                *.bsl
        mac_only/
            tctf_ii/
                *.bsl

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: 

12345ExampleMod
    Mod_Info.cfg
    oni/
        mac_only/
            level0_Final/
                myFile.oni

Tools

Mod_Info.cfg

AEInstallVersion -> 2.0
NameOfMod -> OniSplit
Creator -> Neo
ModVersion -> 0.9.82.0
Readme -> Management of Oni's .dat files
ExeName -> Tools/OniSplit.exe
ExeType -> DotNet
WorkingDir -> Base
IconName -> Tools/MyIcon.png
Explanation of fields

Entries marked with an asterisk (*) are only used if the mod is not yet listed on the Oni Mod Depot, otherwise the AEI will display the version of those fields that is found on the mod's Depot node.

AEInstallVersion
What version of the Installer is needed to read this package. All tool packages must say "2.0", as earlier AE Installers did not support tool packages.
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 " *.
ExeName
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.
ExeType
Type of the executable. Important if the executable has to be run by a specific interpreter like .NET. Allowed values are:
OSBinary - Normal binary which can be executed by itself (assumed by default)
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 macOS and Linux
Jar - Java .jar archive (assumed if ExeName ends in ".jar")
WorkingDir
Specify the working directory for the executable specified by ExeName. Allowed values are:
Base - Working directory is the AE/ folder (assumed by default)
Exe - Working directory is the folder where the executable is located
GDF - Working directory is GameDataFolder/
IconName
Path to an icon for the AEI Tools menu. Must be in PNG format and between 16x16 and 32x32 in size. If not specified, no icon will be used.

Folder structure

00000OniSplit(.zip)
    Mod_Info.cfg
    plain/
        common/
            Tools/
                OniSplit.exe
        win_only/
        mac_only/

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.

Package format 1.1 (deprecated)

Package numbering

So, how do you pick a number for your mod? Here's the ranges which are recommended. The numbers help keep things organized, as well as determine the order in which the mods are installed, but your mod will probably work correctly even if you don't pick a number from the right range -- unless you pick a number below 10000, which has special meaning for the AE Installer.

0 - 7999 Reserved for core AE mods
8000 - 9999 Reserved for tool packages
10000 - 19999 Weapons
20000 - 29999 Characters, new textures for existing levels and characters
30000 - 39999 Particles
40000 - 49999 Animations (non-combat)
50000 - 59999 Animations (combat)
60000 - 69999 Sounds, Music
70000 - 79999 UI (menu screens, HUD, etc.)
80000 - 89999 New levels
90000 - 99999 Scenarios (BSL mods for other people's levels)

Once you know which range to use, you should use the remaining digits to number your mod in a way that fits in with the other mod packages. For example, here's some hypothetical package numbers and what they tell you about the package:

41000 - a mod that tweaks animations

41100 - this mod might be related to mod 41000, or else you are just looking for another free number and 42000, 43000 ... 48000, 49000 are taken

41010 - probably someone's addition or improvement to mod 41000

41001 - must be an addition or improvement for mod 41000, or why else would they be numbered so closely?

Okay, so now you get the idea, but how do you know which package numbers are free? Click here to see all used numbers on the Depot. You can also check the number by entering it into Vago's package creation wizard and clicking the Check button, and it will automatically check it for you. To see which level numbers (as in "levelX_Final") have been used already by new fan-made levels, see HERE.

Retrieved from "https://wiki.oni2.net/w/index.php?title=Making_a_mod_package&oldid=41523"