Type Alias ModOptions

Source
type ModOptions = {
    author: string | string[];
    clean?: boolean;
    description?: string;
    iconPath?: string;
    id: string;
    name: string;
    output?: string;
    pretty?: boolean;
    previewPath?: string;
    supportedVersions: string[];
    version: string;
}

Properties§

Source§

author: string | string[]

The mod authors.

Source§

clean?: boolean

Clean the output directory before building.

Source§

description?: string

The mod description.

Source§

iconPath?: string

The path to the mod icon file.

Source§

id: string

The mod unique identifier.

Source§

name: string

The mod name.

Source§

output?: string

The output directory for the built mod.

Source§

pretty?: boolean

Pretty print the output XML files.

Source§

previewPath?: string

The path to the mod preview file

Source§

supportedVersions: string[]

The supported game versions.

Source§

version: string

The mod version.