Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Pack

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"

Hierarchy

  • Pack

Index

Properties

Properties

index

index: object

Information about the Index file in this modpack.

Type declaration

  • file: Path

    The path to the file that contains the index.

  • hash: string

    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.

  • hash-format: HashFormat

    The hash format (algorithm) for the hash of the index file.

name

name: string

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

versions: object

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.

Type declaration

  • [component: string]: string | undefined

    This field theoretically supports other components - and you are free to implement them yourself - but adding documentation here would be preferable.

  • Optional fabric?: string

    The version of the Fabric loader used by this modpack, for example 0.7.2+build.174. The version of Yarn must also be specified for Fabric to be used.

  • Optional forge?: string

    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.

  • minecraft: string

    The version of Minecraft used by this modpack. This should be in the format used by the version.json files e.g. 1.12.2, 16w02a etc. This value can be used by tools to determine which versions of mods should be installed.

  • Optional yarn?: string

    The version of the Yarn mappings used by this modpack, for example 1.15.1-pre1+build.1.

Generated using TypeDoc