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".
소스 정보
- 저장소
- nukeop/nuclear
- 최근 소스 활동
- 2026년 7월 1일 14:57
- 감지된 SKILL.md 언어
- 영어
- 스타
- 18,783
- 포크
- 1,352
설치 방법
기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.
소스 파일 검토
설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.
SKILL.md 표시 중
SKILL.md
소스 지침 · 읽기 전용 미리보기- 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`
GitHub에서 보기