Jump to content

Anniversary Edition/Framework: Difference between revisions

→‎Package numbering: finishing up the official ranges for package numbers, improving wording
(adding section on how to choose a package number)
(→‎Package numbering: finishing up the official ranges for package numbers, improving wording)
Line 13: Line 13:


==Package numbering==
==Package numbering==
When the Installer sees that more than one package affects a given level, what order does it install the packages in? If two packages have the same files in them, which one will take precedence? This is a particularly important consideration for packages that modify level0_Final (that is, most of them). The answer is that the Installer goes by the number at the front of the name of the package folder. So, how do you pick a number for your mod? First of all, the general rule of thumb is:
When the Installer sees that one package overlaps with another in some way, such as two packages that provide new textures for the same character, which one will take precedence? The answer is that the Installer goes by the number at the front of the name of the package folder. A package numbered 11111 will override package 11110 when they are installed into Oni.


1xxxx - Weapons
So, how do you pick a number for your mod? Here's how you pick the first of the five digits:


2xxxx - Characters (and character textures)
'''10000s - Weapons'''


3xxxx - Particles
'''20000s - Characters (and character textures)'''


4xxxx/5xxxx - Animations
'''30000s - Particles'''


This tells you what the first digit will be, but the rest of the numbers determine whether your mod installs over another similar mod or under it. For instance, a package numbered 11100 will override the files in 11000 if both packages get installed. Ideally, you should use the thousands and hundreds place to number your mod if it's unconnected to other mods of that type, and use the tens and ones place to indicate that you are patching another mod package. For example:
'''40000s - Animations (non-combat)'''


41000 (implies this is a mod that tweaks animations)
'''50000s - Combat animations (incl. animation files)'''


41100 (implies that this mod might be related to mod 41000, or else you are just looking for another free number and 42-4900 are taken)
'''60000s - (not used yet)'''
 
'''70000s - (not used yet)'''
 
'''80000s - Levels (and level textures)'''
 
'''90000s - Scripts (BSL)'''
 
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:
 
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 42-4900 are taken)


41010 (probably someone's addition or improvement to mod 41000)
41010 (probably someone's addition or improvement to mod 41000)
Line 33: Line 45:
41001 (must be an addition or improvement for mod 41000, or why else would they be numbered so closely?)
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 numbers are free? First, check the numbers in use by the AE [[Anniversary Edition/Packages|HERE]]. Next, go to the [http://mods.oni2.net Mod Depot], and choose the Packages option from the sidebar to see all packaged mods. The names of the files (under the "Download Link" column) will tell you the numbers for these third-party packages. Any number not used by an AE package or a package on the Depot should be safe to use.
Okay, so now you get the idea, but how do you know which numbers are free? First, check the numbers in use by the AE, which are listed on the [[Anniversary Edition/Packages|AE Packages]] page. Next, go to the [http://mods.oni2.net Mod Depot], and choose "By Install Method>Package" from the sidebar to see all packaged mods. The names of the files (under the "Download Link" column) will tell you the numbers for these third-party packages. Any number not used by an AE package or a package on the Depot should be safe to use.


[[Category:Anniversary Edition]]
[[Category:Anniversary Edition]]