Interface ModConfig

The structure of the "mod.json" file that D2RMM mods should provide.

Since

D2RMM v1.0.0

interface ModConfig {
    $schema?: string;
    author?: string;
    config?: readonly ModConfigFieldOrSection[];
    description?: string;
    name: string;
    version?: string;
    website?: string;
}

Properties

$schema? author? config? description? name version? website?

Properties

Optional $schema

$schema?: string

The JSON schema used to validate the file.

Since

D2RMM v1.8.0

Optional author

author?: string

The author of the mod.

Since

D2RMM v1.0.0

Optional config

config?: readonly ModConfigFieldOrSection[]

The configuration for the mod. This allows the mod to set up a custom configuration UI that the user can interact with to customize the behavior of the mod.

See

Since

D2RMM v1.0.0

Optional description

description?: string

A short description of the mod.

Since

D2RMM v1.0.0

name

name: string

The name of the mod.

Since

D2RMM v1.0.0

Optional version

version?: string

The version of the mod.

Since

D2RMM v1.0.0

Optional website

website?: string

The website of the mod. Ideally, this should link to the Nexus Mods page for the mod.

Since

D2RMM v1.0.0

Settings

Member Visibility

Theme

On This Page

$schemaauthorconfigdescriptionnameversionwebsite