Information about how to download this mod.
The hash of the specified file, as a string. Binary hashes should be stored as hexadecimal, and case should be ignored during parsing. Numeric hashes (e.g. Murmur2) should still be stored as a string, to ensure the value is preserved correctly.
The hash format (algorithm) for the hash of the specified file.
The URL to download the mod from.
The destination path of the mod file, relative to this file.
The name of the mod, which can be displayed in user interfaces to identify the mod. It does not need to be unique between mods, although this may cause confusion.
Information about the optional state of this mod. When excluded, this indicates that the mod is not optional.
If true, the mod will be enabled by default. If false, the mod will be disabled by default. If a pack format does not support optional mods but it does support disabling mods, the mod will be disabled if it defaults to being disabled.
A description displayed to the user when they select optional mods. This should explain why or why not the user should enable the mod.
Whether or not the mod is optional. This can be set to false if you want to keep the description but make the mod required.
The side on which this mod should be installed. Defaults to "both".
Information about how to update the download details of this mod with tools. The information stored is specific to the update interface (see implementations of UpdateImplementation).
If this value does not exist or there are no defined update values, the mod will not be automatically updated.
If there are multiple defined update values, one of them will be chosen. The value that is chosen is not defined, so it is therefore dependant on the implementation of the tool (may not be deterministic, so do not rely on one value being chosen over another).
This field theoretically supports other update implementations - and you are free to implement them yourself - but adding documentation here would be preferable.
Generated using TypeDoc
A uhhh mod TODO
Example:
name = "Demagnetize" filename = "demagnetize-1.12.2-1.1.1.jar" side = "both" [download] url = "https://edge.forgecdn.net/files/2834/566/demagnetize-1.12.2-1.1.1.jar" hash-format = "murmur2" hash = "2953308073" [update] [update.curseforge] file-id = 2834566 project-id = 301356 release-channel = "beta"