2018-09-30 18:29:03 +00:00
# This is an example mods.toml file. It contains the data relating to the loading mods.
# There are several mandatory fields (#mandatory), and many more that are optional (#optional).
# The overall format is standard TOML format, v0.5.0.
# Note that there are a couple of TOML lists in this file.
# Find more information on toml format here: https://github.com/toml-lang/toml
# The name of the mod loader type to load - for regular FML @Mod mods it should be javafml
modLoader = "javafml" #mandatory
2019-01-05 05:14:07 +00:00
# A version range to match for said mod loader - for regular FML @Mod it will be the forge version
2020-11-07 02:11:26 +00:00
loaderVersion = "[@FORGE_SPEC_VERSION@,)" #mandatory This is typically bumped every Minecraft version by Forge. See our download page for lists of versions.
2020-07-28 01:06:48 +00:00
# The license for you mod. This is mandatory metadata and allows for easier comprehension of your redistributive properties.
# Review your options at https://choosealicense.com/. All rights reserved is the default copyright stance, and is thus the default here.
license = "All rights reserved"
2018-09-30 18:29:03 +00:00
# A URL to refer people to when problems occur with this mod
2020-12-26 19:39:14 +00:00
#issueTrackerURL="https://change.me.to.your.issue.tracker.example.invalid/" #optional
2018-09-30 18:29:03 +00:00
# A list of mods - how many allowed here is determined by the individual mod loader
[ [ mods ] ] #mandatory
# The modid of the mod
modId = "examplemod" #mandatory
# The version number of the mod - there's a few well known ${} variables useable here or just hardcode it
2020-11-07 02:11:26 +00:00
# ${file.jarVersion} will substitute the value of the Implementation-Version as read from the mod's JAR file metadata
# see the associated build.gradle script for how to populate this completely automatically during a build
2019-01-27 16:37:56 +00:00
version = "${file.jarVersion}" #mandatory
2018-09-30 18:29:03 +00:00
# A display name for the mod
displayName = "Example Mod" #mandatory
2020-12-26 19:39:14 +00:00
# A URL to query for updates for this mod. See the JSON update specification https://mcforge.readthedocs.io/en/latest/gettingstarted/autoupdate/
#updateJSONURL="https://change.me.example.invalid/updates.json" #optional
2019-02-16 22:42:30 +00:00
# A URL for the "homepage" for this mod, displayed in the mod UI
2020-12-26 19:39:14 +00:00
#displayURL="https://change.me.to.your.mods.homepage.example.invalid/" #optional
2019-02-16 22:42:30 +00:00
# A file name (in the root of the mod JAR) containing a logo for display
logoFile = "examplemod.png" #optional
# A text field displayed in the mod UI
credits = "Thanks for this example mod goes to Java" #optional
# A text field displayed in the mod UI
authors = "Love, Cheese and small house plants" #optional
2018-09-30 18:29:03 +00:00
# The description text for the mod (multi line!) (#mandatory)
description = '' '
This is a long form description of the mod . You can write whatever you want here
Have some lorem ipsum .
Lorem ipsum dolor sit amet , consectetur adipiscing elit . Sed mollis lacinia magna . Orci varius natoque penatibus et magnis dis parturient montes , nascetur ridiculus mus . Sed sagittis luctus odio eu tempus . Interdum et malesuada fames ac ante ipsum primis in faucibus . Pellentesque volutpat ligula eget lacus auctor sagittis . In hac habitasse platea dictumst . Nunc gravida elit vitae sem vehicula efficitur . Donec mattis ipsum et arcu lobortis , eleifend sagittis sem rutrum . Cras pharetra quam eget posuere fermentum . Sed id tincidunt justo . Lorem ipsum dolor sit amet , consectetur adipiscing elit .
'' '
# A dependency - use the . to indicate dependency for a specific modid. Dependencies are optional.
[ [ dependencies . examplemod ] ] #optional
# the modid of the dependency
modId = "forge" #mandatory
# Does this dependency have to exist - if not, ordering below must be specified
mandatory = true #mandatory
# The version range of the dependency
2020-11-07 02:11:26 +00:00
versionRange = "[@FORGE_SPEC_VERSION@,)" #mandatory
2018-09-30 18:29:03 +00:00
# An ordering relationship for the dependency - BEFORE or AFTER required if the relationship is not mandatory
ordering = "NONE"
# Side this dependency is applied on - BOTH, CLIENT or SERVER
side = "BOTH"
# Here's another dependency
[ [ dependencies . examplemod ] ]
modId = "minecraft"
mandatory = true
2020-11-07 02:11:26 +00:00
# This version range declares a minimum of the current minecraft version up to but not including the next major version
versionRange = "[@MC_VERSION@,@MC_NEXT_VERSION@)"
2018-09-30 18:29:03 +00:00
ordering = "NONE"
2019-07-20 16:06:06 +00:00
side = "BOTH"