Skip to content

Commit e430f97

Browse files
authored
update mods.toml with latest 1.20.1 Forge vars (#362)
1 parent ff78acd commit e430f97

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

src/main/templates/META-INF/mods.toml

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# This is an example neoforge.mods.toml file. It contains the data relating to the loading mods.
1+
# This is an example mods.toml file. It contains the data relating to the loading mods.
22
# There are several mandatory fields (#mandatory), and many more that are optional (#optional).
33
# The overall format is standard TOML format, v0.5.0.
44
# Note that there are a couple of TOML lists in this file.
55
# Find more information on toml format here: https://github.com/toml-lang/toml
66
# The name of the mod loader type to load - for regular FML @Mod mods it should be javafml
77
modLoader="javafml" #mandatory
88

9-
# A version range to match for said mod loader - for regular FML @Mod it will be the FML version. This is currently 2.
10-
loaderVersion="${loader_version_range}" #mandatory
9+
# A version range to match for said mod loader - for regular FML @Mod it will be the Forge version
10+
loaderVersion="${loader_version_range}" #mandatory This is typically bumped every Minecraft version by Forge. See download page for lists of versions.
1111

1212
# The license for you mod. This is mandatory metadata and allows for easier comprehension of your redistributive properties.
1313
# Review your options at https://choosealicense.com/. All rights reserved is the default copyright stance, and is thus the default here.
@@ -16,6 +16,10 @@ license="${mod_license}"
1616
# A URL to refer people to when problems occur with this mod
1717
#issueTrackerURL="https://change.me.to.your.issue.tracker.example.invalid/" #optional
1818

19+
# If your mod is purely client-side and has no multiplayer functionality (be it dedicated servers or Open to LAN),
20+
# set this to true, and Forge will set the correct displayTest for you and skip loading your mod on dedicated servers.
21+
#clientSideOnly=true #optional - defaults to false if absent
22+
1923
# A list of mods - how many allowed here is determined by the individual mod loader
2024
[[mods]] #mandatory
2125

@@ -27,8 +31,7 @@ version="${mod_version}" #mandatory
2731

2832
# A display name for the mod
2933
displayName="${mod_name}" #mandatory
30-
31-
# A URL to query for updates for this mod. See the JSON update specification https://docs.neoforged.net/docs/misc/updatechecker/
34+
# A URL to query for updates for this mod. See the JSON update specification https://docs.minecraftforge.net/en/latest/misc/updatechecker/
3235
#updateJSONURL="https://change.me.example.invalid/updates.json" #optional
3336

3437
# A URL for the "homepage" for this mod, displayed in the mod UI
@@ -43,6 +46,14 @@ displayName="${mod_name}" #mandatory
4346
# A text field displayed in the mod UI
4447
authors="${mod_authors}" #optional
4548

49+
# Display Test controls the display for your mod in the server connection screen
50+
# MATCH_VERSION means that your mod will cause a red X if the versions on client and server differ. This is the default behaviour and should be what you choose if you have server and client elements to your mod.
51+
# IGNORE_SERVER_VERSION means that your mod will not cause a red X if it's present on the server but not on the client. This is what you should use if you're a server only mod.
52+
# IGNORE_ALL_VERSION means that your mod will not cause a red X if it's present on the client or the server. This is a special case and should only be used if your mod has no server component.
53+
# NONE means that no display test is set on your mod. You need to do this yourself, see IExtensionPoint.DisplayTest for more information. You can define any scheme you wish with this value.
54+
# IMPORTANT NOTE: this is NOT an instruction as to which environments (CLIENT or DEDICATED SERVER) your mod loads on. Your mod should load (and maybe do nothing!) whereever it finds itself.
55+
#displayTest="MATCH_VERSION" # if nothing is specified, MATCH_VERSION is the default when clientSideOnly=false, otherwise IGNORE_ALL_VERSION when clientSideOnly=true (#optional)
56+
4657
# The description text for the mod (multi line!) (#mandatory)
4758
description='''${mod_description}'''
4859

@@ -52,11 +63,9 @@ description='''${mod_description}'''
5263
modId="forge" #mandatory
5364
# Does this dependency have to exist - if not, ordering below must be specified
5465
mandatory=true #mandatory
55-
# Optional field describing why the dependency is required or why it is incompatible
56-
# reason="..."
5766
# The version range of the dependency
5867
versionRange="${forge_version_range}" #mandatory
59-
# An ordering relationship for the dependency.
68+
# An ordering relationship for the dependency - BEFORE or AFTER required if the dependency is not mandatory
6069
# BEFORE - This mod is loaded BEFORE the dependency
6170
# AFTER - This mod is loaded AFTER the dependency
6271
ordering="NONE"

0 commit comments

Comments
 (0)