Events

Describes how to use Kariari's event commands for various events, such as karaoke

Prerequisites

To use queues, you must have an understanding of the event admin role. See Changing Role for more help.

What are Event Admin Roles?

The queue admin role is the role you give to people who you trust to run your events. Kariari checks the role using the role name. event admin roles do NOT identify who can join the event, only the people who start, stop, or manage the event.

Event Types

There are currently two types of events: karaoke and general. They are described below.

Karaoke
General
Karaoke

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

General

General events are for events on your server that require a basic queue. Utilizing the same code as the karaoke queue, but with the removal of 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!

Event Scopes

Events work on a text channel basis. Each event requires a text channel not being used by another event. Karaoke events require a voice channel not being used by another event in addition to the text channel.

Groups

People can group up into groups of up to 4 within an event. This allows for squads, or duets/trios in karaoke

Starting and Ending Events

Events are started and ended to manage when people can add themselves to the event. These commands can only be used by people with the event admin role.

Starting Events

To start an event, simply use ;start in the text channel you want to start an event in. You can set a custom event message by typing your message after the command (e.g. ;start Hello guys!). You can mention a channel to start an event in another text channel (e.g. ;start #events-zone).

Ending Events

To end an event, simply use ;end in the text channel which is being used by an active event. You can mention a channel to end an event in another text channel (e.g. ;end #events-zone).

The event admin role can be changed at anytime (see changing roles)

Joining and Leaving the Event

Joining Events

To join an event, use ;join in a text channel being used by an event. To join a friend in a group, you can mention them while using the join command (e.g. ;join @danclay).

Leaving Events

To leave an event, use ;leave. If you are in a group, this will only take you out of the event, not your friends.

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

Viewing the Event Positions

To view the queue, use ;positions.

Command

Function

Event Admin Role Needed?

;positions (;pos is an alias)

Shows you the event's positions

No

Cycling The Event

The person who is currently up can cycle the event using ;cycle. In karaoke events, this will also unmute all members who were muted. People with the event admin role can always use this command to skip the person who is currently up.

Command

Function

Event Admin Role Needed?

;cycle

Cycles the event one step forward

No, but Event Admins can use this command at anytime.

Auto Cycle

Kariari can automatically cycle your event with a simple command. This is useful if you want to set a time limit on how long a member can be in event position 0.

Command

Function

Event Admin Role Needed?

;autocycle <time between cycles (e.g. 1m 30s) or disable>

Automatically cycle the event

Yes

Examples

  • ;autocycle 1m 30s

  • ;autocycle 2m

  • ;autocycle 50s

  • ;autocycle disable

Managing the Event

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

Command

Function

Example

Event Admin Role Needed?

;push <@user><queue position>

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

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

Yes

;remove <@user>

Removes the mentioned member from the queue

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

Yes

;cycle

Cycles the queue

Yes (unless you are up)

;lock

Lock and unlocks the queue

Yes

;autocycle <time or event position>

Automatically cycles the event on the interval specified unless the event is cycled manually. This is useful to set time limits or cycle if the event becomes inactive.

;autocycle 1m 30s

Yes

Vote Kick

Anyone in an event may start a vote to kick other members from the event. The members will only be kicked if a certain threshold of votes is met. This command is meant to help the event to self moderate.

Starting a Vote Kick

You can either start a vote kick for kicking a list of members or a certain event position.

Kick specific members
Kick everyone from an event position
Kick specific members

Use ;votekick followed by mentions of all the members you wish to start a vote to kick.

Examples

  • ;votekick @coolperson @notacoolperson @justaperson

  • ;votekick @cool

Kick everyone from an event position

Use ;votekick followed by the number of the position you wish to kick.

Examples

  • ;votekick 1

  • ;votekick 0

Disabling Vote Kick

If members of your server are abusing the vote kick feature, you can disable it using ;config server votekick

Karaoke Events

Karaoke queues have special features and commands that cannot be used during event queues.

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

Queue Admin Role Needed?

;ready

Mutes users in the channel who are not up to sing

No

;cycle

Unmutes users in the channel and cycles the queue

No, but Queue Admins can use this command at anytime.

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
Join Voice Channel

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

Change Voice Channel

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

Disconnect from Voice

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 muting 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)