Configure Your Addon

Every FivePD addon requires a metadata.yaml or metadata.json file in its root directory. This file contains essential information that tells FivePD how to load and identify your addon.

Below is an example of a metadata.yaml file and a detailed explanation of each property.

FriendlyName: My Awesome Addon
Version: 100
FriendlyVersion: 1.0.0
Author: Your Name
Assemblies:
  - MyAwesomeAddon.dll
Files:
  - custom_data.xml

Properties

FriendlyName

Type: string
Required: Yes

The public display name for your addon. This name is used in server logs and may be shown in future in-game user interfaces.

Version

Type: integer
Required: Yes

The internal version number of your addon. This should be an integer that you increment with each new release (e.g., 100, 101, 102). It can be used programmatically for version checks and dependency management.

FriendlyVersion

Type: string
Required: Yes

A human-readable version string, typically following Semantic Versioning (e.g., "1.0.0", "2.1.0-beta"). This is used for display purposes.

Author

Type: string
Required: Yes

The name of the addon's creator or team.

Assemblies

Type: list of strings
Required: Yes

A list of all the .dll files that FivePD should load for your addon. These assemblies contain your core logic, such as your IExtension or Callout implementations.

Files

Type: list of strings
Required: No

A list of any additional custom files your addon needs to access, such as configuration files (.xml, .json) or data files. For more information on how to load and use these files, see the Loading Custom Files guide.