Queues

Describes how to use Kariari's queue commands for karaoke or other events

Prerequisites

To use queues, you must have an understanding of master roles. An easy way to get this setup is using the setup command (see Getting Started).

What are Master Roles?

The master role is the role you give to people who you trust to run your queue. Kariari checks the role using the role name, so be sure to only have one role with the name! Master roles do NOT identify who can join the queue, only the people who start,stop, or manage them.

Session Types

There are currently two types of queue sessions, karaoke and event. They are described below.

Karaoke
Event

Karaoke queues manage karaoke sessions, and in doing so, use auto mute features in the channel of choice.

Event queues are for general events on your server that require a queue. Utilizing the same code as the karaoke queue, but with the removal of irrelevant text and the voice channel aspect. Some uses are gaming events that have a specific list of players (may include a bracket system in the future), but you can use it for almost anything!

Starting and Ending Sessions

Sessions are started and ended to manage when people can add themselves to the queue. This is used when events start or end. These commands can only be used by people with the master role.

Command

Function

Master Role

;start karaoke

Starts a karaoke queue session

Required

;start event

Starts a general event session

Required

;end

Ends any type of session running on the server

Required

The master role can be changed at anytime (see custom master role)

Joining and Leaving the Queue

Users are given control over themselves to join or leave the queue using simple commands.

Command

Function

Master Role

;join

Adds you to the queue

Not Required

;leave

Removes you from the queue

Not Required

The prefix used can be changed at anytime (see custom prefix)

Viewing the Queue

To view the queue, use ;queue.

Command

Function

Master Role

;queue

Shows you the queue

Not Required

Cycling The Queue

The person who is currently up can cycle the queue using ;cycle. In karaoke queues, this will also unmute all users who were muted. People with the master role can always use this command to skip the person who is currently up.

Command

Function

Master Role

;cycle

Cycles the queue one step forward

Not Required (can use anytime)

Managing the Queue

People with the master role can manage the queues effortlessly using simple commands.

Command

Function

Example

Master Role

;push @user [queue spot]

Pushes the mentioned user to the queue spot placed in the placeholder.

If I wanted to move @danclay#9999 to queue spot 2, I would use ;push @danclay#9999 2

Required

;remove @user

Removes the mentioned user from the queue

If I wanted to remove @danclay#9999 from the queue, I would use ;remove @danclay#9999

Required

;cycle

Cycles the queue

Required (unless you are up in the queue)

Karaoke Queues

Karaoke queues have special features and commands that cannot be used during event queues. Karaoke queues are started using ;start karaoke.

Auto Mute

Auto mute will automatically mute users who are not singing in the channel designated upon the starting of the session. To mute the users, the person who is up can use ;ready. It may take a little bit of time for Kariari to mute everyone in the channel if the channel has a large number of people. Users will be unmuted upon the ;cycle command being used. Kariari will also manage muting of people who join or leave the channel while someone is singing.

Command

Function

Master Role

;ready

Mutes users in the channel who are not up to sing

Not Required

;cycle

Unmutes users in the channel and cycles the queue

Not Required

Kariari also manages the muting of people who join or leave the channel. Here is what Kariari will do:

Join Voice Channel
Change Voice Channel
Disconnect from Voice

Kariari will mute the user who joins the voice channel while someone is singing.

Kariari will unmute people who change voice channels if she has permission.

Kariari cannot unmute people at the moment to disconnect directly from the channel. To get around this, Kariari will keep note of who is put into this situation and will unmute them once they join ANY voice channel on your guild where Kariari has permission to unmute.

Kariari will also respect server mutes made by staff, and will not remove them. Kariari will keep tabs of who was server muted before she mutes people. Upon unmuting, these people will not be unmuted, and will stay muted until staff unmutes them.

Auto mute requires the Mute Members permission (see permissions)