format:modjson
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
format:modjson [2019/02/20 00:34] – [Optional fields (metadata)] asie | format:modjson [2019/05/20 14:28] – falseresync | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== fabric.mod.json format ====== | + | This page moved [[documentation:fabric_mod_json|here]]! |
- | + | ||
- | In all cases, the mod JSON, '' | + | |
- | + | ||
- | * an object containing a " | + | |
- | * or an array containing such objects (this is not supported by Loader as of 0.4.0, but is a part of the specification). | + | |
- | + | ||
- | If a " | + | |
- | + | ||
- | It is important to remember that the Fabric mod JSON is **authoritative**. | + | |
- | + | ||
- | ===== Version 1 (current) ===== | + | |
- | + | ||
- | //TODO: Work in progress!// | + | |
- | + | ||
- | ==== Types ==== | + | |
- | + | ||
- | === Person === | + | |
- | + | ||
- | A string in one of the following formats: | + | |
- | + | ||
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | + | ||
- | The fields are as follows: | + | |
- | + | ||
- | * name - The person' | + | |
- | * email - The person' | + | |
- | * url - Any valid URL. This will usually be the person' | + | |
- | + | ||
- | ==== Mandatory fields ==== | + | |
- | + | ||
- | * **id**: Contains the mod identifier - a string value matching the '' | + | |
- | * **version**: Contains the mod version - a string value, optionally matching the [[https:// | + | |
- | + | ||
- | ==== Optional fields (mod loading) ==== | + | |
- | + | ||
- | * **envType**: | + | |
- | * "", | + | |
- | * " | + | |
- | * " | + | |
- | * **initializers**: | + | |
- | * **mixins**: Contains a list of mixin configuration files for the Mixin library as filenames relative to the mod root - an array of (can be mixed): | + | |
- | * string values, | + | |
- | * objects containing a " | + | |
- | + | ||
- | ==== Optional fields (metadata) ==== | + | |
- | + | ||
- | * **name**: Contains the user-facing mod name - a string value. If not present, assume it matches **id**. | + | |
- | * **description**: | + | |
- | * **authors**: | + | |
- | * **contributors**: | + | |
- | * **contact**: | + | |
- | * The following keys are officially defined, and have an enforced format: | + | |
- | * **email**: Contact e-mail pertaining to the mod. Must be a valid e-mail address. | + | |
- | * **irc**: IRC channel pertaining to the mod. Must be of the format '' | + | |
- | * **homepage**: | + | |
- | * **issues**: Mod issue tracker. Must be a valid HTTP/HTTPS address. | + | |
- | * **sources**: | + | |
- | * The list is not exhaustive - mods may provide additional, non-standard keys (such as **discord**, | + | |
- | * **license**: | + | |
- | * This should provide the complete set of preferred licenses conveying the entire mod package. In other words, compliance with all listed licenses should be sufficient for usage, redistribution, | + | |
- | * For cases where a part of code is dual-licensed, | + | |
- | * To aid automated tools, it is recommended to use [[https:// | + | |
- | + | ||
- | ===== Version 0 ===== | + | |
- | + | ||
- | This version is utilized if the " | + | |
- | + | ||
- | //TODO: Document me!// | + |