FivePD API

File Types

FivePD offers flexibility in how you write configuration files, supporting both YAML and JSON formats for most configuration needs.

Supported File Types

For most configuration files within FivePD and your own addons, you can choose to use either YAML (.yaml) or JSON (.json). This allows you to select the format you are most comfortable with.

File Prioritization

In situations where both a .json and a .yaml version of the same configuration file exist (e.g., config.json and config.yaml), FivePD will always prioritize and load the .json file. The .yaml file will be ignored.

Exception: Localization Files

An important exception to this rule is the localization files located in the fivepd/Localizations/ directory. These files must be .json and do not support the YAML format.

Loading Other File Types in Addons

While FivePD's core configuration system is built around JSON and YAML, your addons are not limited to these types for your own custom data. You can load any file type as raw text content.

For detailed instructions on how to handle custom files within your addon, please see the Loading Custom Files guide.