description: A settings.paf file used by Qualisys Project Automation Framework (PAF) Modules

line_endings: unix

type: object

type: string

enum:
Iso
Little endian
Middle endian

enum: Dash Slash Dot None

enum: mm cm m

type: array

required:
Name
Version
Required QTM version

type: integer

type: number

enum:
External program
Visual3D
Report
Compound
HTTPRequest
Instantiate template
Create skeleton
Solve skeleton

enum:
TSV
C3D
MAT
JSON
tsv
c3d
mat
json
xml settings

enum:
Never
No Warnings

enum: Integer Float String Date TimeOfDay Enum Boolean

enum: Copy Connect

type: boolean

enum:
Length
Mass
Voltage
Current
Force
Moment
Power
Angle
Time
Frequency
Temperature
Speed
Acceleration
Magnetic field strength
Rotational speed

enum:
meters
ångstroms
nanometers
microns
millimeters
centimeters
kilometers
inches
feet
yards
miles
kilograms
micrograms
milligrams
grams
ounces
pounds
volts
nanovolts
microvolts
millivolts
kilovolts
ampere
nanoampere
microampere
milliampere
kiloampere
newtons
millinewtons
kilonewtons
meganewtons
kiloponds
pounds force
newtonmeter
newtonmillimeter
watt
radians
degrees
seconds
minutes
hours
hertz
kilohertz
megahertz
revolutions per minute
beats per minute
kelvin
degrees celsius
degrees farenheit
meters per second
millimeters per second
kilometers per hour
feet per second
miles per hour
knots
meters per second squared
millimeters per second squared
feet per second squared
standard gravity
tesla
millitesla
degrees per second
Meters
Ångstroms
Nanometers
Microns
Millimeters
Centimeters
Kilometers
Inches
Feet
Yards
Miles
Kilograms
Micrograms
Milligrams
Grams
Ounces
Pounds
Volts
Nanovolts
Microvolts
Millivolts
Kilovolts
Ampere
Nanoampere
Microampere
Milliampere
Kiloampere
Newtons
Millinewtons
Kilonewtons
Meganewtons
Kiloponds
Pounds force
Newtonmeter
Newtonmillimeter
Watt
Radians
Degrees
Seconds
Minutes
Hours
Hertz
Kilohertz
Megahertz
Revolutions per minute
Beats per minute
Kelvin
Degrees celsius
Degrees farenheit
Meters per second
Millimeters per second
Kilometers per hour
Feet per second
Miles per hour
Knots
Meters per second squared
Millimeters per second squared
Feet per second squared
Standard gravity
Tesla
Millitesla
Degrees per second
m/s

enum: yesno checkbox truefalse YesNo Checkbox TrueFalse


key: Project ID

description: A human readable name that identifies the project. This name is recorded in data files and should not be changed once data collection has started as doing so will render data files useless.


key: Root type

description: Reference to the class or type name to use at the highest level in the PAF item hierarchy.


key: Date format

description: Specifies what date format to use in this project. Applies mainly to exports and column values but not to the field edit dialog. Accepted values are Iso, Little endian and Middle endian.


key: Date separator

description: Specifies which token to use to separate the parts of the dates when formatting them. Accepted values are Dash, Slash, Dot and None.


key: Time format

description: Specifies what time format to use in this project. Applies mainly to exports and column values but not to the field edit dialog. Accepted values are 12-hour and 24-hour.


key: Filename filter

description: A regular expression that determines which files (in addition to the qtm files) that will be visible in the tree view.


key: Export c3d settings

description: This section is optional and is used when exporting to c3d file.


key: Point units

description: Possible units are: mm, cm or m.


key: Default fields

description: A sequence of names of fields that will be added to all types. QTM also adds a number of default fields automatically. For a list of these, see the Default Fields section.


key: Package Information

description: This section contains information that the package management system uses. It is used mainly when installing packages and when creating new projects based on a package.


key: Name

description: The name of the package. Shown when creating a new project and used to keep the connection between a project and the package it was created from to, for instance, know if there is a new version of a package. This means that this value should not be changed unless strictly necessary because that will break the connection between existing projects and new versions of the package.


key: Version

description: Two numbers separated by a period sign (e.g. 44.23), three numbers separated by period signs (e.g. 1.45.3214), or three numbers separated by a period sign and a build number separated by a plus sign (e.g. 1.3.0+188). The version of the package. Used to keep track of which version a project is based on. Visible in the about box when a project is open. Useful for debugging purposes and for knowing if the package can be upgraded.


key: Required QTM version

description: Two or three digits separated by a period sign. The QTM version that is required for this package to work properly. Checked on install time. Must include major and minor version number and can optionally include build number too.


key: Previous names

description: A sequence of names that this package has had earlier in development. This is used only when checking if a project should be upgraded and allows for packages to be renamed without losing the project upgrade path.


key: Types


description: All type names have to be unique. Each class definition is a map that contains the type names as keys and the type definitions as values.


key: Fields

description: Naming any field as a key and a default value for that field in this type is permitted. Any default value given here overrides the default value from the field specification. The default value should always be a scalar except for string fields that also support sequences. See documentation of the Default property in the Fields section for more information.


description: All class names have to be unique. Each class definition is a map that contains the type names as keys and the type definitions as values.


description: Fields to use for this class. If this key is present it should contain a map or sequence that contains fields that should be defined for each type of this class. If the fields are given as a map they also specify default values for the fields. A type can override the default value of a field by including the field name as part of its own definition but it cannot undefine a field that has been defined in the class.


key: Children

description: A sequence of references to class or type names that can be created as children to items of this type. A type that has children cannot have measurements.


key: Measurements

description: A sequence of measurement type names. If a type has the measurement property, it is considered to be a session-like type. It cannot have other children and it will have a wizard interface containing measurements (of the types specified by this parameter) and analyses.


key: Analyses

description: A sequence of analysis names. These will be shown in the Analyze dropdown of the session wizard. The first analysis in the list will be the default analysis that is run when the button itself is clicked.


key: Display order

description: A sequence of field names denoting the order in which to display the fields of items of this type. Inherited fields can also be entered. Fields named here will be displayed first in field lists. Fields that are not named are displayed afterwards in an arbitrary order.


key: Heading

description: An optional string displayed instead of the type name as a heading for the measurement type in the wizard pane.


key: PDF guide

description: The path to a PDF file to show when the user clicks the Show guide button in the wizard pane.


key: Directory pattern

description:
A naming pattern for the directory created for each item (except measurements, for which this property is useless).

The pattern can contain any text as well as names of items braced by $ signs, so for instance the directory pattern “Patient $ID$” would be expanded to Patient followed by the contents of the ID field of that item. In addition to the field names $ClassName$, $TypeName$, $WorkingDirectory$, $TemplateDirectory$ and $InstanceNumber$ can also be used in the naming patterns.

An item reference can also specify additional formatting options, inspired by those of the printf format strings. The syntax is: $[Opt. pad char][Minimum length]:Field name$ so for instance $08:ID$ would print the id field and pad it with zeros to a width of 8 characters.

The default naming pattern is $TypeName$. If directory names clash when a new directory is created, a counter is appended to the name to make it unique.


key: Icon

description: The path to an icon file (.ico) to show at the side of the item in the tree view. The path is relative to the `Templates` folder.


description: A uniquely named measurement, defining its properties.


key: Count

description: The default number of measurement buttons that kind of measurement in a new session.


key: Minimum count

description: The minimum number of measurements of that kind in a session. The +/- buttons will not allow the count to go below this and if any analysis lists this kind of measurement as a prerequisite, the analysis will not be available until the minimum number of measurements have been performed.


key: Maximum count

description: The maximum number of measurements of that kind in a session.


key: Measurement length

description: The default length of this kind of measurement.


key: Pretrigger length

description: The length of the pretrigger buffer. Setting this to zero disables pretrigger. Leaving this option out uses the project setting for pretrigger.


key: Frequency

description: The frequency used for this kind of measurement. If omitted, the frequency is not changed when starting the measurement.


key: AIM models

description: A semicolon separated list (not a YAML sequence) of AIM models that should be applied to measurements of this kind.


key: Display fields dialog after creation

description: If this value is set to true, the fields dialog will be displayed when a measurement has finished to allow the user to edit the fields of the measurement item in the same way that dialog is displayed when other (non-measurement) items are created.


key: Measurement pattern

description:
A naming pattern for measurements created for each item. The pattern can contain any text as well as names of items braced by $ signs, so for instance the measurement pattern “Patient $ID$” would be expanded to Patient followed by the contents of the ID field of that item. In addition to the field names $ClassName$, $TypeName$, $WorkingDirectory$, $TemplateDirectory$ and $InstanceNumber$ can also be used in the naming patterns.

An item reference can also specify additional formatting options, inspired by those of the printf format strings. The syntax is: $[Opt. pad char][Minimum length]:Field name$ so for instance $08:ID$ would print the id field and pad it with zeros to a width of 8 characters.

The default naming pattern is $TypeName$. If directory names clash when a new directory is created, a counter is appended to the name to make it unique. The file extension .qtm will be added automatically. The default value is $TypeName$ $InstanceNumber$.


description: Naming any field as a key and a default value for that field in this type is permitted. Any default value given here overrides the default value from the field specification. The default value should always be a scalar except for string fields that also support sequences. See documentation of the Default property in the Fields section for more information.


description: A uniquely named analysis, defining its properties.


key: Type

description:
Names of the analysis type. Valid values are External program, Visual3D, Report, Compound, HTTPRequest, Instantiate template, Create skeleton, Solve skeleton.

Note: only External program and Compound are available to all users. Other types require the Project Automation Framework developer license which is used for internal Qualisys development and by development partners.


key: Prerequisites

description: A sequence of measurement type names and analysis names that has to be completed before this analysis can be run. Measurement types are considered complete for the current session when the user has made at least the number of measurements given by that measurement type’s Minimum count field. Analyses are considered complete when the file denoted by the Output file field exists.


key: Output file

description: The name of a file that is created when this analysis is run. QTM uses this to check if the analysis has been completed. It is also used to issue a warning if this file has been changed since the analysis was last run for the current session. This property can contain patterns.


key: Program display name

description:
External program only: The name to be displayed in the directories tab in project options where the user will have to locate the external executable. NB: Because this path varies between computers rather than between projects, it is not stored in the project, but in computer-global settings file.

Several analyses in different projects may share the same Program display name and QTM will automatically use the same executable path for all of them.


key: Export session

description: External program only: Optional. If present, the metadata of the session, all its ancestors and the measurements are exported into a file called session.xml.


key: Export measurements

description: External program only: Optional. A single string or an array containing any combination of the following values: “TSV”, “C3D”, “MAT”. Will make QTM export all the selected measurements to the corresponding formats before running the external program. Use “xml settings” to export a file with measurement settings (e.g. capture start time and analog channel names). The file will be named [file name].settings.xml.


key: Template files

description: External program only: Optional. A single string or an array containing names of files in the template directory. Each file will be run through the PHP engine and the result written to a file with the same name in the session directory. Standard Windows wildcards are supported, but note that if the asterisk is used to match a part of the filename, the pattern must be enclosed in single quotation marks to make sure it is not parsed as a YAML alias.


key: Working directory

description: External program only: Optional. The working directory set when the program is launched. Defaults to the session directory.


key: Arguments

description: Optional. An array of arguments to be sent to the program being started. Each argument will be subject to pattern expansion and if the result contains spaces, it will be enclosed in double quotation marks when the command line is built.


key: Show output file

description: External program only: Optional. If set, and if the Output file property has been specified, and if the execution of the external program is successful (exit code 0), the output file will be shown in the systems standard program for that file type (as if it was double-clicked in the windows explorer).


key: Do not wait for Application

description: External program only: Optional. If analysis includes this property, QTM does not wait for external program to finish the processing. If property does not exit, to continue with subsequent analyses, external program must be closed manually (> QTM 2019.1).


key: Pipeline template

description: Visual3D analysis only: Required. The name of a template file in the Templates directory. This file will be instantiated and used as the pipeline script in visual 3d.


key: Do not wait for Visual3D

description: Visual3D analysis only: Optional. If analysis includes this property, QTM does not wait for Visual3D to finish the processing. If property does not exit, to continue with subsequent analyses, Visual3D must be closed manually or Exit_Workspace; command has to be added to the very end of Visual3D script.


key: Close Visual3D

description: Visual3D analysis only: Deprecated (> QTM 2.16).


key: Components

description: Compound analysis only. Required. An array of analysis steps.


key: Template

description: Instantiate template analysis only: Required. The name of the input file. If this name contains any path delimiter tokens, it will be considered to be relative to the project directory, otherwise QTM will assume that the input file is placed in the templates folder.


key: Measurements

description: Create / Solve skeleton analyses only: Required. A string or list of strings to specify the file names to solve the skeletons. Wildcard can be used in the name to specify multiple files at once. To specify all measurements, simply use the wildcard character. Only measurements that are marked as used in the PAF pane will be affected.


key: Exclude

description: Create / Solve skeleton analyses only: Optional. A string or list of strings to specify the file names to exclude. Wildcard can be used in the name to specify multiple files at once. Only measurements that are marked as used in the PAF pane will be affected.


key: Fields


description: A uniquely named field, defining its properties.


key: Type

description: Required. Defines the type of the field. Possible values are Integer, Float, String, Date, TimeOfDay, Enum or Boolean.


key: Hidden

description: If the value is Yes or True, this field will not be displayed in the GUI (and thus will not be editable by the user) but will be exported to files. It will keep its default value.


key: Readonly

description: If the value is Yes or True this field will be displayed, but the user will not be able to edit it. It will keep its default value.


key: Inherit

description:
This field will be inherited by all subitems of the item that contains it. There are two modes of inheritance Copy and Connect and the value of this property has to be one of them.

Copy: Inheritance by copying means that when a child to an item that has an inheritable field is created, a field with the same name is created in the child and the value of the field in the parent is copied to that field.

Connect fields work the same way when an item is created, but if the field is changed in any of the items (any ancestor or heir) it is updated in all the items that have inherited this field from the same origin. If, for instance, a value is inherited by connection from a patient to a number of sessions and the measurements in those sessions and it is changed in one of the sessions it is changed in all those objects, but not in other patients and the sessions of those patients.

Fields are inherited all the down to the leaves from the item including the fields so if the root item would include an inherited field, it would be copied to all items in the tree.


key: Default

description: The default value that this field will get when an item that contains it is created. This can be overridden in the item type specification and by inheritance. The value of this property should have the same data type as the field. String fields can also specify a sequence as default value. The sequence will be converted into a string containing the elements of the sequence separated by semicolon.


key: Max

description: Integer / Float types only: The maximum value that can be entered in this field.


key: Min

description: Integer / Float types only: The minimum value that can be entered in this field.


key: Quantity

description: Float type only: The physical quantity that this field represents. This list contains the basic physical quantities but also some derived quantities because there is no possibility to combine quantities.


key: Unit

description: Float type only: The unit of this field. Can only be specified if a quantity has been specified. Different units apply to different quantities. Either the unit name or the abbreviation can be given. If a unit is not entered, the S/I unit is used.


key: Decimals

description: Float type only: The number of decimals to present to the user.


key: Force

description: String type only: Force the string to be non-empty.


key: JSON

description: String type only: The string should be returned as JSON object when queried from the REST api. JSON fields are not exported to session.xml during the analysis step. (Available from QTM 2.14).


key: Values

description:
Enum type only: The enum field defines an enumeration. To the user it will be presented as a multiple selection and internally it will be saved as a numeric value. The possible values that an enum can have has to be specified in the Values property. This property can be either a sequence or a map.

If it is a sequence it simply lists the choices of the enum and these will be assigned an integer value automatically.

If it is a map it is a map from the choices to the numeric value of each particular choice.


key: Display

description: Boolean type only: Controls how this value will be displayed. Can be one of yesno, checkbox or truefalse.


key: Columns

description: The columns section specifies the columns of the tree view in the project view. It allows the PAF file to specify multiple column setups. The idea is that the users should be able to switch between different configurations and possibly also add their own but currently only the first setup is used.


description: A uniquely named column setup. Each setup contains an arbitrary number of columns.


description: A uniquely named column. Each column can specify a width (in pixels) and a way of determining the value displayed in the column. A key to understanding the column values is the understanding that each row in the tree view might contain a different type of item.


key: Width

description: The width (in pixels) of this column.


key: Field

description: The column will contain the value of the field named by this property regardless of the type of the item on the row.


key: Fields

description: A map from the item type name to the field to use. For each item type that is present as a key in the map the value of the field named will be used. For item types that are not named in the map the default field name will be used.


description: Name used for item types not named in the map.


key: Editable

description: If yes or true, the value of the field can be edited directly in the tree.


description: A news item as JSON object -- copyright 2021 IPTC - International Press Telecommunications Council - www.iptc.org - This document is published under the Creative Commons Attribution 4.0 license, see  http://creativecommons.org/licenses/by/4.0/

ninjs

format: uri

enum: text audio video picture graphic composite component

enum: full partial

format: date-time

enum: usable withheld canceled


key: uri

description: The global unique identifier for this news object. This is the only required property and should identify the ninjs object, not be used for links to external resources etc.  nar:newsItem@guid


key: type

description: The generic news type of this news object. (Value 'component' added in version 1.2 as issue #21.). See: http://cv.iptc.org/newscodes/ninature/ nar:itemClass


key: representationtype

description: Indicates how complete this representation of a news item is. No mapping to nar. Specific for ninjs.


key: profile

description: An identifier for the structure of the news object. This can be any string but we suggest something identifying the structure of the content such as 'text-only' or 'text-photo'. Profiles are typically provider-specific. nar:profile


key: version

description: The version of the news object which is identified by the uri property. nar:newsItem@version


key: firstcreated

description: Indicates when the first version of this ninjs object was created. (Added in version 1.2 from issue #5). nar:firstCreated


key: versioncreated

description: The date and time when this version of this ninjs object was created. nar:versionCreated


key: contentcreated

description: The date and time when the content of this ninjs object was originally created. For example and old photo that is now handled as a ninjs object. nar:contentCreated


key: embargoed

description: The date and time before which all versions of the news object are embargoed. If absent, this object is not embargoed. nar:embargoed


key: pubstatus

description: The publishing status of the news object, its value is *usable* by default. nar:pubStatus


key: urgency

description: The editorial urgency of the content. Values from 1 to 9. 1 represents the highest urgency, 9 the lowest. nar:urgency


key: copyrightholder

description: The person or organisation claiming the intellectual property for the content. nar:copyrightHolder


key: copyrightnotice

description: Any necessary copyright notice for claiming the intellectual property for the content. nar:copyrightNotice


key: usageterms

description: A natural-language statement about the usage terms pertaining to the content. nar:usageTerms


key: ednote

description: A note that is intended to be read by internal staff at the receiving organisation, but not intended to be published. (Added in version 1.2 from issue #6.). (Consider using this before using the descriptions array.) ednote: nar:edNote


key: language

description: The human language used by the content. The value should follow IETF BCP47. nar:language


key: descriptions

description: An array of one or more descriptions of the ninjs object. See also ednote for information from provider to reciever. Descriptions are seen as metadata. For a simple description use an array with one object only containing the value property. Role and contenttype are then undefined and it is up to the provider.


key: role

description: The role of this description


key: contenttype

description: The IANA (Internet Assigned Numbers Authority) MIME type of the content of this description.


key: value

description: The descriptive text identified with the above role (and contenttype).


key: bodies

description: An array of body objects with the content as text or with markup. For a simple body use an array with one object only containing the value property. Role and contenttype are then undefined and it is up to the provider.


description: The role of this body


description: The IANA (Internet Assigned Numbers Authority) MIME type of the content of this body.


key: charcount

description: The total character count in this body excluding figure captions. (Added in version 1.2 according to issue #27.). nar:charcount


key: wordcount

description: The total number of words in this body excluding figure captions. (Added in version 1.2 according to issue #27.). nar:wordcount


description: The body text identified with the above role and contenttype.


key: headlines

description: An array of objects containing various types of headlines. For a simple headline use an array with one object only containing the value property. Role and contenttype are then undefined and it is up to the provider.


description: The role of this headline


description: The IANA (Internet Assigned Numbers Authority) MIME type of the content of this headline.


description: The headline identified with the above role and contenttype.


key: people

description: An array of objects describing individual human beings. nar:subject


key: name

description: The name of a person


key: rel

description: The relationship of the content of the news object to the person


key: uri

description: The identifier for the person as a complete uri with the code.


key: literal

description: The code for the person as a literal value.


key: organisations

description: An array of objects describing administrative and functional structures which may, for example, act as as a business, as a political party or not-for-profit party. nar:subject


description: The name of the organisation


description: The relationship of the content of the news object to the organisation


description: The identifier of the organisation as a complete uri


description: The code for the organisation as a literal


key: symbols

description: Symbols used for a financial instrument linked to the organisation at a specific market place


key: ticker

description: Ticker symbol used for the financial instrument


key: exchange

description: Identifier for the marketplace which uses the ticker symbols of the ticker property


key: places

description: An array of named locations. nar:subject


description: The name of the place


description: The relationship of the content of the news object to the place


description: The identifier for the place as a complete uri


description: The code for the place as a literal


key: subjects

description: An array of objects holding concepts with a relationship to the content. nar:subject


description: The name of the subject


description: The relationship of the content of the news object to the subject


description: The identifier of the subject as a complete uri


description: The code for the subject as a string literal


key: events

description: An array of objects describing something which happens in a planned or unplanned manner. nar:?


description: The name of the event


description: The relationship of the content of the news object to the event


description: The identifier for the event as a complete uri


description: The code for the event as a string literal


key: objects

description: An array of objects describing something material, excluding persons. nar:subject


description: The name of the object


description: The relationship of the content of the news object to the object


description: The identifier for the object as a complete uri


description: The code for the object as a string literal


key: infosources

description: An array of parties (person or organisation) which originated, modified, enhanced, distributed, aggregated or supplied the content or provided some information used to create or enhance the content. (Added in version 1.2 according to issue #15.) .  infosource:  nar:infoSource


description: The name of the infosource


key: role

description: The role the infosource in relationship to the content as a uri.


description: The identifier of the infosource as a complete uri


description: The code for the infosource as a string literal


key: title

description: A short natural-language name for the item. Title is metadata, use headlines for publishable headlines. (Added in version 1.2 according to issue #9). nar:itemMeta/title


key: by

description: A natural-language statement about the creator (author, photographer etc.) of the content. nar:by


key: slugline

description: A human-readable identifier for the item. (Added in version 1.2 from issue #4.). nar:slugline


key: located

description: The name of the location from which the content originates. nar:located


key: renditions

description: An array of objects with different renditions of the news object. nar:remoteContent


key: items

description: A specific rendition of the content of the news object. (Description changed in version 1.2 according to issue #17.)


key: name

description: The name of this object in the array of renditions. For example 'thumbnail'


key: href

description: The URL for accessing the rendition as a resource. nar:remoteContent@ref


key: contenttype

description: A MIME type which applies to this rendition. nar:remoteContent@contenttype


description: A title for the link to the rendition resource


key: height

description: For still and moving images: the height of the display area measured in pixels. nar:remoteContent@height


key: width

description: For still and moving images: the width of the display area measured in pixels. nar:remoteContent@width


key: sizeinbytes

description: The size of the rendition resource in bytes


key: duration

description: The total time duration of the content in seconds. (Added in version 1.2. Issue #18). nar:remoteContent@duration


key: format

description: Binary format name. (Added in version 1.2. Issue #18). nar:remoteContent@format


key: associations

description: An array of objects with content of news objects which are associated with this news object.


description: One associated object where each object can use all properties in ninjs.


description: The name of this object in the array of associations. For example 'logo'


key: altids

description: Alternative identifiers assigned to the content. Each alternative id can have a role and a value. nar:altId issue #3.


key: role

description: The role of the alternative id


key: value

description: The alternative id value


key: trustindicators

description: An array of objects to allow links to documents about trust indicators. issue #44. (Added in version 1.3)


description: The role of the trust indicator as a complete uri


key: title

description: The title of the resource being referenced.


description: The URL for accessing the trust indicator resource.


key: standard

description: An object with information about standard, version and schema this instance is valid against. nar:standard, nar:standardversion and xml:schema issue #43. (Added in version 1.3)


description: For example ninjs. nar:standard


key: version

description: For example 1.3. nar:standardversion


key: schema

description: The uri of the json schema to use for validation.


key: genres

description: A nature, intellectual or journalistic form of the content. nar:genre. (Added in version 1.3)


key: name

description: The name of the genre


key: uri

description: The identifier of  the genre as a complete uri


key: literal

description: The code for the genre as a string literal


key: rightsinfo

description: Expression of rights to be applied to content. nar:rightsInfo


key: langid

description: Identifier for the Rights Expression language used. nar:@langid


key: linkedrights

description: A link from the current Item to Web resource with rights related information. nar:link


key: encodedrights

description: Contains a rights expression as defined by a Rights Expression Language. nar:rightsExpressionXML or nar:rightsExpressionData


key: apt-deb

description: deb repositories

enum: deb deb-src

required: type key-id url

validation-failure: {!r} is not properly configured deb repository


key: items

description: Architectures to enable, or restrict to, for this repository.  Defaults to host architecture.


key: formats

description: deb types to enable.  Defaults to [deb, deb-src].


description: Deb repository components to enable, e.g. 'main, multiverse, unstable'


key: key-id

description: GPG key identifier / fingerprint. May be used to identify key file in <project>/snap/keys/<key-id>.asc


key: key-server

description: GPG keyserver to use to fetch GPG <key-id>, e.g. 'keyserver.ubuntu.com'. Defaults to keyserver.ubuntu.com if key is not found in project.


key: path

description: Exact path to repository (relative to URL). Cannot be used with suites or components.


description: Deb repository suites to enable, e.g. 'xenial-updates, xenial-security').


key: url

description: Deb repository URL, e.g. 'http://archive.canonical.com/ubuntu'.


key: apt-ppa

description: PPA repository

required: type ppa

validation-failure: {!r} is not properly configured PPA repository


key: ppa

description: ppa path: e.g. 'canonical-kernel-team/unstable'


key: system-username-scope

description: short-form user configuration (<username>: <scope>)

validation-failure: {!r} is not a valid user scope. Valid scopes include: 'shared'


key: environment

description: environment entries


key: build-packages

description: top level build packages.


key: adopt-info

description: name of the part that provides source files that will be parsed to extract snap metadata information


key: name

description: name of the snap package

validation-failure: snap names need to be strings.

validation-failure: {.instance!r} is not a valid snap name. Snap names can only use ASCII lowercase letters, numbers, and hyphens, and must have at least one letter.

validation-failure: {.instance!r} is not a valid snap name. Snap names cannot start with a hyphen.

validation-failure: {.instance!r} is not a valid snap name. Snap names cannot end with a hyphen.

validation-failure: {.instance!r} is not a valid snap name. Snap names cannot have two hyphens in a row.


key: title

description: title for the snap


key: architectures

description: architectures on which to build, and on which the resulting snap runs

format: architectures


key: version

description: package version

validation-failure: snap versions need to be strings. They must also be wrapped in quotes when the value will be interpreted by the YAML parser as a non-string. Examples: '1', '1.2', '1.2.3', git (will be replaced by a git describe based version string).

validation-failure: {.instance!r} is not a valid snap version string. Snap versions consist of upper- and lower-case alphanumeric characters, as well as periods, colons, plus signs, tildes, and hyphens. They cannot begin with a period, colon, plus sign, tilde, or hyphen. They cannot end with a period, colon, or hyphen.


key: version-script

description: a script that echoes the version to set.


key: license

description: the license the package holds


key: icon

description: path to a 512x512 icon representing the package.

format: icon-path


key: summary

description: one line summary for the package


key: description

description: long description of the package

validation-failure: {.instance!r} is not a valid description string.


key: assumes

description: featureset the snap requires in order to work.


key: type

description: the snap type, the implicit type is 'app'

enum: app base gadget kernel snapd


key: confinement

description: the type of confinement supported by the snap

default: strict

enum: classic devmode strict


key: grade

description: the quality grade of the snap

default: stable

enum: stable devel


key: base

description: the base snap to use


key: build-base

description: force a build environment based on base to create a snap


key: epoch

description: the snap epoch, used to specify upgrade paths

format: epoch


key: compression

description: compression to use for snap archive - default is otherwise determined by 'snap pack'

enum: lzo xz


key: environment

description: environment entries for the snap as a whole


key: passthrough

description: properties to be passed into snap.yaml as-is


key: layout

description: layout property to be passed into the snap.yaml as-is


key: package-repositories

description: additional repository configuration.


key: system-usernames

description: system username

validation-failure: {!r} is not a valid system-username.


description: long-form user configuration


key: autostart

description: Name of the desktop file placed by the application in $SNAP_USER_DATA/.config/autostart to indicate that application should be started with the user's desktop session.

validation-failure: {.instance!r} is not a valid desktop file name (e.g. myapp.desktop)


key: common-id

description: common identifier across multiple packaging formats


key: bus-name

description: D-Bus name this service is reachable as

validation-failure: {.instance!r} is not a valid bus name.


key: activates-on

description: dbus interface slots this service activates on


key: desktop

description: path to a desktop file representing the app, relative to the prime directory


key: command

description: command executed to run the binary


key: completer

description: bash completion script relative to the prime directory


key: stop-command

description: command executed to stop a service


key: post-stop-command

description: command executed after stopping a service


key: start-timeout

description: Optional time to wait for daemon to start - <n>ns | <n>us | <n>ms | <n>s | <n>m

validation-failure: {.instance!r} is not a valid timeout value.


key: stop-timeout

description: Optional time to wait for daemon to stop - <n>ns | <n>us | <n>ms | <n>s | <n>m


key: watchdog-timeout

description: Service watchdog timeout - <n>ns | <n>us | <n>ms | <n>s | <n>m


key: reload-command

description: Command to use to ask the service to reload its configuration.


key: restart-delay

description: Delay between service restarts - <n>ns | <n>us | <n>ms | <n>s | <n>m. Defaults to unset. See the systemd.service manual on RestartSec for details.

validation-failure: {.instance!r} is not a valid delay value.


key: timer

description: The service is activated by a timer, app must be a daemon. (systemd.time calendar event string)


key: daemon

description: signals that the app is a service.

enum: simple forking oneshot notify dbus


key: after

description: List of applications that are ordered to be started after the current one


key: before

description: List of applications that are ordered to be started before the current one


key: refresh-mode

description: controls if the app should be restarted at all

enum: endure restart


key: stop-mode

description: controls how the daemon should be stopped


key: environment

description: environment entries for the specific app.


key: adapter

description: What kind of wrapper to generate for the given command

enum: none legacy full

default: legacy


description: Sockets for automatic service activation

usage: port number, an integer between 1 and 65535

usage: socket path, a string


key: passthrough

description: properties to be passed into snap.yaml as-is


description: environment entries for this hook


key: plugin

description: plugin name


key: items

description: submodules to fetch, by pathname in source tree


key: ua-services

description: UA services to enable.


description: This is a JSON schema representation of the schema.org Action schema: https://schema.org/Action

format: regex

pattern: Action


description: override the @context property to ensure the schema.org URI is used


description: override the @type property to ensure Action is used


key: actionStatus

description: Indicates the current disposition of the Action.


key: agent

description: The direct performer or driver of the action (animate or inanimate). e.g. John wrote a book.


description: Organization


description: Person


key: endTime

description: The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December.


key: error

description: For failed actions, more information on the cause of the failure.


key: instrument

description: The object that helped the agent perform the action. e.g. John wrote a book with a pen.


key: location

description: The location of for example where the event is happening, an organization is located, or where an action takes place.


description: Place


description: PostalAddress


key: object

description: The object upon the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). e.g. John read a book.


key: participant

description: Other co-agents that participated in the action indirectly. e.g. John wrote a book with Steve.


description: Organization


description: Person


key: result

description: The result produced in the action. e.g. John wrote a book.


key: startTime

description: The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December.


key: target

description: Indicates a target EntryPoint for an Action.


key: script

description:
A command line script or scripts.

Available variables:
%project:Directory% - The project directory
%project:Name% - The project name
%project:Version% - The project version

type: string array


key: bundleExclude

description: List of files to exclude from publish output (kpm bundle).


key: code

description: Glob pattern to specify all the code files that needs to be compiled. (data type: string or array with glob pattern(s)). Example: [ "Folder1\*.cs", "Folder2\*.cs" ]


key: configurations

description: Configurations are named groups of compilation settings. There are 2 defaults built into the runtime namely 'Debug' and 'Release'.


key: description

description: The description of the application


key: exclude

description: Glob pattern to indicate all the code files to be excluded from compilation. (data type: string or array with glob pattern(s)).


key: preprocess

description: Glob pattern to indicate all the code files to be preprocessed. (data type: string with glob pattern).


key: resources

description: Glob pattern to indicate all the files that need to be compiled as resources.


key: scripts

description: Scripts to execute during the various stages.


key: shared

description: Glob pattern to specify the code files to share with dependent projects. Example: [ "Folder1\*.cs", "Folder2\*.cs" ]


key: version

description: The version of the application. Example: 1.2.0.0


key: webroot

description: Specifying the webroot property in the project.json file specifies the web server root (aka public folder). In visual studio, this folder will be used to root IIS. Static files should be put in here.


description: Gradle Enterprise configuration schema

enum: viewScan exportData administerGe administerProjects administerCache publishScan testDistribution readCache writeCache accessAllProjects accessAnonymousProjectData

required: systemPassword version

enum: ldap saml

const: ldap

required: connectionUrl displayName roles users

required: dn password

const: external

required: baseDn membershipAttribute membershipAttributeType nameAttribute objectClass

enum: dn uid

const: local

enum: external local

required: email firstName lastName userName uuid

required: attributes baseDn

const: saml

required: displayName idpMetadata roles

required: hash length prefix

enum: monday tuesday wednesday thursday friday saturday sunday


key: EmailAddress

description: Internet email address conforming to most of RFC 822 syntax rules and by that allowing a majority of internalized email addresses as well.


description: The version of the config file model (must be 7).


key: heapMemory

description: The amount of heap memory allocated to the application


key: offHeapMemory

description: The amount of off-heap memory allocated to the application


key: params

description: Configuration parameters for the application


key: scanPayloadCacheSize

description: The amount of memory for the scan payload event stream cache


key: auth

description: Configuration of Gradle Enterprise authentication options


key: anonymousPermissions

description: Permissions to assign to anonymous users - does not support administerGe, administerCache, or testDistribution


key: bindUser

description: Binding information used when LDAP requires authentication


key: dn

description: Distinguished name for the LDAP user account


key: password

description: Password for the LDAP user account


key: connectionUrl

description: URL used to connect to LDAP server


key: displayName

description: Name of this identity provider configuration


key: roles

description: Holds information when the identity provider manages roles


key: baseDn

description: Base DN for the subtree holding roles


key: membershipAttribute

description: Name of the LDAP attribute holding role membership


key: membershipAttributeType

description: Type of the membership-ldap-attribute


key: nameAttribute

description: Name of the LDAP attribute holding the role name


key: objectClass

description: LDAP object classes for roles


key: retrieveStrategy

description: Type of roles retrieve strategy (defaults to GROUP_MEMBER)


key: attributes

description: Describes how user attributes are mapped


key: email

description: Name of the LDAP attribute holding email address


key: firstName

description: Name of the LDAP attribute holding first name


key: lastName

description: Name of the LDAP attribute holding last name


key: userName

description: Name of the LDAP attribute holding user name


key: uuid

description: Name of the LDAP attribute holding a unique id


description: Base DN for the subtree holding users


key: filter

description: LDAP search filter expression.


description: Optional LDAP filter expression to limit access


key: idpMetadata

description: SAML metadata that describes this identity provider


key: options

description: Groups all options and is only necessary when one or more needs to be enabled


key: requireEncryptedAssertion

description: Encrypt SAML assertions?


key: signAuthenticationRequests

description: Sign authentication requests?


key: validateAssertionSignature

description: Enable signature validation of SAML assertions?


key: validateResponseSignature

description: Enable signature validation of SAML responses?


key: roles


key: attribute

description: Name of the SAML attribute holding role names


key: userAttributes


description: Name of the SAML attribute holding email address


description: Name of the SAML attribute holding first name


description: Name of the SAML attribute holding last name


key: scim

description: Configuration for System for Cross-domain Identity Management (SCIM) support


key: enabled

description: Whether to allow access to the SCIM API for user and group management


key: token

description: Token to authenticate with the SCIM API


key: hash

description: The hash of the token


key: length

description: The length of the token


key: prefix

description: The prefix of the token


key: timeouts

description: Timeouts you can specify for user logins in Gradle Enterprise


key: accessTokenLifespan

description: The maximum time before an access token is expired (in minutes), default is 10 minutes


key: ssoSessionIdleTimeout

description: The time a login session is allowed to be idle before it expires (in minutes), default is 4 days (5760 minutes)


key: ssoSessionMaxLifespan

description: The maximum time before a login session is expired (in minutes), default is 30 days (43200 minutes)


key: backups

description: Automatic backup configuration

enum: daily weekly cron

const: daily

const: weekly

required: dayOfWeek timeOfDay

const: cron


key: backupsToRetain

description: How many old backups to keep


key: emailNotification

description: Send an email when backup is complete


key: timeOfDay

description: Time (in UTC) to perform the backup


key: dayOfWeek

description: Day (in UTC) to perform the backup


key: expression

description: Custom cron expression for backup time


key: buildCache

description: Configuration specific to the build cache app


key: allowUntrustedNodeSsl

description: Allow communication with nodes running over untrusted SSL


key: buildScans

description: Configuration specific to the build scans app


Threshold of free disk space before old scans will be automatically deleted


Threshold of free disk space before new scans will be rejected


Threshold of free disk space before a warning is sent to users publishing a build scan


key: incomingStorageType

description: Storage type of incoming builds


key: keepDays

description: How many days of scans should be retained


key: dailyMaintenanceTime

description: Which time (UTC) should retention-cleanup be performed


key: email

description: SMTP configuration for notifications

enum: login cramMd5 plain

required: password type username


key: administratorAddress

description: Email address notifications are sent to


key: authentication

description: SMTP authentication method


key: fromAddress

description: Email address notifications are sent from


key: smtpServer

description: Address and port of the smtp server


key: sslProtocol

description: SMTP protocol flavour


key: helpContact

description: Who users should contact if they have a problem


description: The email address users should contact


key: name

description: The name of the contact


key: network

description: Network configuration

required: password username

enum: http https


key: additionalTrust

description: Required if Gradle Enterprise must communicate with servers using certificates not trusted by default


key: proxy

description: Http proxy config


key: auth

description: Proxy authentication credentials


key: password

description: Proxy password


key: username

description: Proxy username


key: excludedHosts

description: A list of hosts that should not be proxied


key: host

description: Proxy host


key: port

description: Proxy port


key: protocol

description: Proxy protocol


key: objectStorage

description: Object Storage configuration

required: bucket credentials region

const: configuration

required: accessKey secretKey

const: environment

enum: configuration environment


key: bucket

description: The name of the bucket to store the scan payloads


key: credentials

description: The aws credentials


key: region

description: The region of the bucket


key: systemPassword

description: The password for the system user


description: JSON schema for SIL KIT Registry configuration files.

enum: Critical Error Warn Info Debug Trace Off

enum: File Stdout

default: Info


key: Logging

description: Configures the properties of the SIL Kit Logging Service


key: LogName

description: Log name; Results in the following filename: <LogName>_%y-%m-%dT%h-%m-%s.txt


key: $schema

description: The schema file


key: SchemaVersion

description: Version of the schema used to validate this document


key: Description

description: Free text field allowing a user to describe the configuration file in their own words. The contents of this field are not parsed or used internally.


key: ListenUri

description: The configured registry instance will listen on this address for incoming connections. Optional; This field overrides the -u, and --listen-uri command line parameters.


description: List of bazel targets to build


description: List of bazel targets to test


description: Build flags to use in addition to defined in /etc/bazel.bazelrc


description: Test flags to use in addition to defined in /etc/bazel.bazelrc


key: branches

description: List of branch name masks (doubleglob) to match


key: paths

description: List of path masks (doubleglob) to match. If not specified, all paths are matched


key: branches-ignore

description: List of branch name masks (doubleglob) to ignore


key: paths-ignore

description: List of path masks (doubleglob) to match. If not specified, all paths are ignored


key: tags

description: List of tag masks (doubleglob) to match


key: tags-ignore

description: List of tag masks (doubleglob) to ignore


key: workflows

description: The list of FasterCI workflows


key: push

description: Run the workflow on code push


Run the workflow on pull request


key: name

description: Step name, optional


key: working-directory

description: Directory to run the step instead of default repo directory


description: Report the result of the step as a separate github check


description: After completing the step, report as a separate Github Check, using the content of the file as a report body, optional


key: run

description: Arbitrary command execution; Could be multiline


key: bazel

description: Bazel step


description: Workflow name


key: on

description: Event to activate the workflow on


key: image

description: Docker image to run the workflow


key: cleanup

description: optional cleanup command, executed after the workflow


description: optional maximum number of parallel runs of this workflow


key: env

description: Environment variables


key: secrets

description: List of secrets to mount as environment variables


description: Do not notify github


key: init

description: Optional command to run before the workflow. Use multiline for multiple commands


key: steps

description: List of workflow steps to execute


description: Json-Schema definition for Avro AVSC files.

enum: null boolean int long float double bytes string

enum: ascending descending ignore

required: name type

required: type name fields

required: type name symbols

required: type items

required: type values

required: type name size


key: avroSchema

description: Root Schema


key: types

description: Allowed Avro types


key: primitiveType

description: Basic type primitives.


key: primitiveTypeWithMetadata

description: A primitive type with metadata attached.


key: customTypeReference

description: Reference to a ComplexType


key: avroUnion

description: A Union of types


key: avroField

description: A field within a Record


key: avroRecord

description: A Record


key: avroEnum

description: An enumeration


key: avroArray

description: An array


key: avroMap

description: A map of values


key: avroFixed

description: A fixed sized array of bytes


description: For every app on F-Droid a metadata file in the format of <application-id>.yml have to be provided, in order to build an app or check or if it has been updated. See https://f-droid.org/docs/Build_Metadata_Reference for a complete reference of a metadata file.

enum:
Connectivity
Development
Games
Graphics
Internet
Money
Multimedia
Navigation
Phone & SMS
Reading
Science & Education
Security
Sports & Health
System
Theming
Time
Writing

enum: git svn git-svn hg bzr srclib

const: auto

enum: yes no

const: yes

required: versionName versionCode

enum: None Static HTTP

required: Categories License Builds

required: Repo RepoType SourceCode

const: 0 versions

pattern: ^Tags

enum: Ads ApplicationDebuggable KnownVuln NonFreeAdd NonFreeAssets NonFreeDep NonFreeNet NoSourceSince NSFW UpstreamNonFree TetheredNet Tracking


key: AntiFeatures

description: Any number of anti-features the application has.


key: Categories

description: Any number of categories for the application to be placed in.


key: AuthorName

description: The name of the author, either full, abbreviated or pseudonym.


key: AuthorEmail

description: The e-mail address of the author(s).


key: AuthorWebSite

description: The website url of the author(s).


key: WebSite

description: The URL for the application's web site.


key: SourceCode

description: The URL to view or obtain the application's source code. This should be something human-friendly.


key: IssueTracker

description: The URL for the application's issue tracker.


key: Translation

description: The URL for the application's translation portal or at least a guide.


key: Changelog

description: The URL for the application's changelog.


key: Donate

description: The URL to donate to the project.


key: FlattrID

description: The project's Flattr (https://flattr.com) ID.


key: Liberapay

description: The project's Liberapay (https://liberapay.com) user or group name.


key: OpenCollective

description: The project's OpenCollective (https://opencollective.com) user or group name.


key: Bitcoin

description: A Bitcoin address for donating to the project.


key: Litecoin

description: A Litecoin address for donating to the project.


key: Name

description: The title of the application, with optional descriptive phrase.


key: AutoName

description: The name of the application as can best be retrieved from the source code.


key: Summary

description: DEPRECATED. A brief summary of what the application is. Should rather be provided via Fastlane.


key: Description

description: DEPRECATED. A full description of the application, relevant to the latest version. Should rather be provided via Fastlane.


key: AllowedAPKSigningKeys

description: The lowercase hex value of the SHA-256 fingerprint of the signing certificate of an app. If an APK of that app is not signed by one of these keys, it will not be included in the repository.


key: MaintainerNotes

description: This is a multi-line field using the same rules and syntax as the description. It's used to record notes for F-Droid maintainers to assist in maintaining and updating the application in the repository.


key: RepoType

description: The type of repository - for automatic building from source.


key: Repo

description: The repository location. Usually a git: or svn: URL, for example.


key: Binaries

description: The location of binaries used in verification process.


key: Builds

description: Any number of sub-entries can be present, each specifying a version to automatically build from source.


key: versionName

description: Specifies to build version xxx, which has a version code of yyy.


key: versionCode


key: commit

description: The commit parameter specifies the tag, commit or revision number from which to build it in the source repository.


key: disable

description: Disables this build, giving a reason why.


key: subdir

description: Specifies to build from a subdirectory of the checked out source code. Normally this directory is changed to before building.


key: submodules

description: Use if the project (git only) has submodules - causes git submodule update --init --recursive to be executed after the source is cloned.


key: sudo

description: Specifies a script to be run using sudo bash -x -c "xxxx" in the Buildserver VM guest. This script is run with full root privileges, but the state will be reset after each build.


key: timeout

description: Time limit for this build (in seconds). After time is up, Buildserver VM is forcefully terminated. The default is 7200 (2 hours); 0 means no limit.


key: init

description: Like 'prebuild', but runs on the source code BEFORE any other processing takes place.


key: oldsdkloc

description: The sdk location in the repo is in an old format, or the build.xml is expecting such. The 'new' format is sdk.dir while the VERY OLD format is sdk-location.


key: target

description: Specifies a particular SDK target for compilation, overriding the value defined in the code by upstream. This has different effects depending on what build system used — this flag currently affects Ant, Maven and Gradle projects only.


key: androidupdate

description: By default, 'android update' is used in Ant builds to generate or update the project and all its referenced projects. Specifying update=no bypasses that. Note that this is useless in builds that don't use Ant.


key: encoding

description: Adds a java.encoding property to local.properties with the given value. Generally the value will be 'utf-8'.


key: forceversion

description: If specified, the package version in AndroidManifest.xml is replaced with the version name for the build as specified in the metadata.


key: forcevercode

description: If specified, the package version code in the AndroidManifest.xml is replaced with the version code for the build. See also forceversion.


key: rm

description: Specifies the relative paths of files or directories to delete before the build is done.


key: extlibs

description: List of external libraries (jar files) from the build/extlib library, which will be placed in the libs directory of the project.


key: srclibs

description: Comma-separated list of source libraries or Android projects. Each item is of the form name@rev where name is the predefined source library name and rev is the revision or tag to use in the respective source control.


key: patch

description: Apply patch(es). 'x' names one (or more - comma-separated) files within a directory below the metadata, with the same name as the metadata file but without the extension. Each of these patches is applied to the code in turn.


key: prebuild

description: Specifies a shell command (or commands - chain with &&) to run before the build takes place.


key: scanignore

description: Enables one or more files/paths to be excluded from the scan process. This should only be used where there is a very good reason, and probably accompanied by a comment explaining why it is necessary.


key: scandelete

description: When running the scan process, any files that trigger errors - like binaries - will be removed. It acts just like scanignore, but instead of ignoring the files, it removes them.


key: build

description: As for 'prebuild', but runs during the actual build phase (but before the main Ant/Maven build). Use this only for actions that do actual building. Any preparation of the source code should be done using 'init' or 'prebuild'.


key: postbuild

description: Specifies a single or a list of shell commands to run after the build takes place.


key: buildjni

description: Enables building of native code via the ndk-build script before doing the main Ant build.


key: ndk

description: Version of the NDK to use in this build.


key: gradle

description: Build with Gradle instead of Ant, specifying what flavours to use. Flavours are case sensitive since the path to the output APK is as well.


key: maven

description: Build with Maven instead of Ant. An extra @<dir> tells F-Droid to run Maven inside that relative subdirectory.


key: preassemble

description: List of Gradle tasks to be run before the assemble task in a Gradle project build.


key: gradleprops

description: List of Gradle properties to pass via the command line to Gradle. A property can be of the form foo or of the form key=value.


key: antcommands

description: Specify an alternate set of Ant commands (target) instead of the default 'release'. It can't be given any flags, such as the path to a build.xml.


key: output

description: Specify a glob path where the resulting unsigned release APK from the build should be.


key: binary

description: The location of binaries used in verification process.


key: novcheck

description: Don't check that the version name and code in the resulting APK are correct by looking at the build output - assume the metadata is correct.


key: antifeatures

description: List of Anti-Features for this specific build. They are described in AntiFeatures.


key: Disabled

description: If this field is present, the application does not get put into the public index. The value should be a description of why the application is disabled.


key: RequiresRoot

description: Whether the application requires root privileges to be usable.


key: ArchivePolicy

description: This determines the number of versions to keep. The older versions of the app are moved to the archive repo, if one is configured. Defaults to 3.


key: AutoUpdateMode

description: This determines the method used for auto-generating new builds when new releases are available - in other words, adding a new Build Version line to the metadata.


key: UpdateCheckMode

description: This determines the method using for determining when new releases are available - in other words, the updating of the CurrentVersion and CurrentVersionCode fields in the metadata by the fdroid checkupdates process.


key: VercodeOperation

description: A list of operations to be applied to the vercode obtained by the defined UpdateCheckMode. %c will be replaced by the actual vercode, and each string will be passed to python's eval function to calculate a version code.


key: UpdateCheckIgnore

description: When checking for updates (via UpdateCheckMode) this can be used to specify a regex which, if matched against the version name, causes that version to be ignored.


key: UpdateCheckName

description: When checking for updates (via UpdateCheckMode) this can be used to specify the package name to search for. Useful when apps have a static package name but change it programmatically in some app flavors, by e.g. appending “.open” or “.free” at the end of the package name.


key: UpdateCheckData

description: Used in conjunction with UpdateCheckMode for certain modes.


key: CurrentVersion

description: The name of the version that is the recommended release. There may be newer versions of the application than this (e.g. unstable versions), and there will almost certainly be older ones.


key: CurrentVersionCode

description: The version code corresponding to the CurrentVersion field.


key: NoSourceSince

description: In case we are missing the source code for the CurrentVersion reported by Upstream, or that Non-Free elements have been introduced, this defines the first version that began to miss source code.


key: author

description: Use the "authors" key instead, even when there is only one author. Existing feeds can include both "author" and "authors" for compatibility with existing feed readers. Feed readers should always prefer `authors` if present.


key: id

description: Is unique for that item for that feed over time. If an item is ever updated, the id should be unchanged. New items should never use a previously-used id. Ideally, the id is the full URL of the resource described by the item, since URLs make great unique identifiers.


key: language

description: The language for this item, using the same format as the top-level "language" field. The value can be different than the primary language for the feed when a specific item is written in a different language than other items in the feed.


description: The primary language for the feed in the format specified in RFC 5646. The value is usually a 2-letter language tag from ISO 639-1, optionally followed by a region tag. (Examples: "en" or "en-US".)


key: version

description: The URL of the version of the format the feed uses. This should appear at the very top, though we recognize that not all JSON generators allow for ordering.


key: options

description: Set the options for grunt-contrib-copy

type: boolean number


key: noProcess

description: This option is passed to grunt.file.copy as an advanced way to control which file contents are processed.


key: encoding

description: The file encoding to copy files with.


key: mode

description: Whether to copy or set the existing file permissions. Set to true to copy the existing file permissions. Or set to the mode, i.e.: 0644, that copied files will be set to.


enum: tcp udp

default: connections

enumValues: Autoscale based on number of concurrent connections

enumValues: Autoscale based on number of concurrent requests

enum: connections requests

enum: SIGINT SIGTERM SIGQUIT SIGUSR1 SIGUSR2 SIGKILL SIGSTOP

default: canary

enum: canary rolling bluegreen immediate

main: Strategy for replacing VMs during a deployment.

enumValues: This default strategy - for apps without volumes - will boot a single, new VM with the new release, verify its health, then proceed with a rolling restart strategy.

enumValues: One by one, each running VM is taken down and replaced by a new release VM. This is the default strategy for apps with volumes.

enumValues: For every running VM, a new one is booted alongside it. All new VMs must pass health checks to complete deployment, when traffic gets migrated to new VMs. If your app has multiple VMs, this strategy may reduce deploy time and downtime, assuming your app is scaled to 2 or more VMs.

enumValues: Replace all VMs with new releases immediately without waiting for health checks to pass. This is useful in emergency situations where you're confident a release will be healthy.

defaultValue: Default is 'canary': boot a single, new VM with the new release, verify its health, then proceed with a rolling restart strategy.

required: source destination


description: The path inside your container where the assets to serve are located.


description: The URL prefix that should serve the static assets.


key: services

description:
Configure the mapping of ports from the public Fly proxy to your application.

You can have:
* **No services section**: The application has no mappings to the external internet - typically apps like databases or background job workers that talk over 6PN private networking to other apps.
* **One services section**: One internal port mapped to one external port on the internet.
* **Multiple services sections**: Map multiple internal ports to multiple external ports.


Health checks that run as one-off commands directly on the VM.

This type of check is **deprecated**. See `tcp_checks` or `http_checks` for alternatives.


key: protocol

description: The protocol used to communicate with your application. Can be: `tcp` or `udp`.


description: The port this application listens on to communicate with clients. The default is 8080. We recommend applications use the default.


key: concurrency

description: Control autoscaling metrics (connections or requests) and limits (hard and soft).


description: When an application instance is __at__ or __over__ this number, the system will bring up another instance.


description: When an application instance is __at__ or __over__ this number, the system is likely to bring up another instance.


key: ports

description: For each external port you want to accept connections on, add a `ports` section.


key: handlers

description:
An array of strings that select handlers to terminate the connection at the edge.

Valid options: http, tls, proxy_proto, pg_tls, edge_http.


key: port

description: The port to accept traffic on. Valid ports: 1-65535


description: Force HTTP connections to HTTPS. `force_https` requires the `http` handler in the `handlers` section.


description: Basic TCP connection health checks. This is the default check that runs against the configured `internal_port`.


description: The time to wait after a VM starts before checking its health. Units are milliseconds unless you specify them like `10s` or `1m`.


key: interval

description: Length of the pause between connectivity checks. Units are milliseconds unless you specify them like `10s` or `1m`.


description: The number of consecutive TCP check failures to allow before attempting to restart the VM. The default is `0`, which disables restarts based on failed TCP health checks.


key: timeout

description: The maximum time a connection can take before being reported as failing its healthcheck. Units are milliseconds unless you specify them like `10s` or `1m`.


description: HTTP-based health checks run against the `internal_port`. These checks will pass when receiving a 2xx response. Any other response is considered a failure.


description: The number of consecutive check failures to allow before attempting to restart the VM. The default is `0`, which disables restarts based on failed health checks.


key: method

description: The HTTP method to be used for the check.


key: path

description: The path of the URL to be requested.


description: The protocol to be used (`http` or `https`)


description: When set to `true` (and `protocol` is set to `https`), skip verifying the certificates sent by the server.


key: headers

description: Set key/value pairs of HTTP headers to pass along with the check request.


key: app

description: Fly.io application name


description: Seconds to wait before forcing a VM process to exit. Default is 5 seconds.


description: Signal to send to a process to shut it down gracefully. Default is SIGINT.


key: statics

description: The `statics` sections expose static assets built into your application's container to Fly's Anycast network. You can serve HTML files, Javascript, and images without needing to run a web server inside your container.


description:
Command to run after a build, with access to the production environment, but before deployment. Non-zero exit status will abort the deployment.

```toml
[deploy]
  release_command ="bundle exec rails db:migrate"
```


key: strategy

description: Strategy for replacing VMs during a deployment.


key: mounts

description:
Mount [persistent storage volumes](https://fly.io/docs/reference/volumes) previously setup via `flyctl`. Both settings are required. Example:

```toml
[mounts]
  source = "myapp_data"
  destination = "/data"
```


key: source

description:
The name of the volume to mount as shown in `fly volumes list`.

A volume of this name *must exist* in each of the app regions. If there's more than one volume in the target region with the same one, one will be picked randomly.


key: destination

description: The path at which the `source` volume should be mounted in the running app VM.


key: processes

description: The name of the process(es) to which this mount should be applied. See [multiple processes](https://community.fly.io/t/preview-multi-process-apps-get-your-workers-here/2316).


key: experimental

description: Flags and features that are subject to change, deprecation or promotion to the main configuration.


key: cmd

description:
Override the server command (CMD) set by the Dockerfile. Specify as an array of strings:

```toml
cmd = ["path/to/command", "arg1", "arg2"]
```


key: entrypoint

description:
Override the ENTRYPOINT set by the Dockerfile. Specify as an array of strings:

```toml
entrypoint = ["path/to/command", "arg1", "arg2"]
```


description: Failed deployments should roll back automatically to the previous successfully deployed release. Defaults to `true`


description: Enables private network access to the Fly organization. Defaults to `true`.


key: env

description:
Set non-sensitive information as environment variables in the application's [runtime environment](https://fly.io/docs/reference/runtime-environment/).
For sensitive information, such as credentials or passwords, use the [secrets command](https://fly.io/docs/reference/secrets). For anything else though, the `env` section provides a simple way to set environment variables. Here's an example:
```toml
[env]
  LOG_LEVEL = "debug"
  S3_BUCKET = "my-bucket"
```


key: build

description: Build configuration options. See docs at https://fly.io/docs/reference/builders.


key: builder

description: Builder Docker image to be used with the 'buildpacks' option


key: buildpacks

description: Buildpacks to be run by the 'builder' Docker image


key: args

description:
Build arguments passed to both Dockerfile and Buildpack builds. These arguments are **not available** on VMs at runtime.
```toml
[build.args]
  USER = "julieta"
  MODE = "production"
```


key: build-target

description: Specify the target stage for [multistage Dockerfile builds](https://docs.docker.com/develop/develop-images/multistage-build/).


key: image

description: Docker image to be deployed (skips the build process)


key: dockerfile

description: Dockerfile used for builds. Defaults to './Dockerfile'


key: name

description:
The name of the package

https://github.com/clibs/clib/wiki/Explanation-of-clib.json#name


key: version

description:
The semantic version number of the package. This number should also be a git tag.

https://github.com/clibs/clib/wiki/Explanation-of-clib.json#version


key: src

description:
An array of source files that make up the implementation of your package.

https://github.com/clibs/clib/wiki/Explanation-of-clib.json#src


key: dependencies

description:
A dictionary of packages and their versions. Each entry represents a package dependency. A dependency must be a clib package.

https://github.com/clibs/clib/wiki/Explanation-of-clib.json#dependencies


key: development

description:
Development dependencies are for testing and development purposes.

https://github.com/clibs/clib/wiki/Explanation-of-clib.json#development


key: repo

description:
he GitHub slug for your package.

https://github.com/clibs/clib/wiki/Explanation-of-clib.json#repo


key: description

description:
A short-and-sweet description of your package.

https://github.com/clibs/clib/wiki/Explanation-of-clib.json#description


key: keywords

description:
An array of keywords which describe your package.

https://github.com/clibs/clib/wiki/Explanation-of-clib.json#keywords


key: license

description:
The license your package is released under.

https://github.com/clibs/clib/wiki/Explanation-of-clib.json#license


key: makefile

description:
Your package's Makefile.

https://github.com/clibs/clib/wiki/Explanation-of-clib.json#makefile


key: install

description:
Define a script to install your package. This is for executables and libraries only.

https://github.com/clibs/clib/wiki/Explanation-of-clib.json#install


key: uninstall

description:
Define a script to uninstall your package.

https://github.com/clibs/clib/wiki/Explanation-of-clib.json#uninstall


description: NCBI Prokaryotic Genome Annotation Pipeline (PGAP) input metadata (submol) JSON/YAML configuration file

examples: This draft WGS assembly was generated by running SKESA to generate a de-novo assembly. The de-novo assembly was then concatenated with  configs generated using a guided assembler using antimicrobial resistance genes as baits to comprehensively catalog the set of resistance genes in the isolate. Note, some parts of the configs derived from the guided assembler may overlap de-novo configs, and other guided assembler configs. De-novo configs can be differentiated from guided assembler configs by their names, which include either 'denovo' or 'guided'.

required: organization department city country street email first_name last_name postal_code

examples: MD Florida

examples: Institute of Klebsiella foobarensis research

enum: published in-press unpublished

examples: circular linear

examples: chromosome plasmid


key: $schema

description: The value of this keyword MUST be a URI (containing a scheme) and this URI MUST be normalized.


key: consortium

description: Name of the project that generated the genome assembly


key: comment

description: Appears in the COMMENT section of each GenBank sequence record.


description: NCBI internal flag used for testing.


key: sra

description: Sequence reads used to build the assembly


key: accession

description: Sequence Read Archive (SRA) accession for the run (with SRR, ERR or DRR prefix)


key: authors

description: Optional, but include if intending to submit to GenBank. Authors can be different from the contact.


description: Optional, but include if intending to submit to GenBank. The main contact for this genome assembly.


description: One to 9-letter prefix to use for naming genes on this genome assembly. If an official locus tag prefix was already reserved from an INSDC organization (GenBank, ENA or DDBJ) for the given BioSample and BioProject pair, provide here. Otherwise, provide a string of your choice. If no value is provided, the prefix 'pgaptmp' will be used. See more details in this Note about locus tags at: https://github.com/ncbi/pgap/wiki/Input-Files#Note-about-locus-tags


key: strain

description: Strain of the sequenced organism


description: Binomial name or, if the species is unknown, genus for the sequenced organism. This identifier must be valid in NCBI Taxonomy. See Taxonomy information for how to find out if the name is valid: https://github.com/ncbi/pgap/wiki/Input-Files#Taxonomy-information


key: status

description: Can be only one of: published, in-press, unpublished


key: topology

description: Possible values are linear or circular. Circular means that the first base in the sequence is adjacent to the last base. Please provide the topology in the metadata YAML file only if it is applicable to ALL sequences in the fasta file. If some sequences in the assembled genome are circular and others linear, include the topology in the definition line of each sequence in the fasta file with the tag value pair [topology=circular] or [topology=linear], after the SeqID and a space (e.g. >seq1 [topology=circular]). If the topology is provided in neither the metadata YAML nor the fasta file, the sequences will be presumed to be linear.


key: location

description: Possible values are chromosome or plasmid. Please provide the location in the metadata YAML file only if it is applicable to ALL sequences in the fasta file. If some sequences in the assembled genome are chromosomes and others plasmids, include the location in the definition line of each sequence in the fasta file with the tag value pair [location=chromosome] or [location=plasmid], after the SeqID and a space (e.g. >seq1 [location=plasmid]). In plasmid case add [plasmid-name=<plasmidname>]. If the location is provided in neither the metadata YAML nor the fasta file, the sequences will be presumed to be chromosome. Note: since 2021 releases of PGAPx this will affect noticeably the annotation on the molecule


enum: rustc cargo rustfmt rust-std rust-docs rls clippy miri rust-src rust rust-analysis llvm-tools rustc-docs rustc-dev rust-analyzer reproducible-artifacts rust-docs-json

enumValues:
The Rust compiler and [Rustdoc].

[rustdoc]: https://doc.rust-lang.org/rustdoc/

enumValues:
[Cargo] is a package manager and build tool.

[cargo]: https://doc.rust-lang.org/cargo/

enumValues:
[Rustfmt] is a tool for automatically formatting code.

[rustfmt]: https://github.com/rust-lang/rustfmt

enumValues:
This is the Rust [standard library]. There is a separate
  `rust-std` component for each target that `rustc` supports, such as
  `rust-std-x86_64-pc-windows-msvc`. See the [Cross-compilation] chapter for
  more detail.

[standard library]: https://doc.rust-lang.org/std/
[cross-compilation]: .https://rust-lang.github.io/rustup/cross-compilation.html

enumValues:
This is a local copy of the [Rust documentation]. Use the
  `rustup doc` command to open the documentation in a web browser. Run `rustup
  doc --help` for more options.

[rust documentation]: https://doc.rust-lang.org/

enumValues:
[RLS] is a language server that provides support for editors and
  IDEs.

[RLS]: https://github.com/rust-lang/rls

enumValues:
[Clippy] is a lint tool that provides extra checks for common
  mistakes and stylistic choices.

[clippy]: https://github.com/rust-lang/rust-clippy

enumValues:
[Miri] is an experimental Rust interpreter, which can be used for
  checking for undefined-behavior.

[miri]: https://github.com/rust-lang/miri/

enumValues:
This is a local copy of the source code of the Rust standard
  library. This can be used by some tools, such as [RLS], to provide
  auto-completion for functions within the standard library; [Miri] which is a
  Rust interpreter; and Cargo's experimental [build-std] feature, which allows
  you to rebuild the standard library locally.

[RLS]: https://github.com/rust-lang/rls
[miri]: https://github.com/rust-lang/miri/
[build-std]: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#build-std

enumValues:
Metadata about the standard library, used by tools like
  [RLS].

[RLS]: https://github.com/rust-lang/rls

enumValues:
This contains a linker and platform libraries for building on
  the `x86_64-pc-windows-gnu` platform.

enumValues:
This is an experimental component which contains a
  collection of [LLVM] tools.

[LLVM]: https://llvm.org/

enumValues:
This component contains the compiler as a library. Most users
  will not need this; it is only needed for development *of* tools that link
  to the compiler, such as making modifications to [Clippy].

[clippy]: https://github.com/rust-lang/rust-clippy

default: default

enum: minimal default complete

enumValues:
This profile includes as few components as possible to get a
working compiler (`rustc`, `rust-std`, and `cargo`). It's recommended to use
this component on Windows systems if you don't use local documentation (the
large number of files can cause issues with some Antivirus systems), and in
CI.

enumValues:
This profile includes all of components in the **minimal**
profile, and adds `rust-docs`, `rustfmt`, and `clippy`. This profile will be
used by `rustup` by default, and it's the one recommended for general use.

enumValues:
This profile includes all the components available through
`rustup`. This should never be used, as it includes *every* component ever
included in the metadata and thus will almost always fail. If you are
looking for a way to install devtools such as `miri` or IDE integration
tools (`rls`), you should use the `default` profile and
install the needed additional components manually, either by using `rustup
component add` or by using `-c` when installing the toolchain.


key: toolchain

description:
A `toolchain` is a complete installation of the Rust compiler (`rustc`) and related tools (like `cargo`). A toolchain specification includes the release channel or version, and the host platform that the toolchain runs on.

 Get more from [`Toolchains`](https://rust-lang.github.io/rustup/concepts/toolchains.html)


key: channel

description:
`channel` is a named release channel, a major and minor version number such as `1.42`, or a fully specified version number, such as `1.42.0`. Channel names can be optionally appended with an archive date, as in `nightly-2014-12-18`, in which case the toolchain is downloaded from the archive for that date. Get more from [`Toolchain specification`](https://rust-lang.github.io/rustup/concepts/toolchains.html).

Other valid channel like `stable`,`1.63`,`1.63.0`,`nightly-2022-09-20`,`stable-x86_64-pc-windows-msvc`,`1.63.0-riscv64gc-unknown-linux-gnu`,`nightly-2022-09-20-x86_64-unknown-nux-gnu`


key: components

description:
Each release of Rust includes several "components", some of
which are required (like `rustc`) and some that are optional (like [`clippy`](https://github.com/rust-lang/rust-clippy))

 Learn more from [`Components`](https://rust-lang.github.io/rustup/concepts/components.html)


key: targets

description:
`rustc` is capable of generating code for many platforms. The `target` specifies the platform that the code will be generated for. By default, `cargo` and `rustc` use the host toolchain's platform as the target. To build for a different `target`, usually the target's standard library needs to be installed first via the `rustup target` command. Or you can run `rustc --print target-list` to list [`"built-in" targets`](https://doc.rust-lang.org/rustc/targets/built-in.html)

 Get more from [`Platform Support`](https://doc.rust-lang.org/rustc/platform-support.html) and [`Targets`](https://doc.rust-lang.org/rustc/targets/index.html)


key: profile

description:
[`Profiles`](https://rust-lang.github.io/rustup/concepts/profiles.htm) are groups of [`components`](https://rust-lang.github.io/rustup/concepts/components.html) you can choose to download while installing a new Rust [`toolchain`](https://rust-lang.github.io/rustup/concepts/toolchains.html).

 The `profiles` available at this time are `minimal`, `default`, and `complete`.


key: path

description:
Path to a custom local toolchain. Since a `path` directive directly names a local toolchain, other options
like `components`, `targets`, and `profile` have no effect. `channel`
and `path` are mutually exclusive, since a `path` already points to a
specific toolchain. A relative `path` is resolved relative to the
location of the `rust-toolchain.toml` file.

 Learn more from [`Custom toolchains`](https://rust-lang.github.io/rustup/concepts/toolchains.html#custom-toolchains)


description: A KSP-AVC version file's content

required: USERNAME REPOSITORY

required: NAME VERSION

required: PATH DIRECTORY


key: NAME

description: The display name for the add-on


key: URL

description: Location of a remote version file for update checking


key: DOWNLOAD

description: Web address where the latest version can be downloaded


description: The complete or incremental change log for the add-on


description: Populates the CHANGE_LOG field using the file at this url


key: GITHUB

description: Allows KSP-AVC to do release checks with GitHub including setting a download location if one is not specified. If the latest release version is not equal to the version in the file, an update notification will not appear.


key: USERNAME

description: Your GitHub username


key: REPOSITORY

description: The name of the source repository


description: Include pre-releases in the latest release search


description: URL to this mod's page on KerbalStuff


key: VERSION

description: The version of the add-on


Version of KSP that the add-on was made to support


Minimum version of KSP that the add-on supports


Maximum version of KSP that the add-on supports


description: If true, don't trust KSP-AVC's idea of which game versions are compatible with which other game versions, based on user configuration


description: DO NOT USE, won't work with CKAN; name of a DLL to check for VERSION on the fly


description: DO NOT USE, won't work with CKAN; a list of versions with which this mod is compatible


description: DO NOT USE, won't work with CKAN; a list of versions with which this mod is incompatible


description: DO NOT USE, won't work with CKAN; if true, don't override properties using the remote version file


description: DO NOT USE, won't work with CKAN; if false, don't override properties using the remote version file


Stanza to define file location to check, used by MADLAD


key: version

description: A semantic(?) version


key: MAJOR

description: Change major version when you make incompatible API changes


key: MINOR

description: Change minor version when you add functionality in a backwards-compatible manner


key: PATCH

description: Change patch version when you make backwards-compatible bug fixes


key: BUILD

description: Build informaion


description: definition of the install_loc fields


description: Name of the mod, If not specified, uses the Modname from the .version file


key: PATH

description: Path to the directory, begins below the GameData.  Must be there, but will be empty in most cases


key: DIRECTORY

description: Directory where file is


key: FILE

description: filename to be checked.  If not specified, then it checks for the directory only


description: Configuration file defining a predicate for a data pack for Minecraft.

enum: this killer killer_player

type: integer object

enum: minecraft:constant minecraft:uniform minecraft:binomial minecraft:score

type: number object

type: string object

enum: fixed context

const: fixed

const: context

type: boolean integer string object

enum: minecraft:custom minecraft:crafted minecraft:used minecraft:broken minecraft:mined minecraft:killed minecraft:picked_up minecraft:dropped minecraft:killed_by


key: terms

description: A list of conditions to join using 'or'.


key: block

description: A block ID.


key: properties

description: A map of block property names to values.


key: predicate

description: Predicate applied to the damage source.


key: then

description: Test properties of an entity.


key: entity

description: Specifies the entity to check for the condition.


description: Predicate applied to entity.


description: Test the scoreboard scores of an entity.


key: scores

description: Scores to check. All specified scores must pass for the condition to pass.


description: Inverts condition from parameter term.


key: term

description: The condition to be negated.


description: Test if a killer_player entity is available.


key: inverse

description: If true, the condition passes if killer_player is not available.


description: Checks if the current location matches.


key: offsetX

description: Offsets to location.


key: offsetY

description: Offsets to location.


key: offsetZ

description: Offsets to location.


description: Predicate applied to location.


description: Checks tool.


description: Predicate applied to item.


description: Test if a random number 0.0–1.0 is less than a specified value.


key: chance

description: Success rate.


description: Test if a random number 0.0–1.0 is less than a specified value, affected by the level of Looting on the killer entity.


description: Base success rate.


description: Looting adjustment to the base success rate. Formula is chance + (looting_level * looting_multiplier).


description: Test if another referred condition (predicate) passes.


key: name

description: The namespaced ID of the condition (predicate) referred to. A cyclic reference causes a parsing failure.


description: Returns true with 1/explosion radius probability.


description: Passes with probability picked from table, indexed by enchantment level.


key: enchantment

description: Id of enchantment.


key: chances

description: List of probabilities for enchantment level, indexed from 0.


description: Checks the current time.


key: value

description: The time value in ticks.


key: period

description: Time gets modulo-divided by this value (for example, if set to 24000, value operates on a time period of daytime ticks just like /time query daytime).


description: Checks for a current weather state.


key: raining

description: If true, the condition evaluates to true only if it's raining or thundering.


key: thundering

description: If true, the condition evaluates to true only if it's thundering.


description: Checks for range of value.


description: The value to test.


key: range


key: max

description: The max value.


key: min

description: The minimum value.


description: The max value.


description: The minimum value.


key: type

description: The number provider type.


key: then

description: A constant value.


description: The exact value.


description: A random number following a uniform distribution between two values (inclusive).


description: The minimum value.


description: The maximum value.


description: A random number following a binomial distribution.


key: n

description: The amount of trials.


key: p

description: The probability of success on an individual trial.


description: A scoreboard value.


key: target

description: Scoreboard name provider.


description: Resource location.


description: A UUID or player name.


key: score

description: The scoreboard objective.


key: scale

description: Scale to multiply the score before returning it.


description: An enchantment ID.


key: levels

description: The level of the enchantment.


description: Checks if the damage bypassed the armor of the player (suffocation damage predominantly).


description: Checks if the damage bypassed the invulnerability status of the player (void or /kill damage).


description: Checks if the damage was caused by starvation.


description: The entity that was the direct cause of the damage.


description: Checks if the damage originated from an explosion.


description: Checks if the damage originated from fire.


description: Checks if the damage originated from magic.


description: Checks if the damage originated from a projectile.


description: Checks if the damage originated from lightning.


Checks the entity that was the source of the damage (for example: The skeleton that shot the arrow).


key: count

description: The amount of the item.


key: durability

description: The durability of the item.


key: enchantments

description: List of enchantments.


List of stored enchantments.


key: items

description: List of item IDs.


key: nbt

description: An NBT string.


key: potion

description: A brewed potion ID.


key: tag

description: An item data pack tag.


key: biome

description: The biome the entity is currently in.


key: block

description: The block at the location.


key: blocks

description: A list of block IDs.


description: The block tag.


description: The block NBT.


key: state

description: A map of block property names to values. Test will fail if the block doesn't match.