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

    Interface SystemManifestData

    The data structure for system.json.

    interface SystemManifestData {
        authors?: PackageAuthorData[];
        background?: string;
        bugs?: string;
        changelog?: string;
        compatibility?: PackageCompatibilityData;
        description?: string;
        documentTypes?: DocumentTypesConfiguration;
        download?: string;
        esmodules?: string[];
        exclusive?: boolean;
        flags?: PackageFlagsData;
        grid?: {
            diagonals?: GridDiagonalRule;
            distance?: number;
            type?: GridType;
            units?: string;
        };
        id: string;
        initiative?: string;
        languages?: PackageLanguageData[];
        license?: string;
        manifest?: string;
        media: PackageMediaData[];
        packFolders?: PackFolderData[];
        packs?: PackageCompendiumData[];
        persistentStorage?: boolean;
        primaryTokenAttribute?: string;
        protected?: boolean;
        readme?: string;
        relationships?: PackageRelationshipsData;
        scripts?: string[];
        secondaryTokenAttribute?: string;
        socket?: boolean;
        styles?: string[];
        title: string;
        type: "system";
        url?: string;
        version: string;
    }
    Index

    Properties

    authors? background? bugs? changelog? compatibility? description? documentTypes? download? esmodules? exclusive? flags? grid? id initiative? languages? license? manifest? media packFolders? packs? persistentStorage? primaryTokenAttribute? protected? readme? relationships? scripts? secondaryTokenAttribute? socket? styles? title type url? version

    Properties

    authors?: PackageAuthorData[]

    An array of author objects who are co-authors of this package.

    background?: string

    A web URL or local file path which provides a default background banner for worlds which are created using this system

    bugs?: string

    A web url where bug reports may be submitted and tracked

    changelog?: string

    A web url where notes detailing package updates are available

    compatibility?: PackageCompatibilityData

    The compatibility of this version with the core Foundry software. See https://foundryvtt.com/article/versioning/ for more info on how the core software structures its releases.

    description?: string

    An optional package description, may contain HTML. Visible on the Setup screen in "gallery" view as well as in the "Module Management" application.

    documentTypes?: DocumentTypesConfiguration

    Additional document subtypes provided by this system.

    download?: string

    A publicly accessible web URL where the source files for this package may be downloaded. Required in order to support package installation.

    esmodules?: string[]

    An array of urls or relative file paths for ESModule files to include

    exclusive?: boolean

    Whether this package is a free Exclusive pack.

    flags?: PackageFlagsData

    An object of optional key/value flags. Packages can use this namespace for their own purposes, preferably within a namespace matching their package ID.

    grid?: {
        diagonals?: GridDiagonalRule;
        distance?: number;
        type?: GridType;
        units?: string;
    }

    The default grid settings to use for Scenes in this system.

    Type Declaration

    • Optionaldiagonals?: GridDiagonalRule

      The default rule used by this system for diagonal measurement on square and hexagonal grids.

    • Optionaldistance?: number

      A default distance measurement to use for Scenes in this system.

    • Optionaltype?: GridType

      A default grid type to use for Scenes in this system.

    • Optionalunits?: string

      A default unit of measure to use for distance measurement in this system.

    id: string

    The machine-readable unique package id, should be lower-case with no spaces or special characters

    initiative?: string

    A default initiative formula used for this system.

    languages?: PackageLanguageData[]

    An array of language data objects which are included by this package

    license?: string

    A web url or relative file path where license details may be found

    manifest?: string

    A publicly accessible web URL which provides the latest available package manifest file. Required in order to support package updates.

    media: PackageMediaData[]

    An array of objects containing media info about the package.

    packFolders?: PackFolderData[]

    An array of pack folders that will be initialized once per world.

    packs?: PackageCompendiumData[]

    An array of compendium packs which are included by this package

    persistentStorage?: boolean

    Whether updates should leave the contents of the package's /storage folder.

    primaryTokenAttribute?: string

    An Actor data attribute path to use for Token primary resource bars

    protected?: boolean

    Whether this package uses the protected content access system.

    readme?: string

    A web url or relative file path where readme instructions may be found

    relationships?: PackageRelationshipsData

    An organized object of relationships to other Packages

    scripts?: string[]

    An array of urls or relative file paths for JavaScript files to include

    secondaryTokenAttribute?: string

    An Actor data attribute path to use for Token secondary resource bars

    socket?: boolean

    Whether to require a package-specific socket namespace for this package

    styles?: string[]

    An array of urls or relative file paths for CSS stylesheet files to include

    title: string

    The human-readable package title, containing spaces and special characters

    type: "system"

    The package type among world, system, and module

    url?: string

    A web url where more details about the package may be found

    version: string

    The current package version. It is recommended to stick to dot-separated numbers like "5.0.3" and to not include a leading "v" to avoid string comparison. See foundry.utils.isNewerVersion.

    Settings

    Member Visibility

    On This Page

    Properties