nik/navidrome
1
0
Fork 0
mirror of https://github.com/navidrome/navidrome.git synced 2026-08-31 07:30:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update Go and Rust plugin developer sections for clarity

Browse Source 
Signed-off-by: Deluan <deluan@navidrome.org>
This commit is contained in:
Deluan 2025-12-31 14:46:08 -05:00
parent 374dd2343d
commit f8149c320f
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
plugins/capabilities/README.md
View File

@ -7,7 +7,11 @@ This directory contains the Go interface definitions for Navidrome plugin capabi
## For Go Plugin Developers
Go developers should use the generated PDK packages in `plugins/pdk/go/`. See the example plugins in `plugins/examples/` for usage patterns.
Go developers should use the generated PDK packages in `plugins/pdk/go/`. See the example Go plugins in `plugins/examples/` for usage patterns.
## For Rust Plugin Developers
Rust developers should use the generated PDK crate in `plugins/pdk/rust/nd-pdk`. See the example Rust plugins in `plugins/examples` for usage patterns.
## For Non-Go Plugin Developers
@ -65,18 +69,15 @@ xtp plugin init --schema-file plugins/capabilities/websocket_callback.yaml \
After generating the scaffolding, implement the required functions and build your plugin as a WebAssembly module. The exact build process depends on your chosen language - see the [Extism PDK documentation](https://extism.org/docs/concepts/pdk) for language-specific guides.
## Schema Generation
## XTP Schema Generation
The YAML schemas are automatically generated from the Go interfaces using `ndpgen`:
The YAML schemas in this package are automatically generated from the capability Go interfaces using `ndpgen`.
To regenerate the schemas after modifying the interfaces, run:
```bash
go run ./plugins/cmd/ndpgen -schemas -input=./plugins/capabilities
cd plugins/cmd/ndpgen && go run . -schemas -input=./plugins/capabilities
```
### Technical Note: XTP Schema Compatibility
The generated schemas include `type: object` on object schemas. While this is technically not valid according to the [XTP JSON Schema specification](https://raw.githubusercontent.com/dylibso/xtp-bindgen/5090518dd86ba5e734dc225a33066ecc0ed2e12d/plugin/schema.json), it is **required** as a workaround for XTP's code generator to properly resolve type information (especially for structs with empty properties). XTP tolerates this with a validation warning but generates correct code.
## Resources
- [XTP Documentation](https://docs.xtp.dylibso.com/)