The structure of a Packwiz metafile.

interface Metafile {
    description?: string;
    filename: string;
    isDefault: boolean;
    isOptional: boolean;
    name: string;
    provider: UrlProvider;
    side: Side;
}

Properties

description?: string

The description of the file. This should be shown to end users.

filename: string

The name that the file should have when downloaded.

isDefault: boolean

Whether the file is the default for the mod. If this is true, but isOptional is also true, the end user should be asked if they want to download the file.

isOptional: boolean

Whether the file is optional. If true, the end user should be prompted to download the file.

name: string

A human-readable name for the file.

provider: UrlProvider

The provider to use to download / update the file. All consuming applications should be doing with this is downloading the file. Updates are handled by Packwiz itself.

side: Side

Whether the file is for the client or server. Consuming applications should respect this!