Skip to content

Module: utilities/types

Type Aliases

AddonInfo

Ƭ AddonInfo: Object

AddonInfo represents the data contained in an add-on's manifest.

Type declaration

NameTypeDescription
authorstringThe name of the add-on's author.
createdDateThe date when the add-on was first created.
descriptionstringA description of the add-on. This can be multiple lines and supports Markdown.
devbooleanWhether or not the add-on has been loaded from a development center.
externalbooleanWhether or not the add-on has been loaded externally (outside of FFZ's control).
idstringThe add-on's ID. This is used to identify content, including settings, modules, emotes, etc. that are associated with the add-on.
maintainer?stringThe name of the person or persons maintaining the add-on, if different than the author.
namestringThe human-readable name of the add-on, in English.
required_bystring[]A list of add-ons, by ID, that require this add-on to be enabled to function.
requiresstring[]A list of add-ons, by ID, that this add-on requires to be enabled to function.
settings?stringOptional. A settings UI key. If set, a Settings button will be displayed for this add-on that takes the user to this add-on's settings.
short_name?stringOptional. A human-readable shortened name for the add-on, in English.
targetsstring[]List of FrankerFaceZ flavors ("main", "clips", "player") that this add-on supports.
updated?DateThe date when the add-on was last updated.
versionstringThe add-on's version number. This should be a semantic version, but this is not enforced.
website?stringOptional. This add-on's website. If set, a Website button will be displayed that functions as a link.

Defined in

src/utilities/types.ts:5