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

    Interface QuickstartManifestData

    interface QuickstartManifestData {
        adventures: Record<string, QuickstartAdventureData>;
        postImport?: boolean;
        world?: { background?: string; cover?: string; description?: string };
    }
    Index

    Properties

    adventures postImport? world?

    Properties

    adventures: Record<string, QuickstartAdventureData>

    A mapping of system IDs to an adventure to import for that system.

    postImport?: boolean

    Whether the adventure(s) requires post-import operations. Non-GMs will be blocked from joining the World while post-import operations are still pending.

    world?: { background?: string; cover?: string; description?: string }

    Configuration for the auto-created world.

    Type Declaration

    • Optionalbackground?: string

      The world's background image for the join page. If omitted, the first adventure's image is used.

    • Optionalcover?: string

      The cover image for the world on the setup page. If omitted, the first adventure's image is used.

    • Optionaldescription?: string

      The world's description. If omitted, the first adventure's description is used.

    Settings

    Member Visibility

    On This Page

    Properties