Modding:Mod Configuration: Difference between revisions
m Clarify default load behaviour |
m Rm beta disclaimer |
||
| (9 intermediate revisions by the same user not shown) | |||
| Line 54: | Line 54: | ||
| '''Dependency''' | | '''Dependency''' | ||
| Shorthand to declare a single mod dependency of any version, mutually exclusive with <code>Dependencies</code> field.<br/><b>New in build 210.</b>|| | | Shorthand to declare a single mod dependency of any version, mutually exclusive with <code>Dependencies</code> field.<br/><b>New in build 210.</b>|| | ||
|- | |||
| '''LoadBefore''' | |||
| A single or array of mod IDs that this mod should attempt to load earlier than.<br/><b>New in build 210.</b>|| | |||
|- | |||
| '''LoadAfter''' | |||
| A single or array of mod IDs that this mod should attempt to load later than.<br/><b>New in build 210.</b>|| | |||
|- | |- | ||
| '''Directories''' | | '''Directories''' | ||
| Line 61: | Line 67: | ||
==Directory Structure== | ==Directory Structure== | ||
Each entry in the <code>Directories</code> array will be evaluated and loaded if optional conditions such as version and dependency match.<br/> | Each entry in the <code>Directories</code> array will be evaluated and loaded if optional conditions such as version and dependency match.<br/> | ||
If no conditions are specified the directory and its paths will always be loaded.<br/> | |||
If | Directories can be used to include separate content/scripts for different game versions, or optional addons to other mods.<br/> | ||
If none are explicitly defined the mod's root directory will be loaded. | |||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Line 96: | Line 102: | ||
| Shorthand to declare a single mod dependency of any version, mutually exclusive with <code>Dependencies</code> field.|| | | Shorthand to declare a single mod dependency of any version, mutually exclusive with <code>Dependencies</code> field.|| | ||
|- | |- | ||
| ''' | | '''Options''' | ||
| | | A single or array of [[Modding:Options|options]] <code>Requires</code> strings that must be true.<br/>Note that the XML file containing the referenced options is required to have <code>Option</code> somewhere in its file name.<br/>This is a quirk caused by populating the option defaults prior to directory initialization. || | ||
|} | |} | ||
==Version Ranges== | ==Version Ranges== | ||
To match a game or mod's version you'll define a range of acceptable values using a simple and familiar syntax.<br/> | To match a game or mod's version you'll define a range of acceptable values using a simple and familiar syntax.<br/> | ||
Any number left undefined will behave as if substituted with <code>*</code>. | Any number left undefined will behave as if substituted with <code>*</code>. | ||
| Line 108: | Line 113: | ||
* <code>2.0.208 - 3.0.0</code>: Matches a version greater or equal to <code>2.0.208</code>, and less or equal to <code>3.0.0</code> (i.e. an inclusive closed interval). | * <code>2.0.208 - 3.0.0</code>: Matches a version greater or equal to <code>2.0.208</code>, and less or equal to <code>3.0.0</code> (i.e. an inclusive closed interval). | ||
* <code>2.0.209.52 - *</code>: Matches a version greater or equal to <code>2.0.209.52</code>. | * <code>2.0.209.52 - *</code>: Matches a version greater or equal to <code>2.0.209.52</code>. | ||
* <code><nowiki>>3.5</nowiki></code>: Matches a version greater | * <code><nowiki>>3.5</nowiki></code>: Matches a version greater or equal to <code>3.6.0</code>. | ||
* <code><nowiki>>=2 <5</nowiki></code>: Matches a version greater or equal to <code>2.0.0</code>, but less than <code>5.0.0</code>. | * <code><nowiki>>=2 <5</nowiki></code>: Matches a version greater or equal to <code>2.0.0</code>, but less than <code>5.0.0</code>. | ||
* <code><nowiki>^0.5.2 || 7.2.1</nowiki></code>: Matches a version greater or equal to <code>0.5.2</code>, but less than <code>0.6.0</code>. <b>Or</b> a version equal to <code>7.2.1</code>. | * <code><nowiki>^0.5.2 || 7.2.1</nowiki></code>: Matches a version greater or equal to <code>0.5.2</code>, but less than <code>0.6.0</code>. <b>Or</b> a version equal to <code>7.2.1</code>. | ||
| Line 126: | Line 131: | ||
"Tags": "Creature", | "Tags": "Creature", | ||
"PreviewImage": "preview.png", | "PreviewImage": "preview.png", | ||
"LoadBefore": "SightlessFray", | |||
"LoadAfter": [ "Tamago_PlatypusCommune", "ChromeGarlands" ], | |||
"Dependencies": { | "Dependencies": { | ||
"Pyovya_SaltOrphan": "1.0.0 - *" | "Pyovya_SaltOrphan": "1.0.0 - *" | ||
}, | }, | ||
"Directories": [ | "Directories": [ | ||
{ | |||
"Paths": [ "/Common/", "/Assets/Textures/" ] | |||
}, | |||
{ | { | ||
"Path": "/Old/", | "Path": "/Old/", | ||
| Line 135: | Line 145: | ||
}, | }, | ||
{ | { | ||
"Paths": ["/NewCS/", "/NewXML/"], | "Paths": [ "/NewCS/", "/NewXML/" ], | ||
"Build": ">=2.0.209.43" | "Build": ">=2.0.209.43" | ||
}, | }, | ||
| Line 141: | Line 151: | ||
"Path": "/GooeyAddon/", | "Path": "/GooeyAddon/", | ||
"Version": ">=1.0.0", | "Version": ">=1.0.0", | ||
"Options": [ "OptionSnapjawMage_AddGooeyIck == Yes", "OptionSound != No" ], | |||
"Dependencies": { | "Dependencies": { | ||
"Momo_CyberneticGenders": "^2.*", | "Momo_CyberneticGenders": "^2.*", | ||
| Line 148: | Line 159: | ||
{ | { | ||
"Path": "/SaltAddon/", | "Path": "/SaltAddon/", | ||
"Option": "OptionSnapjawMage_AddRiotSalt == Yes", | |||
"Dependency": "Yarif_RiotCooking" | "Dependency": "Yarif_RiotCooking" | ||
} | } | ||