Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/perilstar/fcfs-bot

A Discord bot that enhances First Come, First Serve in voice channel waiting rooms.
https://github.com/perilstar/fcfs-bot

discord discord-akairo discord-bot discord-js discord-js-bot

Last synced: 6 days ago
JSON representation

A Discord bot that enhances First Come, First Serve in voice channel waiting rooms.

Awesome Lists containing this project

README

        

First Come, First Serve
===

A Discord bot that enhances First Come, First Serve in voice channel waiting rooms.

## Configuring Bot Admin, Mod, and Helper roles:
*All of these commands require the Administrator permission to use.*

`addadminrole ""`
Adds a role as Bot Admin. Admin commands are described below.
*Aliases:* `aar`

`removeadminrole ""`
Removes a role as Bot Admin.
*Aliases:* `rar`

`listadminroles`
Lists all Bot Admin roles for the server.
*Aliases:* `lar`

`addmodrole ""`
Adds a role as Bot Mod. Mod commands are described below.
*Aliases:* `amr`

`removemodrole ""`
Removes a role as Bot Mod.
*Aliases:* `rmr`

`listmodroles`
Lists all Bot Mod roles for the server.
*Aliases:* `lmr`

`addhelperrole ""`
Adds a role as Bot Helper. Helper commands are described below.
*Aliases:* `ahr`

`removehelperrole ""`
Removes a role as Bot Helper.
*Aliases:* `rhr`

`listhelperroles`
Lists all Bot Helper roles for the server.
*Aliases:* `lhr`

## Bot Admin commands:
*All of these commands require Bot Admin permissions to use. Bot Admins may also use commands from Bot Mod and Bot Helper.*

`setprefix `
Sets the bot prefix for the server.
*Aliases:* `prefix`

`createwaitingroom "" `
Creates a waiting room that displays the first displayCount members to join monitorChannel in the channel the command was typed in, with a grace period of rejoinWindow for accidental disconnects, and waiting afkCheckDuration to remove the user from queue when they're afk-checked.
*Aliases:* `cwr`
*Example:* `fcfs!cwr "Waiting Room 1" 10 1m 5m`

`deletewaitingroom ""`
Removes the waiting room associated with `monitorChannel`.
*Aliases:* `dwr`

`listwaitingrooms`
Lists all waiting rooms in the server.
*Aliases:* `lwr`

`setdisplaysize "" `
Sets the display max length for the waiting room associated with `monitorChannel`.
*Aliases:* `sds`

`setrejoinwindow "" `
Sets the rejoin window for the waiting room associated with `monitorChannel`.
*Aliases:* `srw`

`setafkcheckduration "" `
Sets the AFK check duration for the waiting room associated with `monitorChannel`.
*Aliases:* `sacd`

`setautomatic "" [outputChannel]`
Creates an automatic afk-check every `interval`, putting the output in `outputchannel` if specified, or the channel
the command was typed in otherwise.
*Aliases:* `sa`
*Example:* `fcfs!sa "Waiting Room 1" 45m` OR `fcfs!sa "Waiting Room 1" off`

## Bot Mod commands:
*All of these commands require Bot Mod permissions to use. Bot Mods may also use commands from Bot Helper.*

`setposition `
Sets a user's position in the queue that they're in.
*Aliases:* `sp`

`afkchecktop ""`,
AFK-checks all members displayed in the waiting room display.

## Bot Helper commands:
*All of these commands require Bot Helper permissions to use.*

`afkcheck `
Sends the user a DM with a reaction on it, which they must click within the configured `afkCheckDuration` to stay in the queue.
*Aliases:* `afk`

## Base Commands:
*Anyone can use these commands.*

`info ""`
Displays info about the waiting room associated with `monitorChannel`.
*Example:* `fcfs!info "Waiting Room 1"`

`position "[member]"`
Displays the command sender's position in the queue, or the referenced `member`.
*Aliases:* `p`
*Example:* `fcfs!p "peril"` OR `fcfs!p`

`queuelength ""`
Displays the queue length of the waiting room associated with `monitorChannel`.
*Aliases:* `ql`
*Example:* `fcfs!ql "Waiting Room 1"`