index.toml

The index file of the modpack, storing references to every file to be downloaded in the pack.

Properties

Property	Type	Required	Description
hash-format	string	Yes	The default hash format for every file in the index.
			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.
files	object[]	No	The files listed in this index. If it is not defined, defaults to an empty list.

files

A single file in the index, to be downloaded by the modpack installer.

Properties

Property	Type	Required	Description
file	string	Yes	The path to the file to be downloaded, relative to this index file.
			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	string	Yes	The hash of the specified 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.
alias	string	No	The name with which this file should be downloaded, instead of the filename specified in the path. Not compatible with metafile, and may not be very well supported.
hash-format	string	No	The hash format for the hash of the specified file. Defaults to the hash format specified in the index - ideally remove this value if it is equal to the hash format for the index to save space.
			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.
metafile	boolean	No	True when this entry points to a .toml metadata file, which references a file outside the pack.
preserve	boolean	No	When this is set to true, the file is not overwritten if it already exists, to preserve changes made by a user.