docs.neatqueue.com Open in urlscan Pro
2606:50c0:8000::153  Public Scan

Submitted URL: http://docs.neatqueue.com/
Effective URL: https://docs.neatqueue.com/
Submission: On June 16 via api from US — Scanned from DE

Form analysis 0 forms found in the DOM

Text Content

 * Introduction
 * Quick Start
    * Starting a Queue

 * Premium Commands
    * Language
    * Leaderboard Config
    * Messages + Styling

 * User Commands
    * Cancel
    * Compare
    * Donate
    * Force Start
    * Help
    * Leaderboard
    * Need
    * Parties/Teams/Clans/Groups
    * Ping
    * Predictions
    * Register
    * Require IGN
    * Roles
    * Stats
    * Substitute

 * Admin Commands
    * AnonymousQueue / Hiding Names
    * Anti Cheat
    * Auto Ping
    * Balance By
    * Best Of
    * Captain Selection
    * Channel Config
    * Clear Queue
    * Command Button
    * Config Loading/Saving
    * Cross Chat
    * Dodge
    * End Queue
    * Force Start
    * Game Integrations
    * Gamemodes
    * Heroes
    * Info
    * Language
    * Leaderboard Config
    * Link Queue
    * Lobby Channel
    * Lobby Details
    * Lock
    * Logs
    * MMR Change
    * MVPs
    * Manage Players
    * Manage Stats
    * Maps
    * Match Start
    * Matchmaking
    * Messages + Styling
    * Miscellaneous/Utility
    * Mod Channel
    * Modify Player Data
    * Number Of Lobbies
    * Number Of Teams
    * Party Queue
    * Predictions
    * Queue Entry Methods
    * Queue Name
    * Queue Type
    * Ranks/Automatically Assign Discord Roles
    * Reaction Roles
    * Ready Up
    * Rematch
    * Requeue
    * Require IGN
    * Required Votes
    * Requirements
    * Results Channel
    * Roles
    * Schedule
    * Select Winner
    * Server Stats
    * Setup
    * Show MMR in Name
    * Simulate
    * Spectator Role
    * Staff
    * Start From Voice Channel
    * Start Queue
    * Starting MMR
    * Stats Config
    * Team Creation
    * Team Names
    * Team Size
    * Temporary Setup Channels
    * Test
    * Ties
    * Timers
    * Timezone
    * Tournaments
    * Voice Channel Mode
    * Voting Menu
    * Webhooks

 * API


NEATQUEUE WEBSITE


INTRODUCTION

All NeatQueue commands are slash commands, which means they are invoked using a
/
Any Admin command requires the user to have Manage Channels permissions, or have
one of the configured NeatQueue staff roles.
In this documentation, anytime an argument is surrounded by [square brackets],
it is a required argument. If it is surrounded by (parenthesis), it is optional.
The term MMR stands for Match Making Rating, which corresponds to the hidden
rating system used by most competitive games.
All commands are queue specific unless otherwise stated.

All stats are tied to the queue name. This means if you create multiple queues
with the same queue name, they will share stats.

Want to Donate? Simply use /donate or visit
https://donatebot.io/checkout/505102060119916545

--------------------------------------------------------------------------------


QUICK START


STARTING A QUEUE

Starting a queue is super simple with NeatQueue, just run one of the following
commands:

/SETUP FOR AN INTERACTIVE WALK THROUGH

/STARTQUEUE FOR A SIMPLE DEFAULT CONFIGURATION

/LOAD [CONFIG_ID] FOR A SPECIFIC QUEUE CONFIGURATION

--------------------------------------------------------------------------------


PREMIUM COMMANDS


LANGUAGE


/LANGUAGE OVERRIDES SET

DESCRIPTION

Toggle on/off using the custom overrides.

USAGE: /LANGUAGE OVERRIDES SET [ORIGINAL_PHRASE] (OVERRIDEN_PHRASE)

ARGUMENTS:

original_phrase: (Required) Existing phrase to override.
overriden_phrase: (Optional) Replacement phrase, omit to go back to default.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/LANGUAGE OVERRIDES TOGGLE

DESCRIPTION

Toggle on/off using the custom overrides.

USAGE: /LANGUAGE OVERRIDES TOGGLE [TOGGLE]

ARGUMENTS:

toggle: (Required) Toggle custom overrides.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/LANGUAGE OVERRIDES UPLOAD

DESCRIPTION

Upload a custom overrides file.

USAGE: /LANGUAGE OVERRIDES UPLOAD [CUSTOM_OVERRIDES]

ARGUMENTS:

custom_overrides: (Required) Custom translation overrides, omit to remove.

> The overrides file is JSON format, and can be found here:
> https://www.neatqueue.com/default_overrides.json The keys (left side) signify
> the already existing English phrase the bot uses. The value (right side) is
> the value that replaces the key.
> 
> Sometimes an entry will include special charcters similar to {}. The total
> number of these signifiers in each entry must remain constant. If an override
> does not match the count of signifiers, it will not be used.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


LEADERBOARD CONFIG

> Leaderboard titles are hyperlinks to the website version of the leaderboard.


/LEADERBOARDCONFIG URL

DESCRIPTION

Create a custom website url for leaderboards.

USAGE: /LEADERBOARDCONFIG URL [URL]

ARGUMENTS:

url: (Required) Custom url for this channel's leaderboard.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


MESSAGES + STYLING


/MESSAGE COLOR

DESCRIPTION

Sets the color for all embeds in messages.

USAGE: /MESSAGE COLOR [COLOR]

ARGUMENTS:

color: (Required) Either a color by name, or by HEX value (Ex: 00FF55).

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MESSAGE QUEUEMESSAGE FOOTER

DESCRIPTION

(Default: None) Set a footer for the queue message.

USAGE: /MESSAGE QUEUEMESSAGE FOOTER (TEXT) (ICON_URL)

ARGUMENTS:

text: (Optional) Footer contents, or omit to remove.
icon_url: (Optional) -.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MESSAGE QUEUEMESSAGE IMAGE

DESCRIPTION

(Default: None) Set an image for the queue message.

USAGE: /MESSAGE QUEUEMESSAGE IMAGE (IMAGE_URL)

ARGUMENTS:

image_url: (Optional) Direct URL of image, or omit to remove.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MESSAGE QUEUEMESSAGE THUMBNAIL

DESCRIPTION

(Default: None) Set a thumbnail for the queue message.

USAGE: /MESSAGE QUEUEMESSAGE THUMBNAIL (IMAGE_URL)

ARGUMENTS:

image_url: (Optional) Direct URL of image, or omit to remove.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


USER COMMANDS


CANCEL


/CANCEL

DESCRIPTION

Start a vote to cancel the current match.

USAGE: /CANCEL

--------------------------------------------------------------------------------


COMPARE


/COMPARE

DESCRIPTION

Compare your stats to the given player.

USAGE: /COMPARE [PLAYER2] (PLAYER1) (HIDDEN)

ARGUMENTS:

player2: (Required) Enter the second user you want to compare to.
player1: (Optional) Enter the first user you want to compare to, or omit for
yourself.
hidden: (Optional) If you want the stats to be hidden.

--------------------------------------------------------------------------------


DONATE


/DONATE

DESCRIPTION

Donate to help NeatQueue development.

USAGE: /DONATE

--------------------------------------------------------------------------------


FORCE START


/FORCESTART

DESCRIPTION

Start a vote to forcestart the game, skips vote if used by staff.

USAGE: /FORCESTART

--------------------------------------------------------------------------------


HELP


/HELP

DESCRIPTION

View locations where to find help for setup.

USAGE: /HELP

--------------------------------------------------------------------------------


LEADERBOARD


/LEADERBOARD

DESCRIPTION

Shows the leaderboard for the current queue's game.

USAGE: /LEADERBOARD (PAGE) (TYPE) (QUEUE_NAME)

ARGUMENTS:

page: (Optional) The desired page number.
type: (Optional) The type of leaderboard to display.
    Options: MMR, Peak MMR, Points, MVPs, Games, Wins, Losses, Winrate, Streak,
Peak Streak
queue_name: (Optional) The queue name to view.

--------------------------------------------------------------------------------


NEED


/NEED

DESCRIPTION

Shows how many players are needed for the queue.

USAGE: /NEED (CHANNEL)

ARGUMENTS:

channel: (Optional) Channel of queue to show need for.

--------------------------------------------------------------------------------


PARTIES/TEAMS/CLANS/GROUPS


/PARTY CANCELINVITES

DESCRIPTION

CAPTAIN ONLY: Cancel all pending invites.

USAGE: /PARTY CANCELINVITES [PARTY_NAME]

ARGUMENTS:

party_name: (Required) The party name.

--------------------------------------------------------------------------------


/PARTY CAPTAIN

DESCRIPTION

CAPTAIN ONLY: Designate a new captain if you are the current one.

USAGE: /PARTY CAPTAIN [PLAYER] [PARTY_NAME]

ARGUMENTS:

player: (Required) The new captain.
party_name: (Required) The team name.

--------------------------------------------------------------------------------


/PARTY CREATE

DESCRIPTION

Create a new party.

USAGE: /PARTY CREATE [PARTY_NAME]

ARGUMENTS:

party_name: (Required) The party name.

--------------------------------------------------------------------------------


/PARTY DISBAND

DESCRIPTION

CAPTAIN ONLY: Disband a party.

USAGE: /PARTY DISBAND [PARTY_NAME]

ARGUMENTS:

party_name: (Required) The party name.

--------------------------------------------------------------------------------


/PARTY INVITE

DESCRIPTION

CAPTAIN ONLY: Invite a new player to the party.

USAGE: /PARTY INVITE [PLAYER] [PARTY_NAME]

ARGUMENTS:

player: (Required) Player to invite.
party_name: (Required) The party name.

--------------------------------------------------------------------------------


/PARTY JOIN

DESCRIPTION

Join a party.

USAGE: /PARTY JOIN [PARTY_NAME]

ARGUMENTS:

party_name: (Required) The party name.

--------------------------------------------------------------------------------


/PARTY KICK

DESCRIPTION

CAPTAIN ONLY: Kick a player from the party.

USAGE: /PARTY KICK [PLAYER] [PARTY_NAME]

ARGUMENTS:

player: (Required) The player to kick.
party_name: (Required) The team name.

--------------------------------------------------------------------------------


/PARTY LEAVE

DESCRIPTION

Leave a party.

USAGE: /PARTY LEAVE [PARTY_NAME]

ARGUMENTS:

party_name: (Required) The party name.

--------------------------------------------------------------------------------


/PARTY LIST

DESCRIPTION

List your parties.

USAGE: /PARTY LIST

--------------------------------------------------------------------------------


/PARTY SELECTROLE

DESCRIPTION

Specify your role in the party.

USAGE: /PARTY SELECTROLE [PARTY_NAME] [ROLE]

ARGUMENTS:

party_name: (Required) The party name.
role: (Required) Your role.

--------------------------------------------------------------------------------


/PARTY VIEW

DESCRIPTION

View the specified party.

USAGE: /PARTY VIEW [PARTY_NAME]

ARGUMENTS:

party_name: (Required) The party name.

--------------------------------------------------------------------------------


PING


/PING

DESCRIPTION

Pings all members in the queue.

USAGE: /PING

--------------------------------------------------------------------------------


PREDICTIONS


/PREDICT

DESCRIPTION

Place a bet on the given team for the specified match number.

USAGE: /PREDICT [GAMENUMBER] [TEAM] [AMOUNT]

ARGUMENTS:

gamenumber: (Required) Game number of bet on.
team: (Required) Team to place the bet on.
amount: (Required) Amount of points you want to bet.

--------------------------------------------------------------------------------


REGISTER


/REGISTER

DESCRIPTION

Initialize your MMR using your account.

USAGE: /REGISTER [ACCOUNT]

ARGUMENTS:

account: (Required) Account details.

--------------------------------------------------------------------------------


REQUIRE IGN


/IGN

DESCRIPTION

Sets your IGN for this queue to help with easy lobby setup.

USAGE: /IGN [IGN]

ARGUMENTS:

ign: (Required) Your IGN for this queue's platform.

--------------------------------------------------------------------------------


ROLES


/ROLE

DESCRIPTION

Set your role.

USAGE: /ROLE (ROLE)

ARGUMENTS:

role: (Optional) Preferred role to use, or omit to remove.

--------------------------------------------------------------------------------


STATS


/STATS

DESCRIPTION

Shows your stats.

USAGE: /STATS (HIDDEN) (USER) (ALL_TIME)

ARGUMENTS:

hidden: (Optional) If you want the stats to be hidden.
user: (Optional) The user you want to check stats of.
all_time: (Optional) If you want to view all time stats, only applies to monthly
queues.

--------------------------------------------------------------------------------


SUBSTITUTE


/SUBSTITUTE

DESCRIPTION

Substitute yourself for the given player.

USAGE: /SUBSTITUTE [PLAYER]

ARGUMENTS:

player: (Required) Enter the player to replace you.

--------------------------------------------------------------------------------


ADMIN COMMANDS


ANONYMOUSQUEUE / HIDING NAMES


/ANONYMOUSQUEUE

DESCRIPTION

Sets whether to hide the names of players in queue.

USAGE: /ANONYMOUSQUEUE [MODE]

ARGUMENTS:

mode: (Required) Hide players names in queue.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


ANTI CHEAT


/ANTICHEAT CHANNEL

DESCRIPTION

Sets the anticheat channel to show flagged users.

USAGE: /ANTICHEAT CHANNEL [CHANNEL]

ARGUMENTS:

channel: (Required) The desired anticheat channel.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/ANTICHEAT ENABLE

DESCRIPTION

Enable/disable the anticheat system.

USAGE: /ANTICHEAT ENABLE [TOGGLE]

ARGUMENTS:

toggle: (Required) Toggle for anticheat.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/ANTICHEAT FLAG INCORRECTVOTING

DESCRIPTION

Set an anticheat trigger for players who vote for the wrong team.

USAGE: /ANTICHEAT FLAG INCORRECTVOTING [TOGGLE]

ARGUMENTS:

toggle: (Required) Flag users who vote wrong.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/ANTICHEAT FLAG NEWACCOUNT

DESCRIPTION

Set an anticheat trigger for new accounts.

USAGE: /ANTICHEAT FLAG NEWACCOUNT [AGE]

ARGUMENTS:

age: (Required) Account age in days.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/ANTICHEAT FLAG REJOINS

DESCRIPTION

Set an anticheat trigger for if a player rejoins a server.

USAGE: /ANTICHEAT FLAG REJOINS [TOGGLE]

ARGUMENTS:

toggle: (Required) Flag users who rejoin the server if they already have stats.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/ANTICHEAT FLAG STREAK

DESCRIPTION

Set an anticheat trigger for a players streak.

USAGE: /ANTICHEAT FLAG STREAK [STREAK]

ARGUMENTS:

streak: (Required) Streak to trigger a flag.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/ANTICHEAT ROLE

DESCRIPTION

Set a role to assign to flagged players.

USAGE: /ANTICHEAT ROLE [ROLE]

ARGUMENTS:

role: (Required) Role to assign.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


AUTO PING


/AUTOPING REMOVE

DESCRIPTION

Remove the set auto ping rule.

USAGE: /AUTOPING REMOVE

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOPING SET

DESCRIPTION

Automatically ping the given role when the queue hits the given size.

USAGE: /AUTOPING SET [ROLE] [SIZE]

ARGUMENTS:

role: (Required) Role to ping.
size: (Required) Ping when the queue hits this size.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


BALANCE BY


/BALANCEBY ROLES

DESCRIPTION

Order of role to skill from lowest to highest rated, used if balance by ROLES,
not MMR.

USAGE: /BALANCEBY ROLES (ROLE1) (ROLE2) (ROLE3) (ROLE4) (ROLE5) (ROLE6) (ROLE7)
(ROLE8) (ROLE9) (ROLE10)

ARGUMENTS:

role1: (Optional) The role to use in balancing.
role2: (Optional) The role to use in balancing.
role3: (Optional) The role to use in balancing.
role4: (Optional) The role to use in balancing.
role5: (Optional) The role to use in balancing.
role6: (Optional) The role to use in balancing.
role7: (Optional) The role to use in balancing.
role8: (Optional) The role to use in balancing.
role9: (Optional) The role to use in balancing.
role10: (Optional) The role to use in balancing.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/BALANCEBY TYPE

DESCRIPTION

(Default: mmr) Sets how teams are balanced.

USAGE: /BALANCEBY TYPE [MODE]

ARGUMENTS:

mode: (Required) How teams are balanced.
    Options: Roles, MMR

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


BEST OF


/BESTOF

DESCRIPTION

Sets whether the queue is a best of 3, 5, 7, etc.

USAGE: /BESTOF [NUMBER] (VOTE) (VOTESELECTION) (ELIGIBLE_VOTERS)

ARGUMENTS:

number: (Required) Best of number.
vote: (Optional) Whether players can vote on the number of matches to play.
voteselection: (Optional) Whether to pick the majority vote, or the lowest voted
number.
    Options: Majority, Lowest
eligible_voters: (Optional) Who on the team can vote. Defaults to All if no
captain selected.
    Options: All, Captains

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


CAPTAIN SELECTION


/CAPTAINS AUTOMUTE

DESCRIPTION

Automatically mute all non-captains during selection to remove bias.

USAGE: /CAPTAINS AUTOMUTE [TOGGLE]

ARGUMENTS:

toggle: (Required) If players are muted.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/CAPTAINS DRAFTTYPE

DESCRIPTION

Sets the type of draft to either Snake or Straight.

USAGE: /CAPTAINS DRAFTTYPE [TYPE]

ARGUMENTS:

type: (Required) The type of draft to use.
    Options: Snake (1-2-2-2), Straight (1-1-1-1), Hybrid (1-1/2-1-1), Hybrid 2
(1-2-1-1), Vote

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/CAPTAINS FIRSTPICK

DESCRIPTION

Specify who gets the first pick in captain selection.

USAGE: /CAPTAINS FIRSTPICK [MODE]

ARGUMENTS:

mode: (Required) Who gets the first pick.
    Options: Highest Rated, Lowest Rated, Random

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/CAPTAINS RESHUFFLE

DESCRIPTION

Sets whether players can reshuffle captains in random captain selection.

USAGE: /CAPTAINS RESHUFFLE [TOGGLE]

ARGUMENTS:

toggle: (Required) Whether reshuffling is enabled or disabled.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/CAPTAINS ROLE

DESCRIPTION

Sets a role which gets priority for being captain.

USAGE: /CAPTAINS ROLE (ROLE)

ARGUMENTS:

role: (Optional) The captain role.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/CAPTAINS SELECTION

DESCRIPTION

Choose how captains will be picked.

USAGE: /CAPTAINS SELECTION

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


CHANNEL CONFIG

> Due to Discord API limitations, NeatQueue can only update the channel name
> twice per a 10 minute period.


/CHANNEL CATEGORY

DESCRIPTION

(Default: Parent) Sets whether created channels go in a separate or the parent
category.

USAGE: /CHANNEL CATEGORY [CATEGORY_MODE] (CATEGORY)

ARGUMENTS:

category_mode: (Required) The category setting. If mode is Specified, you must
provide the category.
    Options: Parent, New, Specified
category: (Optional) The specific category if category_mode is Specified.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/CHANNEL NAME QUEUEEMPTY

DESCRIPTION

Set the channel name when a queue is empty. Can only be updated twice per 10
minutes!.

USAGE: /CHANNEL NAME QUEUEEMPTY [CHANNEL_NAME]

ARGUMENTS:

channel_name: (Required) The channel name.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/CHANNEL NAME QUEUELOCKED

DESCRIPTION

Set the channel name when a queue is locked. Can only be updated twice per 10
minutes!.

USAGE: /CHANNEL NAME QUEUELOCKED [CHANNEL_NAME]

ARGUMENTS:

channel_name: (Required) The channel name.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/CHANNEL NAME QUEUENOTEMPTY

DESCRIPTION

Set the channel name when a queue isn't empty. Can only be updated twice per 10
minutes!.

USAGE: /CHANNEL NAME QUEUENOTEMPTY [CHANNEL_NAME]

ARGUMENTS:

channel_name: (Required) The channel name.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/CHANNEL RESTRICTIONS

DESCRIPTION

(Default: enabled) Sets whether created channels have restrictions.

USAGE: /CHANNEL RESTRICTIONS [MODE]

ARGUMENTS:

mode: (Required) If channels are restricted.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


CLEAR QUEUE


/CLEARQUEUE

DESCRIPTION

Clears the running queue.

USAGE: /CLEARQUEUE

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


COMMAND BUTTON


/COMMANDBUTTON CREATE

DESCRIPTION

(BETA) Sends a button which triggers a command when clicked.

USAGE: /COMMANDBUTTON CREATE [COMMAND] (COLOR) (EMOJI) (LABEL)

ARGUMENTS:

command: (Required) Command to invoke.
color: (Optional) Color for the button.
    Options: blurple, gray, green, red
emoji: (Optional) Emoji to include in the button.
label: (Optional) Label for the button, defaults to the command name.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/COMMANDBUTTON STATS

DESCRIPTION

Send a button that allows players to show their stats.

USAGE: /COMMANDBUTTON STATS

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


CONFIG LOADING/SAVING


/CONFIG LIST

DESCRIPTION

List the 15 most recently created configs.

USAGE: /CONFIG LIST

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/CONFIG LOAD

DESCRIPTION

Loads the queue configuration based on the given name.

USAGE: /CONFIG LOAD [CONFIG]

ARGUMENTS:

config: (Required) Config name.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/CONFIG SAVE

DESCRIPTION

Save the current queue configuration to a name.

USAGE: /CONFIG SAVE (NAME)

ARGUMENTS:

name: (Optional) Name of new config code, or omit for a random code.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


CROSS CHAT


/CROSSCHAT JOIN

DESCRIPTION

Join/create a crosschat room, to share a text channel between servers.

USAGE: /CROSSCHAT JOIN (ROOM_NAME) (CENSORED)

ARGUMENTS:

room_name: (Optional) Name of the room.
censored: (Optional) If crosschat text should be censored.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/CROSSCHAT LEAVE

DESCRIPTION

Leave the crosschat.

USAGE: /CROSSCHAT LEAVE

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


DODGE


/DODGE AUTOBAN

DESCRIPTION

Auto ban players who cause a match to cancel by not joining the voice channel.

USAGE: /DODGE AUTOBAN (DURATION)

ARGUMENTS:

duration: (Optional) Duration of time in seconds for the ban to last, or 0 to
reset.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/DODGE MMRPENALTY

DESCRIPTION

Deduct MMR from players who dodge the match.

USAGE: /DODGE MMRPENALTY [AMOUNT]

ARGUMENTS:

amount: (Required) Amount of MMR to deduct.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/DODGE POINTSPENALTY

DESCRIPTION

Deduct points from players who dodge the match.

USAGE: /DODGE POINTSPENALTY [AMOUNT]

ARGUMENTS:

amount: (Required) Amount of points to deduct.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


END QUEUE


/ENDQUEUE

DESCRIPTION

Ends the running queue.

USAGE: /ENDQUEUE

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


FORCE START


/FORCESTARTCONFIG CONDITIONS

DESCRIPTION

Sets the requirements for forcestarting.

USAGE: /FORCESTARTCONFIG CONDITIONS [MIN_SIZE] (MAX_SIZE) (ONLY_FAIR)
(AUTO_START)

ARGUMENTS:

min_size: (Required) Enter the minimum number of players required. Set to -1 to
disable.
max_size: (Optional) Enter the maximum number of players required. Set to -1 to
ignore.
only_fair: (Optional) Should the forcestart happen if teams are not the same
size?.
auto_start: (Optional) Should the forcestart vote automatically happen when
possible?.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/FORCESTARTCONFIG COOLDOWN

DESCRIPTION

(Default: 300) Sets the forcestart cooldown.

USAGE: /FORCESTARTCONFIG COOLDOWN [SECONDS]

ARGUMENTS:

seconds: (Required) Cooldown duration in seconds.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


GAME INTEGRATIONS


/REQUIREREGISTER

DESCRIPTION

Specify whether players must register their account before playing.

USAGE: /REQUIREREGISTER [MODE]

ARGUMENTS:

mode: (Required) Game to register with, or None to disable.
    Options: None, Valorant, Rainbow 6, Overwatch, RocketLeague, Custom API,
Manually

> With register mode being Custom API, please check out
> https://docs.neatqueue.com/#/?id=webhooks With register mode Manually, players
> must have their MMR manually set, either through an admin command or via an
> API request https://docs.neatqueue.com/#/?id=endpoints.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


GAMEMODES


/GAMEMODE RESHUFFLE

DESCRIPTION

Sets whether players can reshuffle gamemodes in random gamemode selection.

USAGE: /GAMEMODE RESHUFFLE [TOGGLE] (RESHUFFLE_LIMIT)

ARGUMENTS:

toggle: (Required) Whether reshuffling is enabled or disabled.
    Options: Enabled, Disabled
reshuffle_limit: (Optional) How many times players can reshuffle gamemodes.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/GAMEMODE SELECTION

DESCRIPTION

Choose how gamemodes are selected.

USAGE: /GAMEMODE SELECTION [GAMEMODE_CHOICE]

ARGUMENTS:

gamemode_choice: (Required) Voting, always random, ordered, or least common.
    Options: Vote, Random, Least Frequent, Ordered

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


HEROES


/HERO ADD

DESCRIPTION

Adds the given hero.

USAGE: /HERO ADD [HERO_NAME]

ARGUMENTS:

hero_name: (Required) New hero name.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/HERO BANS

DESCRIPTION

Specify the number of hero bans or 0 to disable.

USAGE: /HERO BANS [BANS] (PER_TEAM)

ARGUMENTS:

bans: (Required) Number of bans (per team if applicable).
per_team: (Optional) If the hero bans are team by team.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/HERO REMOVE

DESCRIPTION

Removes the given hero.

USAGE: /HERO REMOVE [HERO_NAME]

ARGUMENTS:

hero_name: (Required) The hero to remove, or ALL to remove all.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/HERO VOTING

DESCRIPTION

Specify who can vote for hero bans. Defaults to All if no captains.

USAGE: /HERO VOTING [PER_TEAM] [MODE]

ARGUMENTS:

per_team: (Required) If the map vote goes team by team. Team 1 picks first ban,
Team 2 picks next, ...
mode: (Required) Who can vote.
    Options: All, Captains

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


INFO


/INFO

DESCRIPTION

View information about the queue configuration.

USAGE: /INFO

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


LANGUAGE


/LANGUAGE SET

DESCRIPTION

Set the language for the server.

USAGE: /LANGUAGE SET [LANGUAGE]

ARGUMENTS:

language: (Required) Server language.
    Options: English, Spanish, French, Portuguese, Japanese, Russian, German,
Italian, Ukrainian, Polish, Hebrew, Arabic, Bengali, Hindi, Turkish, Vietnamese,
Uwu, Owo

> If there is an issue with a normal language translation, please fix here:
> https://crowdin.com/project/neatqueue

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


LEADERBOARD CONFIG

> Leaderboard titles are hyperlinks to the website version of the leaderboard.


/LEADERBOARDCONFIG EDITS

DESCRIPTION

Specify who can edit a leaderboard.

USAGE: /LEADERBOARDCONFIG EDITS [EDITS]

ARGUMENTS:

edits: (Required) Who can edit the leaderboard buttons.
    Options: Staff, Anyone, Creator

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/LEADERBOARDCONFIG IGNOREROLES ADD

DESCRIPTION

Will not show players on leaderboard with this role.

USAGE: /LEADERBOARDCONFIG IGNOREROLES ADD [ROLE]

ARGUMENTS:

role: (Required) Required role to show on leaderboard.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/LEADERBOARDCONFIG IGNOREROLES REMOVE

DESCRIPTION

Remove an ignored leaderboard role.

USAGE: /LEADERBOARDCONFIG IGNOREROLES REMOVE [ROLE]

ARGUMENTS:

role: (Required) Role to no longer ignore.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/LEADERBOARDCONFIG MONTHLY

DESCRIPTION

Toggle monthly leaderboards, either resets monthly or rolls over.

USAGE: /LEADERBOARDCONFIG MONTHLY [TOGGLE] (MODE)

ARGUMENTS:

toggle: (Required) If monthly leaderboards are enabled.
    Options: Enabled, Disabled
mode: (Optional) If stats reset for the month, or keep rolling.
    Options: Reset, Rolling

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/LEADERBOARDCONFIG REQUIREDGAMES

DESCRIPTION

(Default: 1) The required number of games played to be displayed on the
leaderboard.

USAGE: /LEADERBOARDCONFIG REQUIREDGAMES [GAMES]

ARGUMENTS:

games: (Required) Required number of games.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/LEADERBOARDCONFIG SHAREDSTATS SERVERWIDE

DESCRIPTION

Toggle having player stats be shared among all queues.

USAGE: /LEADERBOARDCONFIG SHAREDSTATS SERVERWIDE [TOGGLE] (NAME)

ARGUMENTS:

toggle: (Required) If player stats are server wide.
    Options: Enabled, Disabled
name: (Optional) Shared stats name, or omit to automatically determine.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/LEADERBOARDCONFIG SHAREDSTATS SET

DESCRIPTION

Sets the name to use for stats storaged. Queues with the same name share stats.

USAGE: /LEADERBOARDCONFIG SHAREDSTATS SET [NAME]

ARGUMENTS:

name: (Required) Shared stats configuration name.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/LEADERBOARDCONFIG TYPE

DESCRIPTION

Toggle using the image or text leaderboard.

USAGE: /LEADERBOARDCONFIG TYPE [TYPE]

ARGUMENTS:

type: (Required) Leaderboard format.
    Options: Images, Text

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


LINK QUEUE


/LINK

DESCRIPTION

Links the current channel to another channel's queue.

USAGE: /LINK [CHANNEL]

ARGUMENTS:

channel: (Required) Enter the channel to link to.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/UNLINK

DESCRIPTION

Unlinks the current channel.

USAGE: /UNLINK

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


LOBBY CHANNEL


/LOBBYCHANNEL AUTOMUTE

DESCRIPTION

If the lobby channel should mute all players.

USAGE: /LOBBYCHANNEL AUTOMUTE [TOGGLE]

ARGUMENTS:

toggle: (Required) If players are muted in the lobby channel.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/LOBBYCHANNEL PAUSE

DESCRIPTION

Pause the current lobby channel countdown timer.

USAGE: /LOBBYCHANNEL PAUSE

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/LOBBYCHANNEL PULLALL

DESCRIPTION

Specify pulling players from all channels when their match starts.

USAGE: /LOBBYCHANNEL PULLALL [TOGGLE]

ARGUMENTS:

toggle: (Required) Pull players from all channels.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/LOBBYCHANNEL RETURNALL

DESCRIPTION

Specify returning players to their original voice channel from before the match.

USAGE: /LOBBYCHANNEL RETURNALL [TOGGLE]

ARGUMENTS:

toggle: (Required) Return players to their original voice channel.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/LOBBYCHANNEL SET

DESCRIPTION

Specify the voice channel to move players to/from before/after a game.

USAGE: /LOBBYCHANNEL SET [CHANNEL]

ARGUMENTS:

channel: (Required) Channel to drag/drop players from/to.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/LOBBYCHANNEL TIMER

DESCRIPTION

Specify how long players have to join the voice channel before the match is
cancelled.

USAGE: /LOBBYCHANNEL TIMER [TIMER]

ARGUMENTS:

timer: (Required) (Default: 300) Timeout length in seconds.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/LOBBYCHANNEL TOGGLE

DESCRIPTION

Toggle creating a voice channel when a match is created for lobby setup.

USAGE: /LOBBYCHANNEL TOGGLE [TOGGLE]

ARGUMENTS:

toggle: (Required) If a new voice channel is made for each lobby setup.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/LOBBYCHANNEL UNPAUSE

DESCRIPTION

Unpause the current lobby channel countdown timer.

USAGE: /LOBBYCHANNEL UNPAUSE

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


LOBBY DETAILS


/LOBBYDETAILS LOCATION

DESCRIPTION

Sets the lobby details message.

USAGE: /LOBBYDETAILS LOCATION [LOCATION]

ARGUMENTS:

location: (Required) Where to show lobby details.
    Options: DMs, Teams Message

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/LOBBYDETAILS REMOVE

DESCRIPTION

Removed the lobby details message.

USAGE: /LOBBYDETAILS REMOVE

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/LOBBYDETAILS SET

DESCRIPTION

Sets the lobby details message.

USAGE: /LOBBYDETAILS SET [MESSAGE]

ARGUMENTS:

message: (Required) Enter the message to send.

> Currently supports five substitutions:
> 
> HOST: Randomly select a player name
> QUEUENUM: Substitute the queue number
> RANDOMTEAM: Substitute a random team name
> RANDOM[Option1,Option2,...]: Randomly select one of the given options and
> substitute. Ex: RANDOM[Heads,Tails]
> PASSWORD#T: Generate a random string of characters, where # is the length of
> the password, and T is the type of characters to be in the password. There are
> currently 5 supported password types:
> 
>  1. L: Lowercase Letters only
>  2. U: Uppercase Letters only
>  3. N: Numbers only
>  4. C: Lowercase and Uppercase Letters
>  5. A: Lowercase Letters, Uppercase Letters, and Numbers
> 
> Example: /lobbydetails set "Host: HOST, Lobby Name: QUEUENUM, Lobby Password:
> PASSWORD8A could substitute to
> 
> "Host: @NeatZ, Lobby Name: 12345, Lobby Password: D83mA76x"
> 
> You can further enhance the visuals using Markdown formatting.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


LOCK


/LOCK

DESCRIPTION

Lock the queue channel to prevent players from joining.

USAGE: /LOCK (ALL)

ARGUMENTS:

all: (Optional) Lock all queues?.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/UNLOCK

DESCRIPTION

Unlock the queue channel to allow players to join.

USAGE: /UNLOCK (ALL)

ARGUMENTS:

all: (Optional) Unlock all queues?.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


LOGS


/LOGS

DESCRIPTION

View a log of used NeatQueue commands.

USAGE: /LOGS (FILTER)

ARGUMENTS:

filter: (Optional) Filter for logs containing this word.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


MMR CHANGE


/MMR CHANGE ALLOW_DISABLE

DESCRIPTION

Sets if the vote to disable MMR appears.

USAGE: /MMR CHANGE ALLOW_DISABLE [ALLOW_DISABLE]

ARGUMENTS:

allow_disable: (Required) If MMR changes should be toggleable.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MMR CHANGE HIDDEN

DESCRIPTION

Sets if MMR changes are hidden from players.

USAGE: /MMR CHANGE HIDDEN [HIDDEN]

ARGUMENTS:

hidden: (Required) If MMR changes are hidden.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MMR CHANGE MODE

DESCRIPTION

(Default: Per Player) Sets if MMR changes are calculated per player, or per
team.

USAGE: /MMR CHANGE MODE [MODE]

ARGUMENTS:

mode: (Required) How MMR changes are calculated.
    Options: Per Player, Per Team

> MMR multipliers will still be applied on a per-player basis. Disable
> multipliers to make everyone on the team get the same MMR change.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MMR CHANGE SET

DESCRIPTION

(Default: 50) Sets the MMR change per game.

USAGE: /MMR CHANGE SET [AMOUNT] (LOSER_MMR) (STATIC)

ARGUMENTS:

amount: (Required) The average MMR change for wins and losses.
loser_mmr: (Optional) Override the MMR change for losses.
static: (Optional) If the MMR change should ALWAYS be this value.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MMR CHANGE VARIANCE

DESCRIPTION

Sets the variance value. Lower value = higher ranges of MMR changes.

USAGE: /MMR CHANGE VARIANCE [AMOUNT]

ARGUMENTS:

amount: (Required) (Default: 1600) Variance value. See docs for a calculator.

> Calculator: https://www.desmos.com/calculator/3qtwvlrw8q Using the calculator,
> you can see that as the variance value goes up, the actually outputted MMR
> change has lower variance.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MMR DECAY

DESCRIPTION

Enable/disable MMR decay and configure the values.

USAGE: /MMR DECAY [TOGGLE] (AMOUNT) (AMOUNT_TYPE) (DURATION) (MINIMUM)

ARGUMENTS:

toggle: (Required) Enable/disable MMR decay.
    Options: Enabled, Disabled
amount: (Optional) (Default: 20) Amount of MMR to decay.
amount_type: (Optional) (Default: Static Value) If the amount is an static
value, or a percentage of total MMR.
    Options: Static Value, Percentage
duration: (Optional) (Default: 1 week) After how long should a player decay in
seconds.
minimum: (Optional) (Default: None) Lowest MMR a player will decay to, omit to
remove.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MMR MAXIMUM

DESCRIPTION

Sets the highest mmr a player can reach in this queue.

USAGE: /MMR MAXIMUM (MMR)

ARGUMENTS:

mmr: (Optional) Enter the peak rating, or omit to reset.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MMR MINIMUM

DESCRIPTION

Sets the lowest mmr a player can reach in this queue.

USAGE: /MMR MINIMUM (MMR)

ARGUMENTS:

mmr: (Optional) Enter the lowest rating, or omit to reset.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MMR MULTIPLIERS PLACEMENTS

DESCRIPTION

Toggle the placement matches multiplier.

USAGE: /MMR MULTIPLIERS PLACEMENTS [TOGGLE]

ARGUMENTS:

toggle: (Required) If there exists a multiplier for the first 10 matches.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MMR MULTIPLIERS REMOVE

DESCRIPTION

Remove the MMR multiplier for the given role.

USAGE: /MMR MULTIPLIERS REMOVE [ROLE]

ARGUMENTS:

role: (Required) Role to remove multiplier for.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MMR MULTIPLIERS SET

DESCRIPTION

Sets the MMR multiplier for the given role for wins.

USAGE: /MMR MULTIPLIERS SET [ROLE] [MULTIPLIER]

ARGUMENTS:

role: (Required) -.
multiplier: (Required) Multiplier value. (Ex: 1.2 for a 20% boost).

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MMR MULTIPLIERS STREAKS

DESCRIPTION

Toggle the streak multiplier.

USAGE: /MMR MULTIPLIERS STREAKS [TOGGLE]

ARGUMENTS:

toggle: (Required) If there exists a multiplier for win/loss streaks.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MMR REQUIREMENT

DESCRIPTION

Sets the required mmr to enter this queue.

USAGE: /MMR REQUIREMENT (MINIMUM_MMR) (MAXIMUM_MMR)

ARGUMENTS:

minimum_mmr: (Optional) Enter the lowest MMR a player must be to join the queue,
or omit to disable.
maximum_mmr: (Optional) Enter the highest MMR a player can be to join the queue,
or omit to disable.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


MVPS


/MVP REWARD

DESCRIPTION

(Default: 5) MMR reward for MVPs.

USAGE: /MVP REWARD [AMOUNT]

ARGUMENTS:

amount: (Required) Amount of MMR to give as a reward.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MVP TOGGLE

DESCRIPTION

Enable/disable MVP votes for matches.

USAGE: /MVP TOGGLE [TOGGLE]

ARGUMENTS:

toggle: (Required) Enable/disable MVPs.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MVP VOTEREQUIRED

DESCRIPTION

(Default: Disabled) Require players to vote for MVP before voting for winner.

USAGE: /MVP VOTEREQUIRED [TOGGLE]

ARGUMENTS:

toggle: (Required) If voting for MVP is required.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


MANAGE PLAYERS


/PLAYER ADD

DESCRIPTION

Adds the given player to the queue.

USAGE: /PLAYER ADD [USER] (ROLE) (TEAM)

ARGUMENTS:

user: (Required) -.
role: (Optional) Enter the role for the player.
team: (Optional) Enter the team for the player if desired.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/PLAYER BAN

DESCRIPTION

Bans a player from queuing for the given duration of time.

USAGE: /PLAYER BAN [PLAYER] (DAYS) (HOURS) (MINUTES) (SECONDS) (REASON)

ARGUMENTS:

player: (Required) The player to ban.
days: (Optional) Days to ban for.
hours: (Optional) Hours to ban for.
minutes: (Optional) Minutes to ban for.
seconds: (Optional) Seconds to ban for.
reason: (Optional) -.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/PLAYER BANLIST

DESCRIPTION

View the player ban list.

USAGE: /PLAYER BANLIST

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/PLAYER REMOVE

DESCRIPTION

Removes the given player from the queue.

USAGE: /PLAYER REMOVE [USER]

ARGUMENTS:

user: (Required) The player.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/PLAYER SUB

DESCRIPTION

Substitute the first player for the second player.

USAGE: /PLAYER SUB [PLAYER1] [PLAYER2] (GAMENUM)

ARGUMENTS:

player1: (Required) Enter the player to replace.
player2: (Required) Enter the player that will be inserted.
gamenum: (Optional) Game to modify. Can be omitted to use this channels game.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/PLAYER UNBAN

DESCRIPTION

Unban the given player from queuing.

USAGE: /PLAYER UNBAN [PLAYER]

ARGUMENTS:

player: (Required) The player to unban.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


MANAGE STATS


/MANAGESTATS COPY

DESCRIPTION

Copies the player stats from the old queue name to the new one.

USAGE: /MANAGESTATS COPY [OLD_NAME] [NEW_NAME]

ARGUMENTS:

old_name: (Required) Old queue name with stats.
new_name: (Required) New name to copy the stats to. Will overwrite any stats
stored there.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MANAGESTATS MERGE

DESCRIPTION

Merges stats from the first queue name into the second queue name.

USAGE: /MANAGESTATS MERGE [FROM_QUEUE_NAME] [TO_QUEUE_NAME] (MMR_MERGE_STRATEGY)

ARGUMENTS:

from_queue_name: (Required) Queue to merge stats from.
to_queue_name: (Required) Queue to merge stats into.
mmr_merge_strategy: (Optional) How individual MMRs should be merged together.
    Options: Maximum, Add Together, Average, Ignore

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MANAGESTATS MOVE

DESCRIPTION

Moves the player stats from the old queue name to the new one.

USAGE: /MANAGESTATS MOVE [OLD_NAME] [NEW_NAME]

ARGUMENTS:

old_name: (Required) Old queue name with stats.
new_name: (Required) New name to move the stats to. Will overwrite any stats
stored there.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MANAGESTATS RESET ALL

DESCRIPTION

Resets all stats for all queues, or for the inputted queue name.

USAGE: /MANAGESTATS RESET ALL (QUEUE_NAME)

ARGUMENTS:

queue_name: (Optional) The queue name to reset stats for.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MANAGESTATS RESET MMR

DESCRIPTION

Resets all MMR for all queues, or for the inputted queue name.

USAGE: /MANAGESTATS RESET MMR (QUEUE_NAME)

ARGUMENTS:

queue_name: (Optional) The queue name to reset stats for.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MANAGESTATS RESET PLAYER

DESCRIPTION

Reset the user's data for all queues or a certain queue.

USAGE: /MANAGESTATS RESET PLAYER [USER] (QUEUE_NAME)

ARGUMENTS:

user: (Required) Enter the desired user.
queue_name: (Optional) Enter the queue data to remove from. Ignore to delete all
data from all queues.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


MAPS


/MAP ADD

DESCRIPTION

Adds the given map.

USAGE: /MAP ADD [MAP_NAME] (GAME_MODES) (IMAGE_URL)

ARGUMENTS:

map_name: (Required) New map name.
game_modes: (Optional) Comma separated list of game modes for map, if
applicable.
image_url: (Optional) Image to show when map selected.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MAP BANS

DESCRIPTION

Specify the number of map bans per team, or 0 to disable.

USAGE: /MAP BANS [BANS] (PER_TEAM)

ARGUMENTS:

bans: (Required) Number of bans per team.
per_team: (Optional) If the map bans are team by team.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MAP REMOVE

DESCRIPTION

Removes the given map.

USAGE: /MAP REMOVE [MAP_NAME]

ARGUMENTS:

map_name: (Required) The map to remove, or ALL to remove all.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MAP RESHUFFLE

DESCRIPTION

Sets whether players can reshuffle maps in random map selection.

USAGE: /MAP RESHUFFLE [TOGGLE] (RESHUFFLE_LIMIT)

ARGUMENTS:

toggle: (Required) Whether reshuffling is enabled or disabled.
    Options: Enabled, Disabled
reshuffle_limit: (Optional) How many times players can reshuffle maps.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MAP SELECTION

DESCRIPTION

Choose how maps are selected.

USAGE: /MAP SELECTION [MAP_CHOICE]

ARGUMENTS:

map_choice: (Required) Voting, always random, or least common.
    Options: Vote, Random, Least Frequent

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MAP VOTING

DESCRIPTION

Specify who can vote for map picks and map bans. Defaults to All if no captains.

USAGE: /MAP VOTING [PER_TEAM] [MODE]

ARGUMENTS:

per_team: (Required) If the map vote goes team by team. Team 1 picks first map,
Team 2 picks next, ...
mode: (Required) Who can vote.
    Options: All, Captains

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


MATCH START


/MATCHSTART DMPLAYERS

DESCRIPTION

(Default: Enabled) Send a notification DM to all players when a match starts.

USAGE: /MATCHSTART DMPLAYERS [TOGGLE]

ARGUMENTS:

toggle: (Required) If players are DMed on start.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MATCHSTART SHUFFLEONSTART

DESCRIPTION

(Default: Disabled) Shuffle the player pool on start.

USAGE: /MATCHSTART SHUFFLEONSTART [MODE]

ARGUMENTS:

mode: (Required) -.
    Options: Disabled, Lottery, Priority

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MATCHSTART WHEN

DESCRIPTION

(Default: Either) Start the match when the queue fills, or only when
forcestarted.

USAGE: /MATCHSTART WHEN [MODE]

ARGUMENTS:

mode: (Required) Condition for starting the match.
    Options: Queue Filled, Forcestart, Either

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


MATCHMAKING

> The matchmaker works by checking the current queue if there are enough players
> to create a match. A match will only be created if the total range of player
> MMRs is less than the specified matchmaking range. Every 15 seconds, the range
> will be increased by the matchmaking leniency, and the match conditions will
> be rechecked with this new extended matchmaking range.


/MATCHMAKING LENIENCY

DESCRIPTION

Every 15 seconds, how much the range will increase for a better chance at a
match.

USAGE: /MATCHMAKING LENIENCY [VALUE]

ARGUMENTS:

value: (Required) How much to increase the range by.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MATCHMAKING RANGE

DESCRIPTION

The range of MMRs for matches. Tighter range = more waiting and players
required.

USAGE: /MATCHMAKING RANGE [RANGE]

ARGUMENTS:

range: (Required) Range of player MMRs.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


MESSAGES + STYLING


/MESSAGE QUEUEMESSAGE DELAY

DESCRIPTION

(Default: 3) Sets the delay for when a new queue message comes up.

USAGE: /MESSAGE QUEUEMESSAGE DELAY [SECONDS]

ARGUMENTS:

seconds: (Required) New message delay.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MESSAGE QUEUEMESSAGE DELETIONS

DESCRIPTION

(Default: Enabled) Sets whether old queue updates should be deleted.

USAGE: /MESSAGE QUEUEMESSAGE DELETIONS [TOGGLE]

ARGUMENTS:

toggle: (Required) Toggle between editing queue updates, or sending new
messages.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MESSAGE QUEUEMESSAGE EDITS

DESCRIPTION

(Default: Enabled) Set whether queue updates should edit the previous message.

USAGE: /MESSAGE QUEUEMESSAGE EDITS [TOGGLE]

ARGUMENTS:

toggle: (Required) Toggle between editing queue updates, or sending new
messages.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MESSAGE QUEUEMESSAGE HISTORY

DESCRIPTION

(Default: Disable) Sets whether to send a new message for every queue
interaction.

USAGE: /MESSAGE QUEUEMESSAGE HISTORY [TOGGLE]

ARGUMENTS:

toggle: (Required) Toggle between sending queue join/leaves in the channel.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MESSAGE QUEUEMESSAGE LEADERBOARDBUTTON

DESCRIPTION

Show a 'Leaderboard' button on the queue message.

USAGE: /MESSAGE QUEUEMESSAGE LEADERBOARDBUTTON [TOGGLE]

ARGUMENTS:

toggle: (Required) If the leaderboard button is shown.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MESSAGE QUEUEMESSAGE STICKY

DESCRIPTION

(Default: Enabled) Sets whether the queue message sticks to the bottom of the
channel.

USAGE: /MESSAGE QUEUEMESSAGE STICKY [TOGGLE]

ARGUMENTS:

toggle: (Required) Toggle the message being sticky.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MESSAGE WINNERMESSAGE FORMAT

DESCRIPTION

Sets the format for the winner message.

USAGE: /MESSAGE WINNERMESSAGE FORMAT [MODE]

ARGUMENTS:

mode: (Required) Formatting type.
    Options: Detailed, Simple

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MESSAGE WINNERMESSAGE PIN

DESCRIPTION

Sets whether the message gets pinned.

USAGE: /MESSAGE WINNERMESSAGE PIN [MODE]

ARGUMENTS:

mode: (Required) Pin mode.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MESSAGE WINNERMESSAGE RESULTS

DESCRIPTION

Set who can vote for the result, or if results are fully disabled.

USAGE: /MESSAGE WINNERMESSAGE RESULTS [VALUE]

ARGUMENTS:

value: (Required) Who can vote, or if the match has no outcome.
    Options: Default, Staff Only, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MESSAGE WINNERMESSAGE STICKY

DESCRIPTION

Sets whether the message sticks to the bottom of chat.

USAGE: /MESSAGE WINNERMESSAGE STICKY [MODE]

ARGUMENTS:

mode: (Required) Sticky mode.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


MISCELLANEOUS/UTILITY


/MISC MENTION TEAMSCREATED

DESCRIPTION

(Default: Disabled) Mention the players after teams are created.

USAGE: /MISC MENTION TEAMSCREATED [TOGGLE]

ARGUMENTS:

toggle: (Required) If the players are mentioned after teams are created.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MISC NAMETYPE

DESCRIPTION

Sets whether to use nicknames or discord names (Default: nick).

USAGE: /MISC NAMETYPE [TYPE]

ARGUMENTS:

type: (Required) The type of names to be used.
    Options: Discord, Nicknames

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/MISC PURGE

DESCRIPTION

Delete ALL messages in the channel except the queue message if it exists.

USAGE: /MISC PURGE

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


MOD CHANNEL


/STAFFCHANNEL REMOVE

DESCRIPTION

Remove the set results channel.

USAGE: /STAFFCHANNEL REMOVE

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/STAFFCHANNEL SET

DESCRIPTION

Sets the results channel to send queue history.

USAGE: /STAFFCHANNEL SET [CHANNEL] (SERVERWIDE)

ARGUMENTS:

channel: (Required) The text channel to send queue history to.
serverwide: (Optional) Should the channel be global for all queues or just this
one?.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


MODIFY PLAYER DATA


/ADD DECAYGRACEPERIOD

DESCRIPTION

Add a grace period for a user so they won't be affected by MMR decay.

USAGE: /ADD DECAYGRACEPERIOD [TIME] (USER) (ROLE)

ARGUMENTS:

time: (Required) Enter the desired grace period time in seconds.
user: (Optional) The user to modify.
role: (Optional) The role to modify.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/ADD GAME

DESCRIPTION

Increment the players games, use a negative number to decrement.

USAGE: /ADD GAME (GAMES) (USER) (ROLE)

ARGUMENTS:

games: (Optional) Enter the desired games to add.
user: (Optional) The user to modify.
role: (Optional) The role to modify.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/ADD LOSS

DESCRIPTION

Increment the players losses, use a negative number to decrement.

USAGE: /ADD LOSS (LOSSES) (USER) (ROLE)

ARGUMENTS:

losses: (Optional) Enter the desired losses to add.
user: (Optional) The user to modify.
role: (Optional) The role to modify.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/ADD MMR

DESCRIPTION

Increment the players mmr, use a negative number to decrement.

USAGE: /ADD MMR (MMR) (USER) (ROLE)

ARGUMENTS:

mmr: (Optional) Enter the desired mmr to add.
user: (Optional) The user to modify.
role: (Optional) The role to modify.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/ADD MVPS

DESCRIPTION

Increment the players MVPs, use a negative number to decrement.

USAGE: /ADD MVPS [MVPS] (USER) (ROLE)

ARGUMENTS:

mvps: (Required) Enter the desired MVPs to add.
user: (Optional) The user to modify.
role: (Optional) The role to modify.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/ADD PEAKMMR

DESCRIPTION

Increment the players peak mmr, use a negative number to decrement.

USAGE: /ADD PEAKMMR [MMR] (USER) (ROLE)

ARGUMENTS:

mmr: (Required) Enter the desired mmr to add.
user: (Optional) The user to modify.
role: (Optional) The role to modify.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/ADD PEAKSTREAK

DESCRIPTION

Increment the players peak streak, use a negative number to decrement.

USAGE: /ADD PEAKSTREAK [STREAK] (USER) (ROLE)

ARGUMENTS:

streak: (Required) Enter the desired streak to add.
user: (Optional) The user to modify.
role: (Optional) The role to modify.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/ADD POINTS

DESCRIPTION

Increment the players points (not MMR), use a negative number to decrement.

USAGE: /ADD POINTS [POINTS] (USER) (ROLE)

ARGUMENTS:

points: (Required) Enter the desired points to add.
user: (Optional) The user to modify.
role: (Optional) The role to modify.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/ADD STREAK

DESCRIPTION

Increment the players streak, use a negative number to decrement.

USAGE: /ADD STREAK (STREAK) (USER) (ROLE)

ARGUMENTS:

streak: (Optional) Enter the desired streak to add.
user: (Optional) The user to modify.
role: (Optional) The role to modify.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/ADD WIN

DESCRIPTION

Increment the players wins, use a negative number to decrement.

USAGE: /ADD WIN (WINS) (USER) (ROLE)

ARGUMENTS:

wins: (Optional) Enter the desired wins to add.
user: (Optional) The user to modify.
role: (Optional) The role to modify.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SET GAMES

DESCRIPTION

Sets the players games.

USAGE: /SET GAMES [GAMES] (USER) (ROLE)

ARGUMENTS:

games: (Required) Enter the desired games.
user: (Optional) The user to modify.
role: (Optional) The role to modify.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SET IGN

DESCRIPTION

Sets the players IGN (used in /register or /ign).

USAGE: /SET IGN [ACCOUNT] (USER) (ROLE)

ARGUMENTS:

account: (Required) Enter the desired IGN, or 'none' to remove.
user: (Optional) The user to modify.
role: (Optional) The role to modify.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SET LOSSES

DESCRIPTION

Sets the players losses.

USAGE: /SET LOSSES [LOSSES] (USER) (ROLE)

ARGUMENTS:

losses: (Required) Enter the desired losses.
user: (Optional) The user to modify.
role: (Optional) The role to modify.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SET MMR

DESCRIPTION

Sets the players mmr.

USAGE: /SET MMR [MMR] (USER) (ROLE)

ARGUMENTS:

mmr: (Required) Enter the desired mmr.
user: (Optional) The user to modify.
role: (Optional) The role to modify.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SET MVPS

DESCRIPTION

Sets the players MVPs.

USAGE: /SET MVPS [MVPS] (USER) (ROLE)

ARGUMENTS:

mvps: (Required) The new MVPs amount.
user: (Optional) The user to modify.
role: (Optional) The role to modify.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SET PEAKMMR

DESCRIPTION

Sets the players peak mmr.

USAGE: /SET PEAKMMR [MMR] (USER) (ROLE)

ARGUMENTS:

mmr: (Required) Enter the desired mmr.
user: (Optional) The user to modify.
role: (Optional) The role to modify.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SET PEAKSTREAK

DESCRIPTION

Sets the players peak streak.

USAGE: /SET PEAKSTREAK [STREAK] (USER) (ROLE)

ARGUMENTS:

streak: (Required) Enter the desired streak.
user: (Optional) The user to modify.
role: (Optional) The role to modify.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SET POINTS

DESCRIPTION

Sets the players points (not MMR).

USAGE: /SET POINTS [POINTS] (USER) (ROLE)

ARGUMENTS:

points: (Required) The new points amount.
user: (Optional) The user to modify.
role: (Optional) The role to modify.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SET STREAK

DESCRIPTION

Sets the players streak.

USAGE: /SET STREAK [STREAK] (USER) (ROLE)

ARGUMENTS:

streak: (Required) Enter the desired streak.
user: (Optional) The user to modify.
role: (Optional) The role to modify.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SET WINS

DESCRIPTION

Sets the players wins.

USAGE: /SET WINS [WINS] (USER) (ROLE)

ARGUMENTS:

wins: (Required) Enter the desired wins.
user: (Optional) The user to modify.
role: (Optional) The role to modify.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


NUMBER OF LOBBIES


/NUMBEROFLOBBIES

DESCRIPTION

(Default: 1) Sets the number of lobbies to create.

USAGE: /NUMBEROFLOBBIES [LOBBIES]

ARGUMENTS:

lobbies: (Required) The number of lobbies.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


NUMBER OF TEAMS


/NUMBEROFTEAMS

DESCRIPTION

(Default: 2) Sets the number of teams.

USAGE: /NUMBEROFTEAMS [NUMBER]

ARGUMENTS:

number: (Required) The number of teams.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


PARTY QUEUE


/PARTYQUEUE MAXSIZE

DESCRIPTION

Set the max party size that can enter the queue.

USAGE: /PARTYQUEUE MAXSIZE (MAX_SIZE)

ARGUMENTS:

max_size: (Optional) The max party size, or omit to remove.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/PARTYQUEUE PREVENTOVERFILL

DESCRIPTION

(Default: Enabled) Prevent a party from joining queue if it over-fills the
queue.

USAGE: /PARTYQUEUE PREVENTOVERFILL [TOGGLE]

ARGUMENTS:

toggle: (Required) If parties can overfill a queue.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/PARTYQUEUE TOGGLE

DESCRIPTION

Enable party queue, allowing players to create parties with /party before
joining.

USAGE: /PARTYQUEUE TOGGLE [TOGGLE]

ARGUMENTS:

toggle: (Required) Enable or disable party queue.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


PREDICTIONS


/POINTS CHANGE LOSS

DESCRIPTION

(Default: 100) Set how many points players gain for a loss (not MMR).

USAGE: /POINTS CHANGE LOSS [VALUE]

ARGUMENTS:

value: (Required) Points for a loss.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/POINTS CHANGE WIN

DESCRIPTION

(Default: 100) Set how many points players gain for a win (not MMR).

USAGE: /POINTS CHANGE WIN [VALUE]

ARGUMENTS:

value: (Required) Points for a win.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/POINTS MAXIMUM

DESCRIPTION

Sets the highest number of points a player can reach.

USAGE: /POINTS MAXIMUM (POINTS)

ARGUMENTS:

points: (Optional) Enter the peak points, or omit to reset.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/POINTS MINIMUM

DESCRIPTION

Sets the lowest number of points a player can reach.

USAGE: /POINTS MINIMUM (POINTS)

ARGUMENTS:

points: (Optional) Enter the lowest points value, or omit to reset.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/POINTS MULTIPLIERS REMOVE

DESCRIPTION

Remove the points multiplier for the given role.

USAGE: /POINTS MULTIPLIERS REMOVE [ROLE]

ARGUMENTS:

role: (Required) Role to remove multiplier for.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/POINTS MULTIPLIERS SET

DESCRIPTION

Sets the points multiplier for the given role.

USAGE: /POINTS MULTIPLIERS SET [ROLE] [MULTIPLIER]

ARGUMENTS:

role: (Required) -.
multiplier: (Required) Multiplier value. (Ex: 1.2 for a 20% boost).

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/POINTS STARTINGVALUE

DESCRIPTION

(Default: 0) Set how many points players start with (not MMR).

USAGE: /POINTS STARTINGVALUE [VALUE]

ARGUMENTS:

value: (Required) Starting points value.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/PREDICTIONS CHANNEL

DESCRIPTION

Specify the channel to show predictions.

USAGE: /PREDICTIONS CHANNEL [CHANNEL]

ARGUMENTS:

channel: (Required) The predictions channel.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/PREDICTIONS ROLE

DESCRIPTION

Role to ping when a prediction opens.

USAGE: /PREDICTIONS ROLE [ROLE]

ARGUMENTS:

role: (Required) Role to ping.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/PREDICTIONS TIMER

DESCRIPTION

Specify the duration the prediction lasts before closing.

USAGE: /PREDICTIONS TIMER [TIMER]

ARGUMENTS:

timer: (Required) (Default: 180) Prediction length in seconds.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/PREDICTIONS TOGGLE

DESCRIPTION

Specify the channel to show predictions.

USAGE: /PREDICTIONS TOGGLE [TOGGLE]

ARGUMENTS:

toggle: (Required) If predictions are enabled or disabled.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


QUEUE ENTRY METHODS


/QUEUEENTRY CHANNEL SET

DESCRIPTION

(BETA) Add players to the queue when they join the voice channel.

USAGE: /QUEUEENTRY CHANNEL SET (CHANNEL)

ARGUMENTS:

channel: (Optional) Queue entry voice channel, or omit to remove.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/QUEUEENTRY METHODS

DESCRIPTION

(BETA) Specify how players can join the queue.

USAGE: /QUEUEENTRY METHODS [MODES]

ARGUMENTS:

modes: (Required) The methods players can use to join the queue.
    Options: Buttons, Voice Channel, Either

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/QUEUEENTRY PRICE

DESCRIPTION

Set how many points a player must pay to join the queue.

USAGE: /QUEUEENTRY PRICE [VALUE] (PAYOUT_FEE)

ARGUMENTS:

value: (Required) Price in points.
payout_fee: (Optional) Fee to take when paying out rewards. A value of 10 means
a 10% fee is applied.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/QUEUEENTRY SURVEY ADD

DESCRIPTION

Adds a new survey which players must respond to before queuing.

USAGE: /QUEUEENTRY SURVEY ADD [TITLE] [ALLOW_OTHER] [OPTIONS] (KEY)
(SHOW_IN_TEAMS_MESSAGE)

ARGUMENTS:

title: (Required) Title of the survey.
allow_other: (Required) If players can pick "Other" and manually type their
response.
options: (Required) Comma separated list of options.
key: (Optional) Key which is used to store the results for a player, or omit to
use the title.
show_in_teams_message: (Optional) -.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/QUEUEENTRY SURVEY DELETE

DESCRIPTION

Delete a previously added survey.

USAGE: /QUEUEENTRY SURVEY DELETE [TITLE]

ARGUMENTS:

title: (Required) Title of the survey.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


QUEUE NAME


/QUEUENAME

DESCRIPTION

Sets the name for this queue. All stats are tied to the queue name.

USAGE: /QUEUENAME [NAME]

ARGUMENTS:

name: (Required) New queue name.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


QUEUE TYPE


/QUEUETYPE

DESCRIPTION

Select the type of queue to run. See docs for detailed explanations.

USAGE: /QUEUETYPE [TYPE]

ARGUMENTS:

type: (Required) The type of queue.
    Options: PUGs/Normal Individual Queue, Matchmaking, Full Team vs Full Team,
Select Team On Join

> PUGs/Normal Individual Queue: The default queue setup, players join
> individually to get put into a match when the queue is filled. Matchmaking:
> Players join the queue, and once there are enough players within their MMR
> range, a match is created. Full Team vs Full Team: Captains join the queue and
> pull in the entire team. No team setup is required. Select Team On Join: The
> queue has join buttons for each team, no team setup is required.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


RANKS/AUTOMATICALLY ASSIGN DISCORD ROLES


/AUTOROLES COPY

DESCRIPTION

Copies the auto roles config to the desired channel.

USAGE: /AUTOROLES COPY [CHANNEL]

ARGUMENTS:

channel: (Required) Channel with queue to copy autoroles config to.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES GAMES REMOVE

DESCRIPTION

Removes a condition where player roles are changed based on games.

USAGE: /AUTOROLES GAMES REMOVE [ROLE]

ARGUMENTS:

role: (Required) Enter the role.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES GAMES SET

DESCRIPTION

(Ranks) Adds a condition in which player roles are changed based on games.

USAGE: /AUTOROLES GAMES SET [ROLE] [LOWER_VALUE] [UPPER_VALUE]
(ONLY_ONE_ALLOWED)

ARGUMENTS:

role: (Required) Role.
lower_value: (Required) The lowest number of games required to gain the role.
upper_value: (Required) The upper number of games to lose the role.
only_one_allowed: (Optional) (Default: True) If this role is assigned, no other
games autoroles will be allowed.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES INGAME

DESCRIPTION

Assign a role to players who are in a match that is removed after.

USAGE: /AUTOROLES INGAME (ROLE)

ARGUMENTS:

role: (Optional) Enter the role, or omit to remove.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES INQUEUE

DESCRIPTION

Assign a role to players who are in the queue.

USAGE: /AUTOROLES INQUEUE (ROLE)

ARGUMENTS:

role: (Optional) Enter the role, or omit to remove.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES LOSSES REMOVE

DESCRIPTION

Removes a condition where player roles are changed based on losses.

USAGE: /AUTOROLES LOSSES REMOVE [ROLE]

ARGUMENTS:

role: (Required) Enter the role.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES LOSSES SET

DESCRIPTION

(Ranks) Adds a condition in which player roles are changed based on losses.

USAGE: /AUTOROLES LOSSES SET [ROLE] [LOWER_VALUE] [UPPER_VALUE]
(ONLY_ONE_ALLOWED)

ARGUMENTS:

role: (Required) Role.
lower_value: (Required) The lowest number of losses required to gain the role.
upper_value: (Required) The upper number of losses to lose the role.
only_one_allowed: (Optional) (Default: True) If this role is assigned, no other
loss autoroles will be allowed.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES MMR REMOVE

DESCRIPTION

Removes a condition where player roles are changed based on MMR.

USAGE: /AUTOROLES MMR REMOVE [ROLE]

ARGUMENTS:

role: (Required) Enter the role.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES MMR SET

DESCRIPTION

(Ranks) Adds a condition in which player roles are changed based on MMR.

USAGE: /AUTOROLES MMR SET [ROLE] [LOWER_RATING] [UPPER_RATING]
(LOWER_LOSE_RATING) (ONLY_ONE_ALLOWED)

ARGUMENTS:

role: (Required) Role.
lower_rating: (Required) The lowest MMR required to gain the role.
upper_rating: (Required) The upper MMR rating to lose the role.
lower_lose_rating: (Optional) (Default: lower_rating) The MMR the player must
fall below to lose the role.
only_one_allowed: (Optional) (Default: True) If this role is assigned, no other
MMR autoroles will be allowed.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES MVPS REMOVE

DESCRIPTION

Removes a condition where player roles are changed based on mvps.

USAGE: /AUTOROLES MVPS REMOVE [ROLE]

ARGUMENTS:

role: (Required) Enter the role.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES MVPS SET

DESCRIPTION

(Ranks) Adds a condition in which player roles are changed based on mvps.

USAGE: /AUTOROLES MVPS SET [ROLE] [LOWER_VALUE] [UPPER_VALUE] (ONLY_ONE_ALLOWED)

ARGUMENTS:

role: (Required) Role.
lower_value: (Required) The lowest number of mvps required to gain the role.
upper_value: (Required) The upper number of mvps to lose the role.
only_one_allowed: (Optional) (Default: True) If this role is assigned, no other
mvps autoroles will be allowed.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES NOTIFY

DESCRIPTION

Toggle sending a DM to players when their rank autorole changes.

USAGE: /AUTOROLES NOTIFY [TOGGLE]

ARGUMENTS:

toggle: (Required) If players get a DM for role/rank changes.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES POINTS REMOVE

DESCRIPTION

Removes a condition where player roles are changed based on Points.

USAGE: /AUTOROLES POINTS REMOVE [ROLE]

ARGUMENTS:

role: (Required) Enter the role.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES POINTS SET

DESCRIPTION

(Ranks) Adds a condition in which player roles are changed based on points.

USAGE: /AUTOROLES POINTS SET [ROLE] [LOWER_VALUE] [UPPER_VALUE]
(ONLY_ONE_ALLOWED)

ARGUMENTS:

role: (Required) Role.
lower_value: (Required) The lowest number of points required to gain the role.
upper_value: (Required) The upper number of points to lose the role.
only_one_allowed: (Optional) (Default: True) If this role is assigned, no other
Point autoroles will be allowed.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES REFRESH

DESCRIPTION

Recalculates all autoroles for players.

USAGE: /AUTOROLES REFRESH

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES RESET

DESCRIPTION

Delete all auto role settings.

USAGE: /AUTOROLES RESET

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES STREAKS REMOVE

DESCRIPTION

Removes a condition where player roles are changed based on streaks.

USAGE: /AUTOROLES STREAKS REMOVE [ROLE]

ARGUMENTS:

role: (Required) Enter the role.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES STREAKS SET

DESCRIPTION

(Ranks) Adds a condition in which player roles are changed based on streaks.

USAGE: /AUTOROLES STREAKS SET [ROLE] [LOWER_VALUE] [UPPER_VALUE]
(ONLY_ONE_ALLOWED)

ARGUMENTS:

role: (Required) Role.
lower_value: (Required) The lowest number of streaks required to gain the role.
upper_value: (Required) The upper number of streaks to lose the role.
only_one_allowed: (Optional) (Default: True) If this role is assigned, no other
streaks autoroles will be allowed.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES TOPPLAYERS REMOVE

DESCRIPTION

Removes a top player role.

USAGE: /AUTOROLES TOPPLAYERS REMOVE [ROLE]

ARGUMENTS:

role: (Required) Enter the role.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES TOPPLAYERS SET

DESCRIPTION

Conditionally add/remove a role based on leaderboard position.

USAGE: /AUTOROLES TOPPLAYERS SET [ROLE] [NUMBER]

ARGUMENTS:

role: (Required) Enter the role for the top players.
number: (Required) Enter the number of players who can have this role.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES WINRATE REMOVE

DESCRIPTION

Removes a condition where player roles are changed based on winrate.

USAGE: /AUTOROLES WINRATE REMOVE [ROLE]

ARGUMENTS:

role: (Required) Enter the role.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES WINRATE SET

DESCRIPTION

(Ranks) Adds a condition in which player roles are changed based on winrate.

USAGE: /AUTOROLES WINRATE SET [ROLE] [LOWER_VALUE] [UPPER_VALUE]
(ONLY_ONE_ALLOWED)

ARGUMENTS:

role: (Required) Role.
lower_value: (Required) The lowest winrate value (0 to 100) required to gain the
role.
upper_value: (Required) The upper winrate value (0 to 100) to lose the role.
only_one_allowed: (Optional) (Default: True) If this role is assigned, no other
winrate autoroles will be allowed.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES WINS REMOVE

DESCRIPTION

Removes a condition where player roles are changed based on wins.

USAGE: /AUTOROLES WINS REMOVE [ROLE]

ARGUMENTS:

role: (Required) Enter the role.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/AUTOROLES WINS SET

DESCRIPTION

(Ranks) Adds a condition in which player roles are changed based on wins.

USAGE: /AUTOROLES WINS SET [ROLE] [LOWER_VALUE] [UPPER_VALUE] (ONLY_ONE_ALLOWED)

ARGUMENTS:

role: (Required) Role.
lower_value: (Required) The lowest number of wins required to gain the role.
upper_value: (Required) The upper number of wins to lose the role.
only_one_allowed: (Optional) (Default: True) If this role is assigned, no other
wins autoroles will be allowed.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


REACTION ROLES


/REACTIONROLES ADD

DESCRIPTION

Specify roles to assign when users react to the message.

USAGE: /REACTIONROLES ADD [CHANNEL] [MESSAGE_ID] [ROLE] [REACTION]
(REMOVE_OTHERS) (QUEUE_ROLE)

ARGUMENTS:

channel: (Required) Channel where message is.
message_id: (Required) Message to add reaction to.
role: (Required) Role to assign/remove.
reaction: (Required) Reaction that corresponds to this role.
remove_others: (Optional) If the user has this role, remove all other
reactionroles in the message they have.
queue_role: (Optional) Option role for /roles that the user will default to.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


READY UP


/READYUP MODE

DESCRIPTION

How players indicate they are ready to play a match.

USAGE: /READYUP MODE [MODE]

ARGUMENTS:

mode: (Required) How players show they are ready.
    Options: Ready Up Button, Join Lobby Voice Channel, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/READYUP REPLACEINACTIVE MODE

DESCRIPTION

Changes how a replacement is found.

USAGE: /READYUP REPLACEINACTIVE MODE [MODE]

ARGUMENTS:

mode: (Required) Replacement mode.
    Options: Closest Rated, Highest Rated, Queue Priority

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/READYUP REPLACEINACTIVE TOGGLE

DESCRIPTION

Toggle replacing inactive players if possible.

USAGE: /READYUP REPLACEINACTIVE TOGGLE [TOGGLE]

ARGUMENTS:

toggle: (Required) If automatic replacement is enabled.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


REMATCH


/REMATCHES

DESCRIPTION

(Default: true) Toggle the ability to rematch.

USAGE: /REMATCHES [TOGGLE]

ARGUMENTS:

toggle: (Required) If you want rematches to be enabled or disabled.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


REQUEUE

> For queue types that always start when reaching the queue size, requeue
> priority won't appear to make any changes. However, there are two specific
> queue starting modes where it will matter:
> 
>  1. /queuetype Matchmaking: When the matchmaker is running, it will use the
>     overall sum of all player priorities, and use this value to increase the
>     matchmaking range. For example, if the matchmaking range is 300 MMR, but
>     there are two players with 100 priority each, the matchmaking range for
>     that attempted match creation will be 500 MMR, making it more likely for
>     that match to be created. If you want players with priority to ALWAYS be
>     in the match, you can give them a very large priority (like 100,000),
>     which ensures the matchmaker always considers their match as valid.
>  2. /misc startwhen Forcestarted: When matches can only be forcestarted, the
>     number of players can exceed the maximum queue size. Players who join the
>     queue with priority will take precedence in the queue over lower priority
>     players.


/REQUEUE CONDITION

DESCRIPTION

Sets the condition for letting a player requeue.

USAGE: /REQUEUE CONDITION [CONDITION]

ARGUMENTS:

condition: (Required) Condition that must be met to requeue.
    Options: Must Vote, Winner Selected, None

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/REQUEUE DELAY

DESCRIPTION

Delay people from queuing for the given duration after the condition is met.

USAGE: /REQUEUE DELAY [SECONDS]

ARGUMENTS:

seconds: (Required) Seconds to delay from queuing.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/REQUEUE MATCHCANCELLED

DESCRIPTION

Specify if players get automatically requeued if a match is cancelled.

USAGE: /REQUEUE MATCHCANCELLED [MODE]

ARGUMENTS:

mode: (Required) If requeue is automatic.
    Options: Disabled, Automatic

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/REQUEUE PRIORITY

DESCRIPTION

Give priority to players who requeue after a match.

USAGE: /REQUEUE PRIORITY (VALUE) (SECONDS)

ARGUMENTS:

value: (Optional) (Default: 0) How much priority value to give.
seconds: (Optional) (Default: 300) How many seconds to give this temporary
priority value for.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/REQUEUE PRIORITYROLE ADD

DESCRIPTION

Allow players with the given role to gain priority for requeue.

USAGE: /REQUEUE PRIORITYROLE ADD [ROLE] (VALUE)

ARGUMENTS:

role: (Required) Priority role.
value: (Optional) (Default: 100) Priority value to assign.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/REQUEUE PRIORITYROLE REMOVE

DESCRIPTION

Allow players with the given role to gain priority for requeue.

USAGE: /REQUEUE PRIORITYROLE REMOVE [ROLE]

ARGUMENTS:

role: (Required) Priority role.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


REQUIRE IGN


/REQUIREIGN

DESCRIPTION

(Default: false) Require if players must set their IGN before they can queue.

USAGE: /REQUIREIGN [TOGGLE]

ARGUMENTS:

toggle: (Required) If you want to require that users set their IGN.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


REQUIRED VOTES


/REQUIREDVOTES CANCEL

DESCRIPTION

Sets the number of votes required for cancelling a game.

USAGE: /REQUIREDVOTES CANCEL [TYPE]

ARGUMENTS:

type: (Required) The type of voting requirement to be used.
    Options: Half, Majority, One, Two, Three, Four, Five, Six, Seven, Eight,
Nine, Ten

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/REQUIREDVOTES DEFAULT

DESCRIPTION

Sets the default number of votes required.

USAGE: /REQUIREDVOTES DEFAULT [TYPE]

ARGUMENTS:

type: (Required) The type of voting requirement to be used.
    Options: Half, Majority, One, Two, Three, Four, Five, Six, Seven, Eight,
Nine, Ten

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/REQUIREDVOTES FORCESTART

DESCRIPTION

Sets the number of votes required for forcestarting a game.

USAGE: /REQUIREDVOTES FORCESTART [TYPE]

ARGUMENTS:

type: (Required) The type of voting requirement to be used.
    Options: Half, Majority, One, Two, Three, Four, Five, Six, Seven, Eight,
Nine, Ten

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/REQUIREDVOTES MVP

DESCRIPTION

Sets the number of votes required for getting MVP.

USAGE: /REQUIREDVOTES MVP [TYPE]

ARGUMENTS:

type: (Required) The type of voting requirement to be used.
    Options: Half, Majority, One, Two, Three, Four, Five, Six, Seven, Eight,
Nine, Ten

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/REQUIREDVOTES WINNER

DESCRIPTION

Sets the number of votes required for picking a winner.

USAGE: /REQUIREDVOTES WINNER [TYPE]

ARGUMENTS:

type: (Required) The type of voting requirement to be used.
    Options: Half, Majority, One, Two, Three, Four, Five, Six, Seven, Eight,
Nine, Ten

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


REQUIREMENTS


/BANNEDROLES ADD

DESCRIPTION

Add a banned role which can't join the queue.

USAGE: /BANNEDROLES ADD [ROLE]

ARGUMENTS:

role: (Required) Enter the banned role.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/BANNEDROLES REMOVE

DESCRIPTION

Removed a banned role.

USAGE: /BANNEDROLES REMOVE [ROLE]

ARGUMENTS:

role: (Required) Enter the banned role.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/ROLEREQUIREMENT ADD

DESCRIPTION

Add a required role to enter this queue. Players can join if they have any of
the roles.

USAGE: /ROLEREQUIREMENT ADD [ROLE]

ARGUMENTS:

role: (Required) Enter the required role.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/ROLEREQUIREMENT REMOVE

DESCRIPTION

Removed a required role to enter this queue.

USAGE: /ROLEREQUIREMENT REMOVE [ROLE]

ARGUMENTS:

role: (Required) Enter the required role.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


RESULTS CHANNEL


/RESULTSCHANNEL

DESCRIPTION

Sets the channel to post match results.

USAGE: /RESULTSCHANNEL [CHANNEL]

ARGUMENTS:

channel: (Required) Enter the desired channel.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


ROLES


/ROLES

DESCRIPTION

(Default: None) Sets the roles for this queue, or omit to remove all.

USAGE: /ROLES (ROLES) (REQUIRED)

ARGUMENTS:

roles: (Optional) Enter the roles in the form Role,Role,Role,etc.
required: (Optional) If roles are required to be chosen and enforced.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


SCHEDULE


/SCHEDULE CANCELSETUP

DESCRIPTION

(BETA) Cancels your currently active schedule setup.

USAGE: /SCHEDULE CANCELSETUP

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SCHEDULE DELETE

DESCRIPTION

(BETA) Delete a previously scheduled command.

USAGE: /SCHEDULE DELETE [SCHEDULED_COMMAND]

ARGUMENTS:

scheduled_command: (Required) The scheduled command to remove.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SCHEDULE REPEAT

DESCRIPTION

(BETA) Toggle if the scheduled command should repeat each time daily.

USAGE: /SCHEDULE REPEAT [SCHEDULED_COMMAND] (REPEAT)

ARGUMENTS:

scheduled_command: (Required) -.
repeat: (Optional) If times should repeat after execution.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SCHEDULE SETUP

DESCRIPTION

(BETA) Start scheduling the execution of any NeatQueue command.

USAGE: /SCHEDULE SETUP

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SCHEDULE TIME ADD

DESCRIPTION

(BETA) Specify an execution time for the scheduled command.

USAGE: /SCHEDULE TIME ADD [SCHEDULED_COMMAND] [TIME] (TIMEZONE)

ARGUMENTS:

scheduled_command: (Required) The scheduled command to add an execution time
for.
time: (Required) Time for the command to be executed.
timezone: (Optional) (Default: /timezone) Respective timezone for the inputted
time.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SCHEDULE TIME LIST

DESCRIPTION

(BETA) List the scheduled times for the command.

USAGE: /SCHEDULE TIME LIST [SCHEDULED_COMMAND]

ARGUMENTS:

scheduled_command: (Required) The scheduled command to list execution times.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SCHEDULE TIME REMOVE

DESCRIPTION

(BETA) Remove an execution time for the scheduled command.

USAGE: /SCHEDULE TIME REMOVE [SCHEDULED_COMMAND] [TIME]

ARGUMENTS:

scheduled_command: (Required) The scheduled command to remove an execution time
for.
time: (Required) Time for the command to be executed.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


SELECT WINNER


/OUTCOME CANCEL

DESCRIPTION

Cancel the given game.

USAGE: /OUTCOME CANCEL [MATCH_NUMBER]

ARGUMENTS:

match_number: (Required) The match number.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/OUTCOME SELECTWINNER

DESCRIPTION

Sets the winner for the given game.

USAGE: /OUTCOME SELECTWINNER [MATCH_NUMBER] [TEAM_NUM]

ARGUMENTS:

match_number: (Required) The match number.
team_num: (Required) The team that won.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/OUTCOME TIE

DESCRIPTION

Mark the given game as a tie.

USAGE: /OUTCOME TIE [MATCH_NUMBER]

ARGUMENTS:

match_number: (Required) The match number.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


SERVER STATS


/SERVERSTATS CHANNELNAMES GAMES

DESCRIPTION

Show how many games have been played by renaming the specified channel.

USAGE: /SERVERSTATS CHANNELNAMES GAMES (CHANNEL) (FORMAT)

ARGUMENTS:

channel: (Optional) Channel to rename, or omit to remove.
format: (Optional) Format for channel name. Indicate a $ for the replacement.
Ex: "Games: $".

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SERVERSTATS CHANNELNAMES INGAME

DESCRIPTION

Show how many players are in game by renaming the specified channel.

USAGE: /SERVERSTATS CHANNELNAMES INGAME (CHANNEL) (FORMAT)

ARGUMENTS:

channel: (Optional) Channel to rename, or omit to remove.
format: (Optional) Format for channel name. Indicate a $ for the replacement.
Ex: "In Game: $".

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SERVERSTATS CHANNELNAMES INQUEUE

DESCRIPTION

Show how many players are in queue by renaming the specified channel.

USAGE: /SERVERSTATS CHANNELNAMES INQUEUE (CHANNEL) (FORMAT)

ARGUMENTS:

channel: (Optional) Channel to rename, or omit to remove.
format: (Optional) Format for channel name. Indicate a $ for the replacement.
Ex: "In Queue: $".

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SERVERSTATS CHANNELNAMES PLAYERS

DESCRIPTION

Show the total number of players by renaming the specified channel.

USAGE: /SERVERSTATS CHANNELNAMES PLAYERS (CHANNEL) (FORMAT)

ARGUMENTS:

channel: (Optional) Channel to rename, or omit to remove.
format: (Optional) Format for channel name. Indicate a $ for the replacement.
Ex: "Players: $".

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SERVERSTATS CHANNELNAMES USERS

DESCRIPTION

Show how many users are in the server by renaming the specified channel.

USAGE: /SERVERSTATS CHANNELNAMES USERS (CHANNEL) (FORMAT)

ARGUMENTS:

channel: (Optional) Channel to rename, or omit to remove.
format: (Optional) Format for channel name. Indicate a $ for the replacement.
Ex: "Users: $".

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SERVERSTATS INFO

DESCRIPTION

View all queue names in the server.

USAGE: /SERVERSTATS INFO (HIDDEN)

ARGUMENTS:

hidden: (Optional) If you want the stats to be hidden.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


SETUP


/SETUP

DESCRIPTION

Starts the interactive setup.

USAGE: /SETUP

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


SHOW MMR IN NAME


/RATINGINNAME FORMAT

DESCRIPTION

(Default: '- ($)') Sets the format for ratings in nicknames.

USAGE: /RATINGINNAME FORMAT [FORMAT] [LOCATION]

ARGUMENTS:

format: (Required) How the rating should be formatted. A '$' indicates the
player's rating.
location: (Required) -.
    Options: Prefix, Suffix

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/RATINGINNAME QUEUENAMES

DESCRIPTION

Sets the queue names to use in retrieving player stats, or omit to reset.

USAGE: /RATINGINNAME QUEUENAMES (NAMES)

ARGUMENTS:

names: (Optional) The queue names separated by ',' to use for inserting ratings
into '$' indicators in the format.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/RATINGINNAME REMOVEALLNICKNAMES

DESCRIPTION

Removes all nicknames from all members.

USAGE: /RATINGINNAME REMOVEALLNICKNAMES

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/RATINGINNAME TOGGLE

DESCRIPTION

Enable or disable showing player MMR in their nickname.

USAGE: /RATINGINNAME TOGGLE [TOGGLE]

ARGUMENTS:

toggle: (Required) If ratings should be shown in name.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


SIMULATE


/SIMULATE

DESCRIPTION

Simulate the MMR distribution for the current configuration.

USAGE: /SIMULATE (PLAYERS) (MATCHES)

ARGUMENTS:

players: (Optional) The number of players to simulate.
matches: (Optional) The number of matches to simulate.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


SPECTATOR ROLE


/SPECTATORROLE ADD

DESCRIPTION

Specify a spectator role which can join any voice channel.

USAGE: /SPECTATORROLE ADD [ROLE] (CAN_SPEAK)

ARGUMENTS:

role: (Required) Spectator role.
can_speak: (Optional) Can this role speak in the channel?.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/SPECTATORROLE REMOVE

DESCRIPTION

Remove's a spectator role.

USAGE: /SPECTATORROLE REMOVE [ROLE]

ARGUMENTS:

role: (Required) Spectator role.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


STAFF


/STAFFROLE ADD

DESCRIPTION

Add a staff role that grants access to commands.

USAGE: /STAFFROLE ADD [ROLE] [TEMPLATE]

ARGUMENTS:

role: (Required) Staff role.
template: (Required) If the role gets access to all commands or not.
    Options: User Commands Only, All Commands

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/STAFFROLE COMMAND ALLOW

DESCRIPTION

Grants the staff role access to the given command.

USAGE: /STAFFROLE COMMAND ALLOW [ROLE] [COMMAND]

ARGUMENTS:

role: (Required) Staff role.
command: (Required) The command to grant access to.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/STAFFROLE COMMAND DENY

DESCRIPTION

Removes the staff role's access to the given command.

USAGE: /STAFFROLE COMMAND DENY [ROLE] [COMMAND]

ARGUMENTS:

role: (Required) Staff role.
command: (Required) The command to remove access from.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/STAFFROLE LIST

DESCRIPTION

List all configured staff roles.

USAGE: /STAFFROLE LIST

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/STAFFROLE REMOVE

DESCRIPTION

Remove a staff role.

USAGE: /STAFFROLE REMOVE [ROLE]

ARGUMENTS:

role: (Required) Staff role.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/STAFFROLE RESET

DESCRIPTION

Resets the staff role to starting permissions.

USAGE: /STAFFROLE RESET [ROLE]

ARGUMENTS:

role: (Required) Staff role.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


START FROM VOICE CHANNEL


/STARTFROMVC

DESCRIPTION

Creates a queue using all players in the given channel.

USAGE: /STARTFROMVC [VOICE_CHANNEL]

ARGUMENTS:

voice_channel: (Required) The voice channel to start a queue from.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


START QUEUE


/STARTQUEUE

DESCRIPTION

Starts a queue for the current channel.

USAGE: /STARTQUEUE [QUEUENAME] [TEAMSIZE] (NUMBEROFTEAMS)

ARGUMENTS:

queuename: (Required) Name for the queue.
teamsize: (Required) Team size.
numberofteams: (Optional) Number of teams in a match.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


STARTING MMR


/STARTINGMMR REMOVE

DESCRIPTION

Removes the starting mmr for the given role.

USAGE: /STARTINGMMR REMOVE [ROLE]

ARGUMENTS:

role: (Required) The role to remove starting MMR from.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/STARTINGMMR SET

DESCRIPTION

Sets the starting mmr for the given role.

USAGE: /STARTINGMMR SET [MMR] (ROLE)

ARGUMENTS:

mmr: (Required) The starting mmr value.
role: (Optional) The role.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


STATS CONFIG


/STATSCONFIG HIDESTATS

DESCRIPTION

Sets whether stats are forced to be hidden (only shown to the user).

USAGE: /STATSCONFIG HIDESTATS [TOGGLE]

ARGUMENTS:

toggle: (Required) If you want the stats to be always hidden.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/STATSCONFIG RANKUPAUTOROLE

DESCRIPTION

Sets what autorole criteria is used for displaying rank ups in /stats.

USAGE: /STATSCONFIG RANKUPAUTOROLE [AUTOROLE]

ARGUMENTS:

autorole: (Required) (Default: MMR) Which autorole to use.
    Options: MMR, Points, Wins, Losses, Games, Streak, Winrate, MVPs

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


TEAM CREATION


/TEAMSELECTION RESHUFFLE

DESCRIPTION

Sets whether players can reshuffle teams in random team selection.

USAGE: /TEAMSELECTION RESHUFFLE [TOGGLE]

ARGUMENTS:

toggle: (Required) Whether reshuffling is enabled or disabled.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/TEAMSELECTION SET

DESCRIPTION

Choose how teams will be picked.

USAGE: /TEAMSELECTION SET

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


TEAM NAMES


/TEAMNAMES CAPTAINS

DESCRIPTION

If team names should be the captains names, if applicable.

USAGE: /TEAMNAMES CAPTAINS [TOGGLE]

ARGUMENTS:

toggle: (Required) Toggle team names being the captain's names.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/TEAMNAMES SET

DESCRIPTION

Specify the names of each team, or omit for the default behavior..

USAGE: /TEAMNAMES SET (TEAM_NAMES)

ARGUMENTS:

team_names: (Optional) Comma separated list of team names. Ex: Team 1,Team 2,...

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


TEAM SIZE


/TEAMSIZE

DESCRIPTION

Sets the size for each team.

USAGE: /TEAMSIZE [SIZE]

ARGUMENTS:

size: (Required) The team size.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


TEMPORARY SETUP CHANNELS


/TEMPCHANNELS NAME

DESCRIPTION

(Default: queue-$) Naming format for temporary setup channels.

USAGE: /TEMPCHANNELS NAME [NAME_FORMAT]

ARGUMENTS:

name_format: (Required) Channel format, where $ will be replaced with the match
number.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/TEMPCHANNELS PERMISSIONS SET

DESCRIPTION

Specify a permission to set for a role when creating the temporary channel.

USAGE: /TEMPCHANNELS PERMISSIONS SET [ROLE] [PERMISSION] [VALUE]

ARGUMENTS:

role: (Required) Role to modify permissions for.
permission: (Required) Permission name.
value: (Required) Permission value.
    Options: Deny, Allow, Default

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/TEMPCHANNELS TOGGLE

DESCRIPTION

(Default: Enabled) Sets whether to create a temporary text channel for setup.

USAGE: /TEMPCHANNELS TOGGLE [MODE]

ARGUMENTS:

mode: (Required) If the temporary setup channels are enabled.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/TEMPCHANNELS TYPE

DESCRIPTION

(Default: Text Channels) Specify if the temp channels are threads or normal
channels.

USAGE: /TEMPCHANNELS TYPE [TYPE]

ARGUMENTS:

type: (Required) If the new channels should be text channels, or threads of this
channel.
    Options: Text Channels, Threads

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


TEST


/TEST

DESCRIPTION

Enables testing mode which allows for duplicate queue joining.

USAGE: /TEST

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


TIES


/TIES

DESCRIPTION

Sets whether tieing is an option for game outcomes.

USAGE: /TIES [TOGGLE]

ARGUMENTS:

toggle: (Required) Whether to show the tie option.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


TIMERS


/TIMER AFK

DESCRIPTION

Toggle kicking players for inactivity.

USAGE: /TIMER AFK [TOGGLE] (TIMER)

ARGUMENTS:

toggle: (Required) Toggle.
timer: (Optional) Enter the AFK timer in seconds (Default: 3600).

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/TIMER MATCHCLEANUP

DESCRIPTION

(Default: 5400) Sets the timeout before a running game is finished.

USAGE: /TIMER MATCHCLEANUP [SECONDS]

ARGUMENTS:

seconds: (Required) Enter the time in SECONDS.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/TIMER QUEUEMESSAGE

DESCRIPTION

(Default: 3) Sets the delay for when a new queue message comes up.

USAGE: /TIMER QUEUEMESSAGE [SECONDS]

ARGUMENTS:

seconds: (Required) New message delay.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/TIMER QUEUERESET

DESCRIPTION

(Default: 3600) Sets the time before the queue is reset.

USAGE: /TIMER QUEUERESET [SECONDS]

ARGUMENTS:

seconds: (Required) Enter the time in SECONDS.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/TIMER VOTES

DESCRIPTION

(Default: 60) Sets the timeout for voting menus.

USAGE: /TIMER VOTES [SECONDS]

ARGUMENTS:

seconds: (Required) -.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/TIMER WINNERVOTEMESSAGE

DESCRIPTION

(Default: 0) Sets the delay before enabling the winner voting message.

USAGE: /TIMER WINNERVOTEMESSAGE [SECONDS]

ARGUMENTS:

seconds: (Required) Enter the time in SECONDS.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


TIMEZONE


/TIMEZONE

DESCRIPTION

(Default: 'US/Eastern') Sets the server's timezone.

USAGE: /TIMEZONE [TIMEZONE]

ARGUMENTS:

timezone: (Required) Server's timezone.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


TOURNAMENTS


/TOURNAMENT ACCOUNT

DESCRIPTION

Link your server to challonge using your username and api key.

USAGE: /TOURNAMENT ACCOUNT [CHALLONGE_USERNAME] [CHALLONGE_API_KEY]

ARGUMENTS:

challonge_username: (Required) Challonge username.
challonge_api_key: (Required) Challonge API Key from
https://challonge.com/settings/developer.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/TOURNAMENT CONFIG AUTOCREATEMATCHES

DESCRIPTION

(BETA) Toggle automatically creating new matches when ready.

USAGE: /TOURNAMENT CONFIG AUTOCREATEMATCHES [MODE] (TOURNAMENT_URL)

ARGUMENTS:

mode: (Required) Toggle automatically creating matches.
    Options: Enabled, Disabled
tournament_url: (Optional) Tournament to edit.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/TOURNAMENT CONFIG AUTOCREATENEWTOURNAMENT

DESCRIPTION

(BETA) Toggle automatically creating new tournaments.

USAGE: /TOURNAMENT CONFIG AUTOCREATENEWTOURNAMENT [MODE] (TOURNAMENT_URL)

ARGUMENTS:

mode: (Required) Change if new tournaments are automatically created.
    Options: On Start, On Completion, Never
tournament_url: (Optional) Tournament to edit.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/TOURNAMENT CONFIG AUTOSTARTONFILL

DESCRIPTION

(BETA) Toggle automatically starting the tournament when filled.

USAGE: /TOURNAMENT CONFIG AUTOSTARTONFILL [MODE] (TOURNAMENT_URL)

ARGUMENTS:

mode: (Required) Toggle automatically starting on fill.
    Options: Enabled, Disabled
tournament_url: (Optional) Tournament to edit.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/TOURNAMENT CONFIG DETAILS

DESCRIPTION

(BETA) Change the tournament details shown in the queue message.

USAGE: /TOURNAMENT CONFIG DETAILS (DETAILS) (TOURNAMENT_URL)

ARGUMENTS:

details: (Optional) Tournament details, or omit to remove.
tournament_url: (Optional) Tournament to edit.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/TOURNAMENT CREATE

DESCRIPTION

(BETA) Create a new tournament and shows signup buttons.

USAGE: /TOURNAMENT CREATE [MAXIMUM_PARTICIPANTS] (TOURNAMENT_TYPE)
(AUTO_START_ON_FILL) (AUTO_CREATE_MATCHES) (AUTO_CREATE_NEW_TOURNAMENT)
(TEAM_SIZE) (NAME) (URL) (DETAILS) (FORFEIT_TIMER_SEC)

ARGUMENTS:

maximum_participants: (Required) Maximum number of teams that can register.
tournament_type: (Optional) (Default: Single Elimination) Tournament type.
    Options: single_elimination, double_elimination, round_robin, swiss
auto_start_on_fill: (Optional) (Default: True) Automatically start the
tournament when the participant capacity is hit.
auto_create_matches: (Optional) (Default: True) If the bot should automatically
create matches when ready.
auto_create_new_tournament: (Optional) (Default: On Completion) Automatically
create a new tournament when this one starts/ends?.
    Options: On Start, On Completion, Never
team_size: (Optional) Number of players on each team.
name: (Optional) The tournament name, also the name of the queue/stats storage
for determining seeding.
url: (Optional) Challonge tournament URL, or omit to auto generate.
details: (Optional) Any extra details to show in the queue message.
forfeit_timer_sec: (Optional) How longer players have to join the match (in
seconds) before forfeiting.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/TOURNAMENT DELETE

DESCRIPTION

(BETA) Deletes the tournament.

USAGE: /TOURNAMENT DELETE (TOURNAMENT_URL)

ARGUMENTS:

tournament_url: (Optional) Tournament to delete.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/TOURNAMENT REFRESH

DESCRIPTION

(BETA) Refresh necessary data from challonge and start any required matches.

USAGE: /TOURNAMENT REFRESH (TOURNAMENT_URL)

ARGUMENTS:

tournament_url: (Optional) Tournament to refresh.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/TOURNAMENT START

DESCRIPTION

(BETA) Start the tournament.

USAGE: /TOURNAMENT START (TOURNAMENT_URL)

ARGUMENTS:

tournament_url: (Optional) Tournament to start.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/TOURNAMENT STARTMATCHES

DESCRIPTION

(BETA) Starts the next set of ready matches.

USAGE: /TOURNAMENT STARTMATCHES (TOURNAMENT_URL)

ARGUMENTS:

tournament_url: (Optional) Tournament to start matches for.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


VOICE CHANNEL MODE


/VOICECHANNELS MOVETEAM

DESCRIPTION

(Default: After All Setup) Sets when to move players to team voice channels.

USAGE: /VOICECHANNELS MOVETEAM [WHEN]

ARGUMENTS:

when: (Required) When to move players to team channels.
    Options: After All Setup, After Teams Created

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/VOICECHANNELS PERMISSIONS SET

DESCRIPTION

Specify a permission to set for a role when creating voice channels.

USAGE: /VOICECHANNELS PERMISSIONS SET [ROLE] [PERMISSION] [VALUE]

ARGUMENTS:

role: (Required) Role to modify permissions for.
permission: (Required) Permission name.
value: (Required) Permission value.
    Options: Deny, Allow, Default

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/VOICECHANNELS TEAMCHANNELS

DESCRIPTION

(Default: Enabled) Toggle creating separate voice channels for each team.

USAGE: /VOICECHANNELS TEAMCHANNELS [TOGGLE]

ARGUMENTS:

toggle: (Required) If channels are created per team.
    Options: Enabled, Disabled

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


VOTING MENU


/VOTINGMENU ADD

DESCRIPTION

Add a new voting menu.

USAGE: /VOTINGMENU ADD [TITLE] [OPTIONS] [KEY] [TEAM_VOTING] (ORDER)
(BUTTON_COLORS) (SHOW_NUMBERS) (ALLOW_RANDOM) (FORCE_RANDOM) (NUMBER_OF_VOTES)

ARGUMENTS:

title: (Required) (Ex: Vote for the Region) The title for the vote.
options: (Required) (Ex: NA,EU) Comma separated list of options. Ignored if
options_variable exists with values.
key: (Required) (Ex: Region Name) The key for this vote for displaying the
result after.
team_voting: (Required) Is the vote once per team, once for all teams, or for a
specific team?.
order: (Optional) (Ex: 1) The order for this vote in regard to other votes.
Votes will occur in ascending order.
button_colors: (Optional) (Ex: blurple,red) Comma separated list of button
colors. Valid options: blurple, gray, green, red.
show_numbers: (Optional) If each option should have a number associated with it
when displayed.
allow_random: (Optional) If a 'random' option is included in the vote.
force_random: (Optional) If you want to skip the vote altogether and just pick a
random option.
number_of_votes: (Optional) Number of votes per player.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/VOTINGMENU REMOVE

DESCRIPTION

Remove the given voting menu.

USAGE: /VOTINGMENU REMOVE [TITLE_AND_ORDER]

ARGUMENTS:

title_and_order: (Required) Title and corresponding order of voting menu to
delete.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


WEBHOOKS

> Webhooks receive information about a match as it is being setup. Currently
> supported actions are:
> 
>  * MATCH_STARTED
>  * TEAMS_CREATED
>  * MATCH_COMPLETED
> 
> Additionally, if you have /requireregister mode: Custom API, you will receive
> a webhook with action
> 
>  * REGISTER_PLAYER
> 
> containing various information about the user, as well as the account they are
> attempting to register. You must either reply with a json object containing at
> least a "rating" key (ex: {"rating": 1000}), to specify the rating that the
> player should be registered with, or any non 200 status response to display to
> the user.
> 
> Examples:
> https://webhook.site/#!/695c599b-fc6d-4a23-aaee-ce170e355fb3/7051d907-b47b-4b05-acc8-96464fa6c565/1


/WEBHOOKS ADD

DESCRIPTION

Add a new webhook to receive queue information.

USAGE: /WEBHOOKS ADD [URL]

ARGUMENTS:

url: (Required) Your webhook url.

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/WEBHOOKS DELETE

DESCRIPTION

Delete this queue's webhook.

USAGE: /WEBHOOKS DELETE

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


/WEBHOOKS GENERATETOKEN

DESCRIPTION

Generate an API token for your account.

USAGE: /WEBHOOKS GENERATETOKEN

USAGE PERMISSIONS: STAFF ROLE OR MANAGE CHANNELS PERMISSION

--------------------------------------------------------------------------------


API


BASE URL: HTTPS://API.NEATQUEUE.COM/


GENERATE AN API TOKEN


VIEW ENDPOINTS