Foundry VTT - World Manifest

Foundry VTT world.json files

Type object
File match **/worlds/*/world.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/foundry-vtt-world-manifest/latest.json
Source https://www.schemastore.org/foundryvtt-world-manifest.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

system Identifier required

The game system name which this world relies upon

Examples: "dnd5e"
coreVersion Version required

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

systemVersion Version required

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

Examples: "2.0.3"
manifest URL

A stable URL that describes the latest release version of your manifest file. This URL is used for automatic world installation in the Foundry VTT setup screen. This manifest URL is consulted during the module update check to see whether a new version is available for download. It is important that this address remain stable, otherwise updates will not be detected.

Examples: "https://github.com/ForgeVTT/forgevtt-demo-world/releases/latest/download/world.json"
pattern=.*world\.json
background URL | File

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

nextSession string | null

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?

All of

1.