# Listune

> Listune is a customizable Discord music bot with a web dashboard and player, supporting multiple music sources and server-side playback management.

## Overview

Listune is a Discord music bot built around multi-source music playback, an interactive web dashboard, and configurable server features. It enables Discord communities to stream audio in voice channels, control music playback through a modern web player, and launch Discord voice channel activities. The bot supports flexible deployment configurations, including multi-bot architectures where multiple bot instances run under a single backend service while keeping guild queues, settings, and player states isolated.

The project website describes Listune with:
- "Discover Listune Music for Discord Servers"
- "Your music, wherever you play. Listen with friends in voice channels, launch the Discord Activity, or enjoy music from the web player."

## Website

The main website is available at https://listune.app/. Key public pages include:

- Home: https://listune.app/ — Overview of features, supported sources, bot invitations, and web player preview.
- Commands Directory: https://listune.app/commands — Searchable directory of available bot commands and categories.
- How to Support: https://listune.app/how-to-support — Information on supporting development through community contributions and sponsorships.
- Premium: https://listune.app/premium — Overview of Premium tiers, server benefits, and subscription platforms.
- Global Stats: https://listune.app/global-stats — Public platform-wide listening statistics, top tracks, top artists, and top servers.
- Partners: https://listune.app/partners — Partner servers and community showcase.
- System Status: https://listune.app/system-status — Live operational status of bot clusters, Lavalink nodes, and services.
- Team: https://listune.app/team — Maintainers, developers, and staff behind Listune.
- Privacy Policy: https://listune.app/privacy-policy — Data handling disclosures and privacy commitments.
- Terms of Service: https://listune.app/terms-of-service — Terms of service and usage guidelines.
- Refund Policy: https://listune.app/refund-policy — Policies governing subscriptions and refunds.
- Bot Invite: https://listune.app/invite — Direct bot authorization link to add Listune to a Discord server.
- Support Server: https://listune.app/support — Official Discord support server invitation.

## Documentation

Official documentation is hosted at https://docs.listune.app/:

- Documentation Home: https://docs.listune.app/ — Central index for guides, tutorials, and setup instructions.
- Quickstart: https://docs.listune.app/quickstart — Initial onboarding guide for inviting the bot and basic server configuration.
- First Song: https://docs.listune.app/quickstart/first-song — Step-by-step instructions on joining a voice channel and initiating audio playback.
- Song Request Channel: https://docs.listune.app/quickstart/song-request-channel — Setup guide for dedicated text channels where members queue songs simply by sending song names or URLs without commands.
- Commands Reference: https://docs.listune.app/commands — Full documentation of slash commands, prefix commands, options, and permission levels.
- Dashboard Guide: https://docs.listune.app/dashboard — Documentation for navigating and managing the web dashboard and browser player.
- Support Resources: https://docs.listune.app/support — Troubleshooting guides, frequently asked questions, and support contact channels.

## Music and Playback

Listune supports streaming audio from a broad range of music platforms and media providers:

- Supported Platforms: Spotify, Apple Music, Deezer, Tidal, SoundCloud, YouTube, YouTube Music, Bandcamp, Twitch, Vimeo, Mixcloud, Reddit, and TikTok.
- Playback Modes: Standard queue playback, autoplay mode for continuous recommended tracks, and 24/7 voice channel persistence mode.
- Playback Controls: Play, pause, skip, previous, seek, track repeat/loop, queue repeat, shuffle, and volume adjustment.
- Audio Filters: Built-in audio filters including bass boost, nightcore, 8D audio, and equalizer settings.

## Dashboard

The web dashboard is hosted at https://listune.app/ and provides browser-based control of bot playback and server settings:

- Server Management: View authorized servers, configure default prefixes, toggle 24/7 mode, set default volume, and assign DJ roles.
- Real-time Player: Monitor current track playback, view active voice channel members, and control playback directly from the browser.
- Queue Management: View upcoming tracks, reorder items, remove individual tracks, or clear the entire queue.
- Song Request Configuration: Bind and format dedicated song request channels.
- Guild Statistics: View top songs, listening hours, and popular artists within each server.

## Discord

Listune integrates into Discord servers through several interfaces:

- Slash Commands: Full Discord application command support (`/play`, `/skip`, `/queue`, `/nowplaying`, `/fix`, `/invite`, etc.).
- Prefix Commands: Traditional message-based commands with customizable server-specific prefixes.
- Song Request Channel: Dedicated channel with interactive UI buttons and automated track queueing on text messages.
- Role-Based Permissions: DJ role support to restrict playback management and admin commands.
- Multi-Bot Architecture: Support for multiple concurrent bot instances (e.g. Listune, Listune 1 through 4) connected to the same infrastructure.

## Discord Activity

Listune supports Discord Voice Channel Activities using the Discord Embedded App SDK (`@discord/embedded-app-sdk`):

- Allows server members to launch a shared music experience directly inside a Discord voice channel window.
- Enables synchronized listening with friends within the Discord desktop and mobile clients.

## Player

The web player is integrated into the dashboard interface:

- Synchronized real-time state with Discord voice channel sessions via WebSockets.
- Interactive track timeline with seeking, elapsed time, and remaining duration.
- Volume control, mute toggle, loop toggles, and shuffle controls.
- Visual player card overlays and liked songs playlist management.

## Lyrics

- Real-time synchronized lyrics support that highlights lines in sync with the audio track.
- Accessible directly inside the web player interface and via Discord commands.
- Synced lyrics ON/OFF toggle for flexible viewing preferences.

## Radio

- Curated radio station playback with over 1000+ radio stations from genres and countries worldwide.
- Allows continuous radio streaming directly into Discord voice channels without requiring a pre-built track queue.

## Lavalink

- Audio streaming is powered by high-performance Lavalink nodes using the Mewslink audio engine.
- Handles audio track resolving, decoding, buffering, voice gateway connections, and voice packet dispatching.
- Provides resilient player recovery and voice server reconnect handling.

## Premium

Listune offers Premium features to support server upgrades and enhanced perks:

- Premium Overview: https://listune.app/premium
- Subscription Platforms: Patreon (https://www.patreon.com/c/listune) and Ko-fi (https://ko-fi.com/listune).
- Server Activation: Commands `/premium claim` and `/premium unclaim` allow subscribers to assign and transfer premium benefits across servers.

## Support

Community and technical support are accessible through:

- Discord Support Server: https://listune.app/support (redirects to https://discord.gg/Bxrj3CYvPK).
- Documentation Support: https://docs.listune.app/support.
- Email: support@listune.app.

## Commands

- Website Command Explorer: https://listune.app/commands
- Documentation Command Guide: https://docs.listune.app/commands

## Project

- GitHub Organization: https://github.com/listune
- Owner: L RMN (https://lrmn.wtf/)

## Legal

- Privacy Policy: https://listune.app/privacy-policy
- Terms of Service: https://listune.app/terms-of-service
- Refund Policy: https://listune.app/refund-policy

## System Status

- Real-Time Status Page: https://listune.app/system-status

## Partners

- Community Partners: https://listune.app/partners

## Global Stats

- Global Statistics Page: https://listune.app/global-stats

## Team

- Meet the Team: https://listune.app/team