Jump to content

Making a mod package: Difference between revisions

m
→‎Mods: wording on HasBSL
m (link fix)
m (→‎Mods: wording on HasBSL)
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'''