OniGalore

Making a mod package: Difference between revisions

Page Discussion

Making a mod package (view source)

Revision as of 19:12, 10 November 2023

332 bytes added ,  10 November 2023
m
→‎Package numbering: link fix
(→‎Package numbering: linking to list of level numbers)
 
(5 intermediate revisions by the same user not shown)
Line 54: 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'''
Line 63: Line 63:


; '''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 listed in the ''IncompatibleWith'' field. If this tag is left out, "Yes" is assumed by default if the mod contains a "bsl/" folder.
: 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'''
Line 182: Line 182:


==Package format 1.1 (deprecated)==
==Package format 1.1 (deprecated)==
{{Divhide|}}
{{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.
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.


Line 195: Line 195:


:;'''AEInstallVersion'''
:;'''AEInstallVersion'''
:What version of the Installer is needed to read this package (choices are 1.0 and 1.1). 1.0 is [[wikipedia:Deprecation#Software_deprecation|deprecated]], but for the sake of thorough documentation, here 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:
::*Now supports BSL mods. This means that the HasBSL flag now works. See step 7.
::*Now supports BSL mods. This means that the HasBSL flag now works. See step 7.
::*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.
::*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.
Line 244: Line 244:
{|border="0"
{|border="0"
|-
|-
|'''0 - 7999'''
| style="text-align:right"|'''0 -'''
| style="text-align:right"|'''7999'''
|'''Reserved for [[Anniversary Edition/Core|core AE mods]]'''
|'''Reserved for [[Anniversary Edition/Core|core AE mods]]'''
|-
|-
|'''8000 - 9999'''
| style="text-align:right"|'''8000 -'''
| style="text-align:right"|'''9999'''
|'''Reserved for tool packages'''
|'''Reserved for tool packages'''
|-
|-
|'''10000 - 19999'''
|'''10000 -'''
|'''19999'''
|Weapons
|Weapons
|-
|-
|'''20000 - 29999'''
|'''20000 -'''
|Characters
|'''29999'''
|Characters, new textures for existing levels and characters
|-
|-
|'''30000 - 39999'''
|'''30000 -'''
|'''39999'''
|Particles
|Particles
|-
|-
|'''40000 - 49999'''
|'''40000 -'''
|'''49999'''
|Animations (non-combat)
|Animations (non-combat)
|-
|-
|'''50000 - 59999'''
|'''50000 -'''
|'''59999'''
|Animations (combat)
|Animations (combat)
|-
|-
|'''60000 - 69999'''
|'''60000 -'''
|'''69999'''
|Sounds, Music
|Sounds, Music
|-
|-
|'''70000 - 79999'''
|'''70000 -'''
|'''79999'''
|UI (menu screens, HUD, etc.)
|UI (menu screens, HUD, etc.)
|-
|-
|'''80000 - 89999'''
|'''80000 -'''
|New levels (and new textures for existing levels)
|'''89999'''
|New levels
|-
|-
|'''90000 - 99999'''
|'''90000 -'''
|'''99999'''
|Scenarios (BSL mods for other people's levels)
|Scenarios (BSL mods for other people's levels)
|}
|}
Line 287: Line 298:
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 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 [[XML:ONLV#Level_releases.2C_forum_threads_and_wiki_pages|HERE]].
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]]
Retrieved from "https://wiki.oni2.net/Special:MobileDiff/29935...41523"