Skip to content

Latest commit

 

History

History
50 lines (39 loc) · 1.73 KB

README.md

File metadata and controls

50 lines (39 loc) · 1.73 KB

Twitch queue bot

Quickstart

Note: All commands are case insensitive.

User commands

  • !join -> Join the queue
    • The queue must be open to be able to join it
    • You can optionally set your player name by providing it after the space, same as !name
  • !name -> show/set player name (in-game name)
    • Names are saved so they don't need to be specified during subsequent joins
    • Names are saved per queue as users may have multiple names in multiple games
  • !leave -> Leave the queue
  • !position -> Display current queue position
  • !length -> Display number of people in queue

Mod commands

  • !next -> Advance the queue by one and displays the new head of the queue
    • This will add the player to the player history which will make them unable to join again until a reset
    • If the player name is set for that user it will be displayed in brackets next to the username
  • !list -> List the first 5 people in queue
  • !clear -> Clear the queue
  • !open -> Open the current queue for signups
  • !close -> Close the current queue
  • !reset -> Reset the player history
    • This will not clear the queue
  • !create name -> Create a new queue with the rest of the message as its name
    • if the queue already exists this will overwrite it with a new one
  • !select name -> Select the queue with a specific name (case insensitive)
    • queue must exist, use !create beforehand
    • only one queue may be selected at a time
  • !save -> Save the queue to disk in it's current state
    • This won't close the queue!
    • The queues are persisted automatically unless the bot crashes or is forcibly killed.

Features

  • Queue management
  • Persistence
  • Player history
  • Guaranteed order of message processing

Hosting

Limitation

  • Single channel operation