Nightbot Song Request (SR) Dock 0.1.0

This native plugin integrates the Nightbot Song Request (AutoDJ) system directly into OBS Studio. It eliminates the need to keep a browser tab open to manage your music queue, offering a seamless dockable widget to control playback and view requests.

Key Features​

• Native Dock: View the current song and the upcoming queue (Title, Requester, Duration).
• Playback Controls: Play, Pause, Skip, and Volume control directly from the dock.
• Queue Management: Promote (move to top) or Delete songs from the queue.
• Add Requests: Request songs via YouTube URL or search terms using a built-in dialog.
• Now Playing Info: Automatically updates a selected Text Source (GDI+) or writes to a Text File with the current song information. Supports custom formatting (e.g., {artist} - {music} requested by {user}).
• Global Hotkeys: Bind OBS hotkeys to Resume, Pause, and Skip songs, allowing control even when OBS is not focused.
• Toggle Requests: Quickly enable or disable Song Requests with a single click.

Requirements​

• OBS Studio 30.0 or higher (64-bit).
• Windows 10/11 (x64), macOS 13+, or Linux (Ubuntu 24.04+).
• A Nightbot account.
• Important: The Nightbot queue page must be open in your browser or in a Browser Source in OBS.

Installation​

1. Download the installer (Windows) or the package for your OS.
2. Install/Extract to your OBS Studio plugins folder.
3. Open OBS Studio.
4. Go to Docks -> Nightbot SR.
5. Go to Tools -> Nightbot SR Settings -> Connect to authenticate with your Nightbot account.
6. Start using!

Technical Overview​

• Secure Authentication (OAuth2): To maintain the highest security standards, the plugin utilizes a custom intermediary service for the OAuth2 token exchange. This architecture ensures that the application's client_secret is never exposed on the client-side. The intermediary service performs the code-to-token exchange and passes the token back to the plugin without storing any credentials.
• API & Permissions: This plugin interacts exclusively with the public Nightbot API. It requires permission to manage your song queue. You retain full control and can revoke the plugin's access at any time via the Nightbot Integrations Dashboard.
• Runtime Requirement (Important): The Nightbot AutoDJ web page must remain open in your browser or OBS Browser Source.The Nightbot API requires the web player to be active to process the queue and play audio. This plugin acts as a remote control for that player. If the browser tab is closed, playback will stop, and the queue will not advance.
  • Note: Ensure you have an Audio Source in OBS capturing your browser or desktop audio so the stream can hear the music.
• Data Privacy: The plugin operates locally within OBS Studio. No user data, watch history, or account details are sent to or stored on the intermediary authentication server. Access and Refresh tokens are stored locally on your machine (encrypted where supported by the OS) to maintain your session.

Disclaimer:
This plugin is an unofficial, community-developed resource. We are not affiliated, associated, authorized, endorsed by, or in any way officially connected with Nightbot or any of its subsidiaries or its affiliates. This project simply utilizes the public API provided by Nightbot to offer integration within OBS Studio.

Click to expand...

---