OptionalauthorsAn array of author objects who are co-authors of this package.
OptionalbugsA web url where bug reports may be submitted and tracked
OptionalchangelogA web url where notes detailing package updates are available
OptionalcompatibilityThe 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.
OptionaldescriptionAn optional package description, may contain HTML. Visible on the Setup screen in "gallery" view as well as in the "Module Management" application.
OptionaldownloadA publicly accessible web URL where the source files for this package may be downloaded. Required in order to support package installation.
OptionalesmodulesAn array of urls or relative file paths for ESModule files to include
OptionalexclusiveWhether this package is a free Exclusive pack.
OptionalflagsAn 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
OptionallanguagesAn array of language data objects which are included by this package
OptionallicenseA web url or relative file path where license details may be found
OptionalmanifestA 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.
OptionalpackAn array of pack folders that will be initialized once per world.
OptionalpacksAn array of compendium packs which are included by this package
OptionalpersistentWhether updates should leave the contents of the package's /storage folder.
OptionalprotectedWhether this package uses the protected content access system.
OptionalreadmeA web url or relative file path where readme instructions may be found
OptionalrelationshipsAn organized object of relationships to other Packages
OptionalscriptsAn array of urls or relative file paths for JavaScript files to include
OptionalsocketWhether to require a package-specific socket namespace for this package
OptionalstylesAn array of urls or relative file paths for CSS stylesheet files to include
The human-readable package title, containing spaces and special characters
OptionalurlA 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.