For the complete documentation index, see llms.txt. This page is also available as Markdown.

Contributing

Nuclear does not accept code contributions. Issues and pull requests will be closed.

But if you want to extend Nuclear, you can write a plugin instead. The plugin system gives you full control over streaming, metadata, playlists, dashboard content, and more, without needing to touch the core codebase.

Writing plugins

See the Getting started guide to learn how to build and publish a plugin using the @nuclearplayer/plugin-sdk.

Translations

You can contribute translations for supported languages through Crowdin. Don't submit translation PRs directly.

Discussions

Discuss Nuclear using the GitHub Discussions forum.

Last updated