# Nuclear ## Nuclear - [Nuclear Documentation](https://docs.nuclearplayer.com/nuclear/readme.md): Nuclear - Music streaming app for your desktop - [Getting started](https://docs.nuclearplayer.com/nuclear/user-manual/getting-started.md): Install Nuclear and play your first song - [Installation](https://docs.nuclearplayer.com/nuclear/user-manual/installation.md): Download and install Nuclear on your platform - [Remote control](https://docs.nuclearplayer.com/nuclear/user-manual/remote-control.md): Control Nuclear from your phone or any other device on your network. - [How Nuclear works](https://docs.nuclearplayer.com/nuclear/core-concepts/how-nuclear-works.md): The big picture of how Nuclear is structured and why it works differently from other music players - [Plugins and providers](https://docs.nuclearplayer.com/nuclear/core-concepts/plugins-and-providers.md): What plugins are, what types of providers they offer, and how to manage them - [The queue](https://docs.nuclearplayer.com/nuclear/core-concepts/the-queue.md): How the queue works, playback modes, and managing your listening session - [Favorites](https://docs.nuclearplayer.com/nuclear/core-concepts/favorites.md): Save tracks, albums, and artists to your favorites - [Playlists](https://docs.nuclearplayer.com/nuclear/core-concepts/playlists.md): Create, import, export, and manage playlists - [Themes](https://docs.nuclearplayer.com/nuclear/theming/themes.md): Overview of theme types in Nuclear. - [Basic themes](https://docs.nuclearplayer.com/nuclear/theming/themes-basic.md): Use built-in presets. - [Advanced themes](https://docs.nuclearplayer.com/nuclear/theming/themes-advanced.md): Create and use custom JSON-based themes. - [Theme store](https://docs.nuclearplayer.com/nuclear/theming/theme-store.md): Browse, install, and manage community themes from the built-in theme store. - [Keyboard shortcuts](https://docs.nuclearplayer.com/nuclear/misc/keyboard-shortcuts.md): Default keyboard shortcuts and how to customize them - [Platform-specific notes](https://docs.nuclearplayer.com/nuclear/misc/platform-specific.md): Platform specific considerations - [Music discovery](https://docs.nuclearplayer.com/nuclear/misc/discovery.md): Automatic track recommendations - [Getting started with plugins](https://docs.nuclearplayer.com/nuclear/plugins/getting-started.md): Create and load your first Nuclear plugin and verify the SDK works end-to-end. - [Plugin system](https://docs.nuclearplayer.com/nuclear/plugins/plugin-system.md): How do plugins work in Nuclear? - [Plugin store](https://docs.nuclearplayer.com/nuclear/plugins/plugin-store.md): Browse, install, and manage plugins from the built-in plugin store. - [Publishing](https://docs.nuclearplayer.com/nuclear/plugins/publishing.md): Package, release, and submit your plugin to the Nuclear plugin store. - [Settings](https://docs.nuclearplayer.com/nuclear/plugins/settings.md): How plugins define, read, and update persisted settings in Nuclear. - [Queue](https://docs.nuclearplayer.com/nuclear/plugins/queue.md): Control playback order, manipulate the queue, and react to track changes in Nuclear. - [Favorites](https://docs.nuclearplayer.com/nuclear/plugins/favorites.md): Save and manage user's favorite tracks, albums, and artists. - [Playlists](https://docs.nuclearplayer.com/nuclear/plugins/playlists.md): Create, modify, and import playlists, or register a provider that fetches playlists from URLs. - [Playback](https://docs.nuclearplayer.com/nuclear/plugins/playback.md): Control audio transport, read playback state, and react to playback changes. - [Events](https://docs.nuclearplayer.com/nuclear/plugins/events.md): Subscribe to player lifecycle events and react to playback milestones. - [Shell](https://docs.nuclearplayer.com/nuclear/plugins/shell.md): Open URLs in the user's system browser from a plugin. - [Streaming](https://docs.nuclearplayer.com/nuclear/plugins/streaming.md): Resolve audio streams for tracks in Nuclear's queue. - [Metadata](https://docs.nuclearplayer.com/nuclear/plugins/metadata.md): Build metadata providers that power search, artist pages, and album views in Nuclear. - [Dashboard](https://docs.nuclearplayer.com/nuclear/plugins/dashboard.md): Supply dashboard content: top tracks, trending artists, curated playlists, and more. - [Discovery](https://docs.nuclearplayer.com/nuclear/plugins/discovery.md): Recommend tracks based on the user's listening context - [Logger](https://docs.nuclearplayer.com/nuclear/plugins/logger.md): Structured logging for plugins, routed to Nuclear's log file and developer console. - [HTTP](https://docs.nuclearplayer.com/nuclear/plugins/http.md): Make CORS-free HTTP requests from plugins using a standard fetch API. - [yt-dlp](https://docs.nuclearplayer.com/nuclear/plugins/ytdlp.md): Search YouTube and resolve audio stream URLs via yt-dlp. - [Providers](https://docs.nuclearplayer.com/nuclear/plugins/providers.md): Register providers that supply metadata, audio streams, dashboard content, and more to Nuclear. - [HTTP API](https://docs.nuclearplayer.com/nuclear/integrations/http-api.md): Control Nuclear from scripts and other tools via the HTTP API. - [MCP Server](https://docs.nuclearplayer.com/nuclear/integrations/mcp-server.md): Let AI agents control Nuclear via the Model Context Protocol. - [MPD Server](https://docs.nuclearplayer.com/nuclear/integrations/mpd-server.md): Control Nuclear from any MPD client. - [Contributing](https://docs.nuclearplayer.com/nuclear/development/contributing.md) - [Host pattern](https://docs.nuclearplayer.com/nuclear/development/host-pattern.md): How the plugin SDK connects to the player through hosts. - [Logging](https://docs.nuclearplayer.com/nuclear/development/logging.md) - [MCP Architecture](https://docs.nuclearplayer.com/nuclear/development/mcp-architecture.md): How the MCP server works internally and how to extend it. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.nuclearplayer.com/nuclear/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.