diff options
| author | cpw <cpw+github@weeksfamily.ca> | 2022-06-09 16:39:00 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-06-09 16:39:00 -0400 |
| commit | 800cd6407e8585ff0fa674847605e284e3b1ec92 (patch) | |
| tree | 37b76e3fd23c8b318a43258325c9e61c72b105aa /src/main | |
| parent | 8a16ae06c9158db67bcfca03b072a0f1390bf880 (diff) | |
displayTest option in mods.toml (#8656)
* displayTest option in mods.toml
* "MATCH_VERSION" (or none) is existing match version string behaviour
* "IGNORE_SERVER_VERSION" accepts anything and sends special SERVERONLY string
* "IGNORE_ALL_VERSION" accepts anything and sends an empty string
* "NONE" allows the mod to supply their own displaytest using the IExtensionPoint mechanism.
* Update display test with feedback and added the mods.toml discussion in mdk.
Diffstat (limited to 'src/main')
| -rw-r--r-- | src/main/resources/META-INF/mods.toml | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/src/main/resources/META-INF/mods.toml b/src/main/resources/META-INF/mods.toml index 472db36..43ca177 100644 --- a/src/main/resources/META-INF/mods.toml +++ b/src/main/resources/META-INF/mods.toml @@ -32,6 +32,14 @@ logoFile="examplemod.png" #optional 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 +# Display Test controls the display for your mod in the server connection screen +# 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. +# 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. +# 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. +# 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. +# 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. +#displayTest="MATCH_VERSION" # MATCH_VERSION is the default if nothing is specified (#optional) + # 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 |