frog.mod.toml Specification
Full Example
toml
[frog]
format_version = "1.0.0" # the version of this file format
[frog.mod]
id = "example_mod" # Your mod's id
name = "Example Mod"# The name of your mod
version = "1.0.0" # the mod version, must respect SemVer
license = "CC0-1.0" # License (SPDX Format recommended)
credits = [ # List of Person declarations
{ name = "You", roles = ["author", "other_role"] }
]
[frog.dependencies] # Dependency declarations
# For all dependencies only the id and version (range) are required.
depends = [
{ id = "other_mod", versions = ">=0.2.0", name = "Other Mod", link = "https://modrinth.com/mod/<slug>" }
]
breaks = [
{ id = "old_mod", versions = "*" }
]
suggests = [
{ id = "frogloader", versions = "*" }
]
provides = [
{ id = "provided_mod", version = "2.0.0" } # note: provides does not support version ranges, only a single version!
]
[frog.extensions] # key-value pairs for whatever else is needed (Entrypoints, custom values, lists of files, indicators...)
mixin = "example_mod.mixins.json"
accesswidener = "example_mod.accesswidener"
prelaunch = "com.example.frog.PreLaunch"
loading_type = "required" # the type 'required' is implicit if it isn't present. Other values are not specified, but using 'optional' is recommended.
These keys are automatically inserted by Phytotelma for generated metadata files and their host mods respectively. You should never need to insert them yourself.
toml
included_jars = [[
{ id = "mod_id", path = "META-INF/jars/mod.jar" }
]]
phytotelma.generated = true