writing-plugins
Use when writing, scaffolding, or modifying Nuclear plugins. Covers plugin structure, manifest, entry point, provider types, available APIs, and publishing. Trigger phrases include "create a plugin", "write a plugin", "plugin scaffold", "streaming provider", "metadata provider".
Quellinformationen
- Repository
- nukeop/nuclear
- Letzte Quellaktivität
- 1. Juli 2026 um 14:57
- Erkannte Sprache von SKILL.md
- Englisch
- Sterne
- 18.705
- Forks
- 1.340
Installationsoptionen
Standardmäßig ist der Prompt ausgewählt, der zuerst die Quelle prüft. Sie können zu einem direkten Befehl wechseln oder eine lokale Kopie herunterladen.
Quelldateien prüfen
Lesen Sie SKILL.md und alle von SkillsMP angezeigten Begleitdateien, bevor Sie sich für eine Installation entscheiden.
SKILL.md wird angezeigt
SKILL.md
Quellanweisungen · Schreibgeschützte Vorschau- name
- writing-plugins
- description
- Use when writing, scaffolding, or modifying Nuclear plugins. Covers plugin structure, manifest, entry point, provider types, available APIs, and publishing. Trigger phrases include "create a plugin", "write a plugin", "plugin scaffold", "streaming provider", "metadata provider".
# Writing Nuclear Plugins
Plugins are standalone repos compiled in-browser via esbuild-wasm.
## Structure
```
my-plugin/
package.json # Manifest with nuclear metadata
src/
index.ts # Entry point, default exports NuclearPlugin
```
## Manifest (package.json)
```json
{
"name": "nuclear-plugin-example",
"version": "0.1.0",
"description": "What this plugin does",
"author": "Your Name",
"license": "AGPL-3.0-only",
"main": "src/index.ts",
"type": "module",
"nuclear": {
"displayName": "Example Plugin",
"category": "streaming",
"icon": { "type": "link", "link": "https://example.com/icon.svg" }
},
"dependencies": {
"@nuclearplayer/plugin-sdk": "^1.1.0"
}
}
```
Categories: `streaming`, `metadata`, `lyrics`
## Entry Point
```typescript
import type { NuclearPlugin, NuclearPluginAPI } from '@nuclearplayer/plugin-sdk';
const plugin: NuclearPlugin = {
onLoad(api: NuclearPluginAPI) {},
onEnable(api: NuclearPluginAPI) {
// Register providers
},
onDisable() {
// Unregister providers
},
onUnload() {},
};
export default plugin;
```
## Provider Types
**Streaming** - resolve tracks to playable audio:
```typescript
const provider: StreamingProvider = {
id: 'my-streaming',
kind: 'streaming',
name: 'My Streaming',
async searchForTrack(artist, title, album?) { /* return StreamCandidate[] */ },
async getStreamUrl(candidateId) { /* return Stream */ },
};
api.Providers.register(provider);
api.Providers.unregister('my-streaming');
```
**Metadata** - search artists/albums, fetch details:
```typescript
const provider: MetadataProvider = {
id: 'my-metadata',
kind: 'metadata',
name: 'My Metadata',
searchCapabilities: ['artists', 'albums'],
streamingProviderId: 'my-streaming', // Optional: locks streaming to this provider
async searchArtists(params) { /* ... */ },
async searchAlbums(params) { /* ... */ },
async fetchArtistBio(id) { /* ... */ },
async fetchAlbumDetails(id) { /* ... */ },
};
```
## Available APIs
- `api.Providers` - register/unregister providers
- `api.Settings` - plugin settings storage
- `api.Http` - fetch wrapper
- `api.Ytdlp` - yt-dlp integration
- `api.Queue` - playback queue control
- `api.Metadata` - search music metadata
- `api.Streaming` - resolve streams
- `api.Logger` - logging (trace/debug/info/warn/error)
## Publishing
1. Create a GitHub repo with the plugin code
2. Add `.github/workflows/release.yml`:
```yaml
name: Release
on:
push:
tags: ['v*']
jobs:
release:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- run: zip -r plugin.zip src package.json README.md
- uses: softprops/action-gh-release@v2
with:
files: plugin.zip
generate_release_notes: true
```
3. Tag release: `git tag v0.1.0 && git push origin v0.1.0`
4. Submit PR to `NuclearPlayer/plugin-registry` adding your plugin to `plugins.json`
Auf GitHub ansehen