diff --git a/src/main/resources/META-INF/mods.toml b/src/main/resources/META-INF/mods.toml index 89cadbc..587cef0 100644 --- a/src/main/resources/META-INF/mods.toml +++ b/src/main/resources/META-INF/mods.toml @@ -5,31 +5,44 @@ # 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 the FML version. This is currently 47. loaderVersion="${loader_version_range}" #mandatory + # 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="${mod_license}" + # A URL to refer people to when problems occur with this mod #issueTrackerURL="https://change.me.to.your.issue.tracker.example.invalid/" #optional + # A list of mods - how many allowed here is determined by the individual mod loader [[mods]] #mandatory + # The modid of the mod modId="${mod_id}" #mandatory + # The version number of the mod version="${mod_version}" #mandatory + # A display name for the mod displayName="${mod_name}" #mandatory + # A URL to query for updates for this mod. See the JSON update specification https://docs.neoforged.net/docs/misc/updatechecker/ #updateJSONURL="https://change.me.example.invalid/updates.json" #optional + # A URL for the "homepage" for this mod, displayed in the mod UI #displayURL="https://change.me.to.your.mods.homepage.example.invalid/" #optional + # 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="" #optional + # A text field displayed in the mod UI authors="${mod_authors}" #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. @@ -40,6 +53,18 @@ authors="${mod_authors}" #optional # The description text for the mod (multi line!) (#mandatory) description='''${mod_description}''' + +# The [[mixins]] block allows you to declare your mixin config to FML so that it gets loaded. +#[[mixins]] +#config="${mod_id}.mixins.json" + +# The [[accessTransformers]] block allows you to declare where your AT file is. +# If this block is omitted, a fallback attempt will be made to load an AT from META-INF/accesstransformer.cfg +#[[accessTransformers]] +#file="META-INF/accesstransformer.cfg" + +# The coremods config file path is not configurable and is always loaded from META-INF/coremods.json + # A dependency - use the . to indicate dependency for a specific modid. Dependencies are optional. [[dependencies.${mod_id}]] #optional # the modid of the dependency @@ -58,6 +83,7 @@ description='''${mod_description}''' ordering="NONE" # Side this dependency is applied on - BOTH, CLIENT, or SERVER side="BOTH" + # Here's another dependency [[dependencies.${mod_id}]] modId="minecraft"