Changes between Version 26 and Version 27 of Modding_Guide


Ignore:
Timestamp:
Dec 10, 2017, 5:16:31 PM (6 years ago)
Author:
elexis
Comment:

Update to r20637

Legend:

Unmodified
Added
Removed
Modified
  • Modding_Guide

    v26 v27  
    7979}}}
    8080
    81 Mods can specify a link to a website in an optional `url` property. `name` must be unique and must not contain whitespace. `dependencies` is an array that contains the `name` of mods it depends on, optionally with version constraints (<,<=,=,>=,>) and the versions of the dependency.
     81 * A mod is identified by the directory name.
     82 * A mod must define the "name", "version", "label", "description" and "dependencies" property.
     83 * The "url" property is optional.
     84 * The property "name" can consist alphanumeric characters, underscore and dash.
     85 * The name is used for version comparison of mod dependencies.
     86 * The property "version" may only contain numbers and up to two periods.
     87 * The property "label" is a human-readable name of the mod.
     88 * The property "description" is a human-readable summary of the features of the mod.
     89 * The property "url" is reference to a website about the mod.
     90 * The property "dependencies" is an array of strings. Each string is either a modname or a mod version comparison.
     91 * A mod version comparison is a modname, followed by an operator (=, <, >, <= or >=), followed by a mod version.
     92  This allows mods to express upwards and downwards compatibility.
     93
    8294
    8395For details of how the dependency checking is done please read the function comments in [source:ps/trunk/binaries/data/mods/mod/gui/modmod/modmod.js modmod.js].