Jump to content

Making a mod package: Difference between revisions

more numbering explanation
(polishing)
(more numbering explanation)
Line 173: Line 173:
The folder ''plain/'' is for non-mod files, whether 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.
The folder ''plain/'' is for non-mod files, whether 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.


{{Divhide|Package format 1.1 (deprecated)}}
{{Divhide|Package format 1.1}}
==Package format 1.1 (deprecated)==
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.
 
===Mod_Info.cfg===
===Mod_Info.cfg===
  AEInstallVersion -> 1.1
  AEInstallVersion -> 1.1
Line 215: Line 218:


You are done!  Sample mod directory:
You are done!  Sample mod directory:
 
===Folder structure===
81000TCTF3
81000TCTF3
:bsl
:bsl
Line 229: Line 232:


==Package numbering==
==Package numbering==
So, how do you pick a number for your mod? Here's how you pick the first of the five digits (numbers with less than/more than five are reserved for the AE):
So, how do you pick a number for your mod? Here's the ranges which are recommended. The numbers help keep things organized, but your mod will still 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"
'''10000s - Weapons'''
|-
 
|'''0 - 7999'''
'''20000s - Characters'''
|'''Reserved for [[Anniversary Edition/Packages|core AE mods]]'''
 
|-
'''30000s - Particles'''
|'''8000 - 9999'''
 
|'''Reserved for tool packages'''
'''40000s - Animations (non-combat)'''
|-
 
|'''10000 - 19999'''
'''50000s - Animations (combat)'''
|Weapons
 
|-
'''60000s - Sounds'''
|'''20000 - 29999'''
 
|Characters
'''70000s - UI (new menu screens, HUD, etc.)'''
|-
 
|'''30000 - 39999'''
'''80000s - New levels (and new textures for existing levels)'''
|Particles
 
|-
'''90000s - Scenarios (BSL mods for other people's levels)'''
|'''40000 - 49999'''
 
|Animations (non-combat)
Once you know which digit to start with, 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:
|-
|'''50000 - 59999'''
|Animations (combat)
|-
|'''60000 - 69999'''
|Sounds, Music
|-
|'''70000 - 79999'''
|UI (menu screens, HUD, etc.)
|-
|'''80000 - 89999'''
|New levels (and new textures for existing 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
41000 - a mod that tweaks animations