Type Alias ModOptions

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§

author: string | string[]

The mod authors.

clean?: boolean

Clean the output directory before building.

description?: string

The mod description.

iconPath?: string

The path to the mod icon file.

id: string

The mod unique identifier.

name: string

The mod name.

output?: string

The output directory for the built mod.

pretty?: boolean

Pretty print the output XML files.

previewPath?: string

The path to the mod preview file

supportedVersions: string[]

The supported game versions.

version: string

The mod version.