hydro-plugin-overview

A Hydro plugin requires a minimal package structure that exports an entry point and follows specific import conventions from the public hydrooj API surface. You can expose functionality using either a simple function or a stateful class.

Hydro plugin entry points can be exposed either as a function using apply(ctx) or as a stateful class inheriting from the Service subclass. The choice depends on whether your plugin needs to maintain state across its lifecycle.

When developing a Hydro plugin, you must import required modules from the public hydrooj API surface. This ensures you use stable APIs and follow the correct conventions for accessing routes, UI injection, i18n, and templates.

Yes, you can view a complete minimal Hydro plugin example that demonstrates practical implementation including routes, UI injection, i18n, and templates. This example helps verify functionality within a running Hydro environment.

Yes, verifying your Hydro plugin requires a running Hydro environment to test its routes and initialization. The skill provides minimal working examples specifically designed for verification in an active deployment.

You should use a stateful class-style Hydro plugin when your plugin needs to maintain state across its lifecycle. Function-style plugins using apply(ctx) are suitable for simpler scenarios without state requirements.