pack.toml

The main modpack file for a packwiz modpack. This is the first file loaded, to allow the modpack downloader to download all the files in the modpack.

Properties

Property	Type	Required	Description
`index`	object	Yes	Information about the index file in this modpack.
`name`	string	Yes	The name of the modpack. This can be displayed in user interfaces to identify the pack, and it does not need to be unique between packs.
`pack-format`	string	Yes	A version string identifying the pack format and version of it. Currently, this pack format uses version 1.1.0.
			If it is not defined, default to "packwiz:1.0.0" for backwards-compatibility with packs created before this field was added.

			If it is defined:
			- All consumers should fail to load the modpack if it does not begin with "packwiz:"
			- All consumers should fail to load the modpack if the latter section is not valid semver as defined in https://semver.org/spec/v2.0.0.html
			- All consumers should fail to load the modpack if the major version is greater than the version they support
			- Consumers can suggest updating themselves if the minor version is greater than the version they implement
			- Pack tools should suggest and support migration when they support a version newer than this field
`versions`	object	Yes	The versions of components used by this modpack - usually Minecraft and the mod loader this pack uses. The existence of a component implies that it should be installed. These values can also be used by tools to determine which versions of mods should be installed.
`author`	string	No	The author(s) of the modpack. This is output when exporting to the CurseForge pack format, and can be displayed in user interfaces.
`description`	string	No	A short description of the modpack. This is output when exporting to the Modrinth pack format, but is not currently used elsewhere by the tools or installer.
`version`	string	No	The version of the modpack. This is output when exporting to the CurseForge pack format, but is not currently used elsewhere by the tools or installer. It must not be used for determining if the modpack is outdated.

index

Information about the index file in this modpack.

Properties

Property	Type	Required	Description
`file`	string	Yes	The path to the file that contains the index.

			A relative path using forward slashes. Must not reference a file outside the pack root, and should not include characters or filenames restricted on common operating systems.

			Implementations must support special characters including those that are percent-encoded in URLs, such as spaces and square brackets. Implementations must guard against path traversal attacks and manually validate paths.
`hash-format`	string	Yes	The hash format for the hash of the index file.

			The hash algorithm used to determine if a file is valid. All functions listed must be supported by tools implementing the packwiz pack format. Possible values are: `sha256`, `sha512`, `sha1`, `md5`, `murmur2`.
`hash`	string	Yes	The hash of the index file, as a string.

			Binary hashes should be stored as hexadecimal, and case should be ignored during parsing. Numeric hashes (e.g. Murmur2) should still be stored as a string, to ensure the value is preserved correctly.

versions

The versions of components used by this modpack - usually Minecraft and the mod loader this pack uses. The existence of a component implies that it should be installed. These values can also be used by tools to determine which versions of mods should be installed.

Properties

Property	Type	Required	Description
`minecraft`	string	Yes	The version of Minecraft used by this modpack. This should be in the format used by the version.json files.
`fabric`	string	No	The version of Fabric loader used by this modpack.
`forge`	string	No	The version of Forge used by this modpack. This version must not include the Minecraft version as a prefix.
`liteloader`	string	No	The version of Liteloader used by this modpack.
`quilt`	string	No	The version of Quilt loader used by this modpack.