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.
Example:
name = "My Modpack"
[index]
file = "index.toml"
hash-format = "sha256"
hash = "e23c098c867dbb45f672cdb407392c7ed1eaa26d21b969ecf64a49d2a937fc0e"
[versions]
forge = "14.23.5.2838"
minecraft = "1.12.2"
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. |
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. |
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. |
hash-format |
string | Yes | A hashing format used to detect if a file has changed. You may use your own hash format, but the valid values here should be supported and expected for most packs, especially SHA-256 and Murmur2. Possible values are: md5, murmur2, sha256, sha512. |
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.
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 e.g. 1.17.1, 16w02a etc. This value can be used by tools to determine which versions of mods should be installed. |
fabric |
string | No | The version of the Fabric loader used by this modpack, for example 0.12.1. |
forge |
string | No | The version of Forge used by this modpack, for example 14.23.5.2838. This version must not include the Minecraft version as a prefix. |
liteloader |
string | No | The version of Liteloader used by this modpack, for example 1.12.2-SNAPSHOT. |