@sugoidogo/packwiz-extras-lib
    Preparing search index...

    Interface PackMetaData

    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.

    interface PackMetaData {
        author?: string;
        description?: string;
        index: { file: string; hash?: string; "hash-format"?: HashFormat };
        name: string;
        options?: {
            "acceptable-game-versions"?: string[];
            "datapack-folder"?: string;
            "meta-folder"?: string;
            "meta-folder-base"?: string;
            "mods-folder"?: string;
            "no-internal-hashes"?: boolean;
        };
        "pack-format": string;
        version?: string;
        versions: {
            fabric?: string;
            forge?: string;
            liteloader?: string;
            minecraft: string;
            neoforge?: string;
            quilt?: string;
        };
    }
    Index

    Properties

    author? description? index name options? pack-format version? versions

    Properties

    author?: string

    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

    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.

    index: { file: string; hash?: string; "hash-format"?: HashFormat }

    Information about the index file in this modpack.

    Type Declaration

    • file: string

      The path to the file that contains the index.

      Path

    • Optionalhash?: string

      The hash of the index file, as a string.

      Hash

    • Optionalhash-format?: HashFormat

      The hash format for the hash of the index file.

      HashFormat

    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.

    options?: {
        "acceptable-game-versions"?: string[];
        "datapack-folder"?: string;
        "meta-folder"?: string;
        "meta-folder-base"?: string;
        "mods-folder"?: string;
        "no-internal-hashes"?: boolean;
    }

    Additional options

    Type Declaration

    • Optionalacceptable-game-versions?: string[]

      A list of additional Minecraft versions to accept when installing or updating mods.

      https://packwiz.infra.link/tutorials/creating/adding-mods/

    • Optionaldatapack-folder?: string

      The folder in which datapacks are to be added; specific to the datapack loader mod you use, and must be set to add datapacks (that are not bundled as mods)

      Path

    • Optionalmeta-folder?: string

      The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)

    • Optionalmeta-folder-base?: string

      The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour)

      Path

    • Optionalmods-folder?: string

      deprecated; aliassed to meta-folder

    • Optionalno-internal-hashes?: boolean

      If this is set to true, packwiz will not generate hashes of local files, to prevent merge conflicts and inconsistent hashes when using git/etc.

      • packwiz refresh --build can be used in this mode to generate internal hashes for distributing the pack with packwiz-installer
    "pack-format": string

    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

    version?: string

    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.

    versions: {
        fabric?: string;
        forge?: string;
        liteloader?: string;
        minecraft: string;
        neoforge?: string;
        quilt?: string;
    }

    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.

    Type Declaration

    • Optionalfabric?: string

      The version of Fabric loader used by this modpack.

    • Optionalforge?: string

      The version of Forge used by this modpack. This version must not include the Minecraft version as a prefix.

    • Optionalliteloader?: string

      The version of Liteloader used by this modpack.

    • minecraft: string

      The version of Minecraft used by this modpack. This should be in the format used by the version.json files.

    • Optionalneoforge?: string

      The version of NeoForge used by this modpack.

      This is an undocumented variable in packwiz, so this documentation may be inaccurate.

    • Optionalquilt?: string

      The version of Quilt loader used by this modpack.

    Settings

    Member Visibility

    On This Page

    Properties