Role Queues
In a role queue, each player joins as an in-game role, such as Tank, DPS or Support. A match only starts when every role on every team is filled.
These roles are names you choose. They are not Discord roles.
Set up roles
Run /roles with a comma-separated list. Each name is one slot on every team, so repeat a name to give a team more than one of that role:
/roles roles:Tank,DPS,DPS,Support,Support
This gives every team 1 Tank, 2 DPS and 2 Support.
| Option | Default | What it does |
|---|---|---|
roles | None | The slots on each team. Leave it out to remove all roles |
required | On | Players must pick a role, and teams are built from the slots |
waiting_room | Enabled | Players can still pick a role that is full and wait for a spot |
Setting or removing roles removes everyone who is currently queued (entry fees are refunded). With required on, the team size is also changed to the number of slots you listed, 5 in the example above.
Running /roles with no options turns roles off. If you only pass waiting_room, just the waiting room changes and the queue is left alone.
Required or optional
- Required (the default): every player must have a role, and a match only starts when all the slots on all teams are filled.
- Optional (
required: False): the list is only a set of preferences that players can choose with/role. There is no role picker, teams are not built around the roles, and the team size is not changed. A required list set earlier stays in place, so run/roleswith no options first to clear it.
Picking a role
When a player joins a required-role queue, NeatQueue shows them a Select A Role message with a button for each role and how many of its spots are taken. They are added to the queue once they pick one.
Players can skip the picker by saving a preferred role with /role. It is saved for the whole server and used in any queue where it is one of the roles. If that role is full and the waiting room is off, they get the picker instead. Run /role with no role to remove it. Staff can set a player's role for them with /player role set.
How many players each role takes
A role takes its number of slots on each team, times the number of teams (and lobbies). With the example above and 2 teams, the queue takes 2 Tanks, 4 DPS and 4 Supports. The queue message shows each role's count, such as DPS 3/4.
Waiting room
With the waiting room on, players can still pick a full role. They wait in the queue and are counted as +N next to the role. When a match starts, anyone who wasn't picked for it stays in the queue for the next one.
Run /roles waiting_room: Disabled to turn it off. Full roles are then greyed out in the picker, so players have to pick a role with a free spot.
Banning a player from a role
/player role ban stops a player from picking a role in every queue on the server that uses that role name. The role is hidden from their picker. Lift it with /player role unban.
Parties in role queues
Each party member sets the role they play in that party with /party selectrole. The role is saved on the party, not per queue, so it is used in every queue the party joins.
The role is not checked when it is set. When the party joins a queue with required roles, each member's role must exactly match one of the queue's role names, including capital letters, or the party can't join. In queues with optional roles, party roles are ignored. See Parties.
Not the same as /rolelimit
/rolelimit set is a different feature. It caps how many players with a Discord role can be in the queue at once, and has nothing to do with the roles set with /roles.