This documentation provides a guide to the user plugin format used in Pedal Games. It covers the structure, field definitions, templates, display properties, and validation criteria for creating user plugins.
- Introduction: An overview of the user plugin format and its purpose.
- Plugin Structure: Detailed information on the overall structure of a user plugin and required properties.
- Field Definitions: A description of the field definitions within a user plugin, including attributes for each field.
- Templates: Explanation of the different templates available for user plugins and their implementation.
- Display: Guidelines on defining display properties and formatting the display string.
- Validation: Criteria for validating user plugins to ensure they meet the necessary requirements.
- Data fields: Available built-in data fields.
To get started with creating user plugins, refer to the sections above for detailed instructions and examples. Each section is designed to help you understand the various aspects of the user plugin format and how to effectively implement it within your application.
https://github.com/jeroni7100/pg-zwift-log-plugin
https://github.com/pedalgames/demo-plugins-jrn
Contributions to this documentation are welcome. Please follow the guidelines outlined in the project repository for submitting changes or improvements.