Optional
authorsAn array of author objects who are co-authors of this package.
Optional
bugsA web url where bug reports may be submitted and tracked
Optional
changelogA web url where notes detailing package updates are available
Optional
compatibilityThe 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.
Optional
descriptionAn optional package description, may contain HTML. Visible on the Setup screen in "gallery" view as well as in the "Module Management" application.
Optional
downloadA publicly accessible web URL where the source files for this package may be downloaded. Required in order to support package installation.
Optional
esmodulesAn array of urls or relative file paths for ESModule files to include
Optional
exclusiveWhether this package is a free Exclusive pack.
Optional
flagsAn object of optional key/value flags. Packages can use this namespace for their own purposes, preferably within a namespace matching their package ID.
The machine-readable unique package id, should be lower-case with no spaces or special characters
Optional
languagesAn array of language data objects which are included by this package
Optional
licenseA web url or relative file path where license details may be found
Optional
manifestA publicly accessible web URL which provides the latest available package manifest file. Required in order to support package updates.
An array of objects containing media info about the package.
Optional
packAn array of pack folders that will be initialized once per world.
Optional
packsAn array of compendium packs which are included by this package
Optional
persistentWhether updates should leave the contents of the package's /storage folder.
Optional
protectedWhether this package uses the protected content access system.
Optional
readmeA web url or relative file path where readme instructions may be found
Optional
relationshipsAn organized object of relationships to other Packages
Optional
scriptsAn array of urls or relative file paths for JavaScript files to include
Optional
socketWhether to require a package-specific socket namespace for this package
Optional
stylesAn array of urls or relative file paths for CSS stylesheet files to include
The human-readable package title, containing spaces and special characters
Optional
urlA web url where more details about the package may be found
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
.
The data structure of a package manifest. This data structure is extended by BasePackage subclasses to add additional type-specific fields.