Foundry VTT - Base package Manifest

Base Module/system/World manifest to inherit from

Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/foundry-vtt-base-package-manifest/latest.json
Source https://www.schemastore.org/foundryvtt-base-package-manifest.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

id string required
Examples: "lib-wrapper", "dnd5e"
format=regexpattern=^[a-zA-Z0-9_-]+$
title string required
pattern=.+
description string required

This field can contain a more lengthy description of the package. This text can be used to describe the functionality, list contact information, provide recommendations to contributors or testers, or any other information you feel is important to provide. This field can contain HTML to structure and style your text. For a system, this is also a good place to include any special licensing or attribution information that you need to distribute.

Examples: "A minimalist game system which provides configurable Actor and Item templates to support free-form system agnostic game-play.", "<p>A module to integrate <a href="https://worldanvil.com" title="World Anvil" target="_blank">World Anvil</a> with Foundry Virtual Tabletop.</p>"
version string | number required
Examples: "1.0.0", "0.5.0-beta", "1.0", "9.361", "2023-04-08", "20220312"
name string
Examples: "lib-wrapper", "dnd5e"
format=regexpattern=^[a-zA-Z0-9_-]+$
author string
pattern=.+
authors object[]

An array listing each author as an object that contains a name and potentially some contact details.

uniqueItems=true
url string

A public URL.

Examples: "https://example.com", "https://raw.githubusercontent.com/foundryvtt/worldbuilding/master/system.json"
format=uripattern=^https?://[^.\s]+\.[^.\s]
license URL | File

A path to a license file relative to the root package folder or a publicly accessible URL which contains the software license that applies to this package.

Examples: "LICENSE.txt"
readme URL | File

A path to a read-me file relative to the root package folder or a publicly accessible URL which contains instructions or information about the package.

Examples: "https://gitlab.com/riccisi/foundryvtt-dice-so-nice/-/blob/master/README.md"
bugs string

A public URL.

Examples: "https://example.com", "https://raw.githubusercontent.com/foundryvtt/worldbuilding/master/system.json"
format=uripattern=^https?://[^.\s]+\.[^.\s]
changelog string

A public URL.

Examples: "https://example.com", "https://raw.githubusercontent.com/foundryvtt/worldbuilding/master/system.json"
format=uripattern=^https?://[^.\s]+\.[^.\s]
flags object

Flag data.

media object[]

(undocumented, intended to be used by core Foundry in the future)

compatibility object
3 nested properties
minimum string | number
Examples: "1.0.0", "0.5.0-beta", "1.0", "9.361", "2023-04-08", "20220312"
verified string | number
Examples: "1.0.0", "0.5.0-beta", "1.0", "9.361", "2023-04-08", "20220312"
maximum string | number
Examples: "1.0.0", "0.5.0-beta", "1.0", "9.361", "2023-04-08", "20220312"
minimumCoreVersion string | number
Examples: "1.0.0", "0.5.0-beta", "1.0", "9.361", "2023-04-08", "20220312"
compatibleCoreVersion string | number
Examples: "1.0.0", "0.5.0-beta", "1.0", "9.361", "2023-04-08", "20220312"
scripts File[]
Default:
[]
uniqueItems=true
esmodules File[]
Default:
[]
uniqueItems=true
styles File[]
Default:
[]
uniqueItems=true
languages object[]

A list of localization files that Foundry can use to translate strings.

packs object[]

Packages may come bundled with Compendium packs which include game content for various Document types. Compendium packs are defined as objects which have their own internal metadata structure.

relationships object

Packages can require modules, systems, or worlds be installed to allow their use. If a package has been installed with dependencies, but its dependencies are missing, it cannot be enabled.

4 nested properties
systems PackageRelationship[]

Will only allow the package to activated within Worlds which are running one of these systems and with a compatible version.

requires PackageRelationship[]

If a package has been installed with dependencies, but its dependencies are missing, it cannot be enabled.

recommends PackageRelationship[]

(undocumented, intended to be used by core Foundry in the future)

conflicts PackageRelationship[]

(undocumented, intended to be used by core Foundry in the future)

dependencies object[]
system string
socket boolean

A package may request for a specialized socket namespace to be provided. If set to true, a socket event will be handled by the server with the name system.${id} (for a system) or module.${id} (for a module), and will transact a arbitrary data object by broadcasting that data to all connected clients. This allows the package to have a reserved channel for messaging events which are needed to coordinate actions across multiple connected clients.

manifest string

A public URL.

Examples: "https://example.com", "https://raw.githubusercontent.com/foundryvtt/worldbuilding/master/system.json"
format=uripattern=^https?://[^.\s]+\.[^.\s]
download string

A public URL.

Examples: "https://example.com", "https://raw.githubusercontent.com/foundryvtt/worldbuilding/master/system.json"
format=uripattern=^https?://[^.\s]+\.[^.\s]
protected boolean

(undocumented, used for premium packages)

Default: false
exclusive boolean

(undocumented)

persistentStorage boolean

(undocumented, intended to be used by core Foundry in the future)

documentTypes object

(intended to be used by core Foundry in the future, see Module Sub-Types article)

manifestPlusVersion string | number
Examples: "1.0.0", "0.5.0-beta", "1.0", "9.361", "2023-04-08", "20220312"
includes array

(Manifest+ field)

deprecated object

(Manifest+ field)

conflicts object

(Manifest+ field)

Definitions

Identifier string
Examples:
  • "lib-wrapper"
  • "dnd5e"
File string

Relative path to a file, case sensitive.

Examples:
  • "src/main.mjs"
  • "lang/en.json"
  • "packs/loot.db"
FileArray File[]
URL string

A public URL.

Examples:
  • "https://example.com"
  • "https://raw.githubusercontent.com/foundryvtt/worldbuilding/master/system.json"
Version string | number
Examples:
  • "1.0.0"
  • "0.5.0-beta"
  • "1.0"
  • "9.361"
  • "2023-04-08"
  • "20220312"
NonBlankString string
Flags object

Flag data.

PackageCompatibility object
minimum string | number
Examples: "1.0.0", "0.5.0-beta", "1.0", "9.361", "2023-04-08", "20220312"
verified string | number
Examples: "1.0.0", "0.5.0-beta", "1.0", "9.361", "2023-04-08", "20220312"
maximum string | number
Examples: "1.0.0", "0.5.0-beta", "1.0", "9.361", "2023-04-08", "20220312"
PackageRelationship object
id string required
Examples: "lib-wrapper", "dnd5e"
format=regexpattern=^[a-zA-Z0-9_-]+$
type string

The type attribute instructs FoundryVTT that the dependency may be on a different type of package. By default dependencies are assumed to be a module, so if you want to depend on a system or world you should be explicit.

Default: "module"
Values: "module" "system" "world"
manifest string

A public URL.

Examples: "https://example.com", "https://raw.githubusercontent.com/foundryvtt/worldbuilding/master/system.json"
format=uripattern=^https?://[^.\s]+\.[^.\s]
compatibility object
3 nested properties
minimum string | number
Examples: "1.0.0", "0.5.0-beta", "1.0", "9.361", "2023-04-08", "20220312"
verified string | number
Examples: "1.0.0", "0.5.0-beta", "1.0", "9.361", "2023-04-08", "20220312"
maximum string | number
Examples: "1.0.0", "0.5.0-beta", "1.0", "9.361", "2023-04-08", "20220312"
reason string
pattern=.+
flags object

Flag data.