A simple viewer queue to allow chatters to join and get picked in order or at random by a mod.
Picking can be done one at a time if no number is selected or in groups by passing an amount to pick.
-
Ensure docker is installed
-
Rename "docker-compose EXAMPLE.yml" to "docker-compose.yml"
-
Add the relevant environment values within this file. To generate the token for a user you can use this site. To find the ID of the Twitch channel you can use this site
-
To build and run the container run the following
docker compose up -d- Join Channel - Join the channel of the user sending the message
- Leave Channel - Leave the channel of the user sending the message
- Queue Info - Return the current information about the queue in the channel.
- Join The Queue - Return the current information about the queue in the channel.
- Leave The Queue - Leave the queue for the current channel.
- Open The Queue - Open the queue for the current channel.
- Close The Queue - Close the queue for the current channel.
- Clear The Queue - Remove all users from the queue for the current channel.
- Queue Length - Return the number of users in the queue for the current channel.
- Queue Level - Return or set the user level for the queue for the current channel.
- Queue List - Return all the users in the queue for the current channel.
- Queue Limit - Set the max users allowed in the queue for the current channel.
- Pick User/'s - Pick one or more users from the queue for the current channel.
- Random Pick User/'s - Pick one or more random users from the queue for the current channel.
- Remove User - Remove a user from the queue for the current channel..
To get the bot to join your channel.
!joinchannel
To get the bot to leave your channel.
!leavechannel
Return the current information about the queue in the channel.
!queue
Join the queue for the current channel.
!join
If the user does not have permission to join the queue they will receive a response stating so.
Leave the queue for the current channel.
!leave
Open the queue for the current channel.
!open
User must be moderator or broadcaster to use this command
Close the queue for the current channel.
!close
User must be moderator or broadcaster to use this command
Remove all users from the queue for the current channel.
!clear
User must be moderator or broadcaster to use this command
Return the number of users in the queue for the current channel.
!length
Return or set the user level for the queue for the current channel.
Parameters:
Moderator use only
userLevel:
- Viewer (v,viewer,0)
- Subscriber (s,subscriber,1)
- VIP (vip,2)
- Moderator(m,moderator,3)
!level (userLevel)
Return all the users in the queue for the current channel. (Limited to 500 characters)
!list
Set the max users allowed in the queue for the current channel.
Parameters:
userLimit: Number (0 for no limit)
!limit (userLimit)
User must be moderator or broadcaster to use this command
Pick one or more users from the queue for the current channel.
Parameters:
pickAmount: Number (If not given only one will be used)
!pick (pickAmount)
User must be moderator or broadcaster to use this command
Pick one or more random users from the queue for the current channel.
Parameters:
pickAmount: Number (If not given only one will be used)
!rand (pickAmount)
User must be moderator or broadcaster to use this command
Remove a user from the queue for the current channel.
Parameters:
userName: Must be the users display name
!remove (userName)
User must be moderator or broadcaster to use this command
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.