Getting started

Add Orpheus to your server

Use the Add to Discord button on this site. You need Manage Server in the server you're adding it to, which is Discord's rule for any bot. If you haven't added a bot before, how to add a music bot to Discord walks through Discord's screens.

The invite asks for these permissions and nothing else:

• View Channels, Send Messages and Embed Links, so it can post the player card and reply to commands.
• Read Message History, so it can check whether conversation has pushed the player card up the channel before it edits or reposts it.
• Connect, Speak and Use Voice Activity, so it can join your voice channel and play.

Orpheus doesn't ask for Manage Messages. The only messages it deletes are its own, and Discord doesn't need that permission for those.

The invite adds the slash commands too.

Play your first song

1. Join a voice channel.
2. Type /play and give it a song name or a link, for example /play query: redbone childish gambino.
3. Orpheus joins your voice channel and starts playing.

If you're not in a voice channel, it tells you to join one first.

The player card is posted in the text channel where you ran the command. If you add more songs while one is playing, you get a small message saying where in the queue yours landed. Orpheus deletes that message when your song starts, because the card takes over from there.

The player card

The card shows:

• Which voice channel it's playing in, and whether it's paused.
• The track title, linked to the source when there is a link, and the artist or uploader.
• Where the track came from: "Added by @name" for a person's request, "From (station) radio, started by @name" for a radio station's pick, or "Autoplay" for autoplay's pick.
• Queue size, volume, loop mode and the service the track is from, such as YouTube or Spotify.
• A progress bar with the elapsed time, the total length and when the track ends. Live streams show "Live" instead of a bar.

The card redraws about every 15 seconds. While it's still visible in the channel, Orpheus edits it in place, so a quiet channel keeps one card for the whole session. If chat pushes it out of view, Orpheus reposts it at the bottom. It checks for this every few minutes.

Buttons

Next to the numbers there's a Like button. Inside the card:

• Previous goes back to the track that played before this one.
• Pause and Resume.
• Skip.
• Stop stops playback, clears the queue, ends any radio station and leaves the channel.
• Autoplay turns autoplay on or off for the server. It's blue when it's on.

Under the card:

• Queue shows you the queue. Only you see it.
• Shuffle.
• Loop cycles through off, this track and the whole queue. The label shows the current mode.
• Not for me blocks this track on this server and skips it. Read Likes and blocks before you use it, because the block stays until someone runs /unblock.
• Dashboard opens this server's page on the website.

You have to be in the same voice channel as Orpheus to use any of the buttons. If the server has a DJ role, some buttons are limited to it. Controls and permissions has the details.

Replies only you can see

Orpheus keeps plenty of its replies private so they don't fill the channel: /queue, /nowplaying, /lyrics, /search, /help, /liked list, /playlist list, and any settings command you run without options, which tells you the current setting.

Short confirmations like "Skipped" or "Paused" are posted in the channel and delete themselves after about 12 seconds. Messages about something going wrong stay for about 45 seconds so you have time to read them.

Lost the card?

/nowplaying gives you your own copy of the player card, and its buttons work.

When something is down

If the audio server is having problems, commands that need it reply straight away with a maintenance notice. Commands that only read or change saved data keep working, such as /playlist, /unblock, /dj, /channel, /skipsegments and /help.

The status page shows whether Orpheus is up right now.