Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    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;
        type: "world";
    }
    Index

    Properties

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

    Properties

    background?: string

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

    coreVersion: string

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

    demo?: { sourceZip?: string }

    Configuration for demo worlds.

    Type Declaration

    • OptionalsourceZip?: string

      Path to the world's fresh data.

    joinTheme?: string

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

    nextSession?: string

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

    resetKeys?: boolean

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

    safeMode?: boolean

    Should the world launch in safe mode?

    system: string

    The game system name which this world relies upon

    systemVersion: string

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

    type: "world"

    The package type among world, system, and module

    Settings

    Member Visibility

    On This Page

    Properties