Interface _WorldManifestData

Manifest properties exclusive to worlds.

interface _WorldManifestData {
    background?: string;
    coreVersion: string;
    demo?: { sourceZip?: string };
    joinTheme?: string;
    nextSession?: string;
    resetKeys?: boolean;
    safeMode?: boolean;
    system: string;
    systemVersion: string;
}

Properties

background? coreVersion demo? joinTheme? nextSession? resetKeys? safeMode? system systemVersion

Properties

Optionalbackground

background?: string

A web URL or local file path which provides a background banner image

coreVersion

coreVersion: string

The version of the core software for which this world has been migrated

Optionaldemo

demo?: { sourceZip?: string }

Configuration for demo worlds.

Type declaration

  • OptionalsourceZip?: string

    Path to the world's fresh data.

OptionaljoinTheme

joinTheme?: string

The theme to use for this world's join page.

OptionalnextSession

nextSession?: string

An ISO datetime string when the next game session is scheduled to occur

OptionalresetKeys

resetKeys?: boolean

Should user access keys be reset as part of the next launch?

OptionalsafeMode

safeMode?: boolean

Should the world launch in safe mode?

system

system: string

The game system name which this world relies upon

systemVersion

systemVersion: string

The version of the game system for which this world has been migrated

Settings

Member Visibility

On This Page

Properties