User Tools

Site Tools


documentation:fabric_mod_json

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
documentation:fabric_mod_json [2023/01/16 19:15] – fix mod ID length off-by-ones juuzdocumentation:fabric_mod_json [2025/10/05 07:17] (current) – rephrase the result of adding dependencies/conflicts skyland1a
Line 2: Line 2:
  
 The fabric.mod.json file is a mod metadata file used by Fabric Loader to load mods. In order to be loaded, a mod must have this file with the exact name placed in the root directory of the mod JAR. The fabric.mod.json file is a mod metadata file used by Fabric Loader to load mods. In order to be loaded, a mod must have this file with the exact name placed in the root directory of the mod JAR.
 +
 ===== Mandatory fields ===== ===== Mandatory fields =====
  
Line 62: Line 63:
 In the case of all versions, * is a special string declaring that any version is matched by the range. In addition, exact string matches must be possible regardless of the version type. In the case of all versions, * is a special string declaring that any version is matched by the range. In addition, exact string matches must be possible regardless of the version type.
  
-   * **depends** For dependencies required to run. Without them a game will crash. +   * **depends** For dependencies required to run. If any are missing, Fabric Loader will trigger a crash. 
-   * **recommends** For dependencies not required to run. Without them a game will log a warning.+   * **recommends** For dependencies not required to run. For each missing dependency, Fabric Loader will log a warning.
    * **suggests** For dependencies not required to run. Use this as a kind of metadata.    * **suggests** For dependencies not required to run. Use this as a kind of metadata.
-   * **breaks** For mods whose together with yours might cause a game crash. With them a game will crash. +   * **breaks** For mods whose together with yours might cause a game crash. If any are present, Fabric Loader will trigger a crash. 
-   * **conflicts** For mods whose together with yours cause some kind of bugs, etc. With them a game will log a warning.+   * **conflicts** For mods whose together with yours cause some kind of bugs, etc. For each conflicting mod present, Fabric Loader will log a warning.
 ==== Metadata ==== ==== Metadata ====
  
documentation/fabric_mod_json.1673896553.txt.gz · Last modified: 2023/01/16 19:15 by juuz