PackageData

PackageData

The data schema used to define a Package manifest. Specific types of packages extend this schema with additional fields.

Constructor

new PackageData()

Properties:
Name Type Attributes Default Description
name string

The canonical package name, should be lower-case with no spaces or special characters

title string

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

description string <optional>

An optional package description, may contain HTML

author string <optional>

A singular package author; this is an old field staged for later deprecation, please use authors

authors Array.<PackageAuthorData> <optional>

An array of author objects who are co-authors of this package. Preferred to the singular author field.

url string <optional>

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

license string <optional>

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

readme string <optional>

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

bugs string <optional>

A web url where bug reports may be submitted and tracked

changelog string <optional>

A web url where notes detailing package updates are available

version string

The current package version

minimumCoreVersion string <optional>

A minimum version of the core Foundry software which is required to use this package

compatibleCoreVersion string <optional>

A maximum version of the core Foundry software beyond which compatibility is not guaranteed

scripts Array.<string> <optional>

An array of urls or relative file paths for JavaScript files which should be included

esmodules Array.<string> <optional>

An array of urls or relative file paths for ESModule files which should be included

styles Array.<string> <optional>

An array of urls or relative file paths for CSS stylesheet files which should be included

languages Array.<PackageLanguageData> <optional>

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

packs Array.<PackageCompendiumData> <optional>

An array of compendium packs which are included by this package

system Array.<string> <optional>

An array of game system names which this module supports

dependencies Array.<PackageDependencyData> <optional>

An array of dependency objects which define required dependencies for using this package

socket boolean <optional>

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

manifest string <optional>

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

download string <optional>

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

protected boolean <optional>
false

Whether this package uses the protected content access system.

Extends

  • DocumentData