Skip to content

Commit

Permalink
Simplified the .toml file
Browse files Browse the repository at this point in the history
Did a quick update and simplified the .toml file so as not to confuse anyone looking to improve on this in the future
  • Loading branch information
TheGamersBrew authored Oct 1, 2021
1 parent 4d76d7d commit b09221b
Showing 1 changed file with 18 additions and 42 deletions.
60 changes: 18 additions & 42 deletions src/main/resources/META-INF/mods.toml
Original file line number Diff line number Diff line change
@@ -1,50 +1,26 @@
# 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
# A version range to match for said mod loader - for regular FML @Mod it will be the forge version
loaderVersion="[36,)" #mandatory This is typically bumped every Minecraft version by Forge. See our download page for lists of versions.
modLoader="javafml"
loaderVersion="[36,)"
license="The MIT License (MIT)"
# A URL to refer people to when problems occur with this mod
issueTrackerURL="https://github.com/racerxdl/minecrowdcontrol/issues" #optional
# A list of mods - how many allowed here is determined by the individual mod loader
[[mods]] #mandatory
# The modid of the mod
modId="minecrowdcontrol" #mandatory
# The version number of the mod - there's a few well known ${} variables useable here or just hardcode it
version="${file.jarVersion}" #mandatory
# A display name for the mod
displayName="Minecraft CrowdControl" #mandatory
# A URL to query for updates for this mod. See the JSON update specification <here>
updateJSONURL="https://raw.githubusercontent.com/racerxdl/minecrowdcontrol/master/update.json" #optional
# A URL for the "homepage" for this mod, displayed in the mod UI
displayURL="https://github.com/racerxdl/minecrowdcontrol/" #optional
# A file name (in the root of the mod JAR) containing a logo for display
logoFile="minecrowdcontrol.png" #optional
# A text field displayed in the mod UI
credits="Thanks for CrowdControl SDK!" #optional
# A text field displayed in the mod UI
authors="Lucas Teske" #optional
# The description text for the mod (multi line!) (#mandatory)

[[mods]]
modId="minecrowdcontrol"
version="${file.jarVersion}"
displayName="Minecraft CrowdControl"
displayURL="https://github.com/TheGamersBrew/minecrowdcontrol"
logoFile="minecrowdcontrol.png"
credits="Orginal Autor Credit goes to Lucas Teske. Thanks for CrowdControl SDK!"
authors="Updated by XzeroAir & The Gamers Brew"
description='''
This mod integrates with CrowdControl so you can stream at twitch and give crowd control habilities!
This mod integrates with CrowdControl so you can stream at twitch and give crowd control habilities! Works with Minecraft version 1.16.1 through 1.16.5.
'''
# A dependency - use the . to indicate dependency for a specific modid. Dependencies are optional.
[[dependencies.minecrowdcontrol]] #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
versionRange="[31,)" #mandatory
# An ordering relationship for the dependency - BEFORE or AFTER required if the relationship is not mandatory

[[dependencies.minecrowdcontrol]]
modId="forge"
mandatory=true
versionRange="[31,)"
ordering="NONE"
# Side this dependency is applied on - BOTH, CLIENT or SERVER
side="BOTH"
# Here's another dependency

[[dependencies.minecrowdcontrol]]
modId="minecraft"
mandatory=true
Expand Down

0 comments on commit b09221b

Please sign in to comment.