Skip to content

Troubleshooting

My plugin isn't showing up in the database

Check the following:

  1. PR merged? Ensure your pull request was approved and merged
  2. RHFest passing? All validation checks must pass
  3. Release published? You need at least one GitHub release
  4. Version mismatch? Release tag must match manifest.json version
  5. Wait time: Updates happen every 2 hours

The RHFest validation is failing

Common issues:

  • Folder structure: Ensure your plugin is in custom_plugins/DOMAIN/
  • Manifest keys: All required fields must be present
  • Domain format: Use only lowercase letters, numbers, and underscores; avoid leading, trailing, or consecutive underscores; and match the plugin directory name
  • Version format: Must follow semantic versioning
  • RHAPI version format: Use major.minor, for example 1.0
  • Plugin entry point: Provide exactly one top-level initialize(rhapi) function in __init__.py
  • Private API access: Replace access to _racecontext through rhapi or one of its namespaces with public RHAPI methods

Use the rule code and help text from the validation output, then check the RHFest Action documentation for details.

My plugin causes RotorHazard to crash

Debug steps:

  1. Check the RotorHazard logs for error messages
  2. Verify all dependencies are installed correctly
  3. Test with minimal functionality first
  4. Ensure compatibility with the required RotorHazard API version
  5. Ask for help in the Discord community

How do I handle plugin dependencies?

List Python dependencies in the dependencies field of manifest.json:

"dependencies": [
  "numpy>=1.21",
  "flask==2.2.3"
]

RotorHazard will attempt to install these automatically. Use standard PyPI package names and version specifiers. See also the Getting Started guide.