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

    Interface PackFileMetaData

    A metadata file which references an external file from a URL. This allows for side-only mods, optional mods and stores metadata to allow finding updates from Modrinth and CurseForge. The "mod" terminology is used a lot here, but this should work for any file.

    interface PackFileMetaData {
        download: {
            hash: string;
            "hash-format": HashFormat;
            mode?: "metadata:curseforge";
            url?: string;
        };
        filename: string;
        name: string;
        option?: { default?: boolean; description?: string; optional: boolean };
        side?: Side;
        update?: {
            curseforge?: { "file-id": number; "project-id": number };
            modrinth?: { "mod-id": string; version: string };
        };
    }
    Index

    Properties

    download filename name option? side? update?

    Properties

    download: {
        hash: string;
        "hash-format": HashFormat;
        mode?: "metadata:curseforge";
        url?: string;
    }

    Information about how to download this mod.

    Type Declaration

    • hash: string

      The hash of the specified file, as a string.

      Hash

    • hash-format: HashFormat

      The hash format for the hash of the specified file.

      HashFormat

    • Optionalmode?: "metadata:curseforge"

      Indicates that this file must be downloaded using the curseforge API to retreive a download url, instead of storing the direct download url in the pack, to comply with curseforge API usage requirements.

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

    • Optionalurl?: string

      The URL to download the mod from.

      Url

    filename: string

    The destination path of the mod file, relative to this file.

    Path

    name: string

    The name of the mod, which can be displayed in user interfaces to identify the mod. It does not need to be unique between mods, although this may cause confusion.

    option?: { default?: boolean; description?: string; optional: boolean }

    Information about the optional state of this mod. When excluded, this indicates that the mod is not optional.

    Type Declaration

    • Optionaldefault?: boolean

      If true, the mod will be enabled by default. If false, the mod will be disabled by default. If a pack format does not support optional mods but it does support disabling mods, the mod will be disabled if it defaults to being disabled.

    • Optionaldescription?: string

      A description displayed to the user when they select optional mods. This should explain why or why not the user should enable the mod.

    • optional: boolean

      Whether or not the mod is optional. This can be set to false if you want to keep the description but make the mod required.

    side?: Side

    The side on which this mod should be installed.

    Side

    update?: {
        curseforge?: { "file-id": number; "project-id": number };
        modrinth?: { "mod-id": string; version: string };
    }

    Information about how to update the download details of this mod with tools.

    If this object does not exist or there are no defined update sources, the mod will not be automatically updated.

    If there are multiple defined update sources, one of them will be chosen. The source that is chosen is not defined, so it is therefore dependent on the implementation of the tool (may not be deterministic, so do not rely on one source being chosen over another).

    Type Declaration

    • Optionalcurseforge?: { "file-id": number; "project-id": number }

      An update source for updating mods downloaded from CurseForge.

      • file-id: number

        An integer representing the unique file ID of this mod file. This can be used if more metadata needs to be obtained relating to the mod.

      • project-id: number

        An integer representing the unique project ID of this mod. Updating will retrieve the latest file for this project ID that is valid (correct Minecraft version, release channel, modloader, etc.).

    • Optionalmodrinth?: { "mod-id": string; version: string }

      An update source for updating mods downloaded from Modrinth.

      • mod-id: string

        A string representing the unique mod ID of this mod. Updating will retrieve the latest file for this project ID that is valid (correct Minecraft version, release channel, modloader, etc.).

      • version: string

        A string representing the unique version ID of this file. This can be used if more metadata needs to be obtained relating to the mod.

    Settings

    Member Visibility

    On This Page

    Properties