Twordle

Twordle is a chat game for Twitch, Streamer.bot and OBS by Auzathoth, coming soon. If you’d like to play it before then, check out the schedule, usually posted on Bluesky or join the Discord to get alerts when he’s live.

When a game is running, chatters can guess a word randomly picked from a list of 5-letter words.

Each incorrect guess shows the letters that are in the word but in the wrong place (shown with a yellow background) and those that are in the correct place. A keyboard shows the status of each letter so people should know what letters are still in play.

There can be six incorrect guesses before the word is revealed and chat has failed.

The user who correctly guesses the word within the six guesses will be showered with praise^§.

Requirements

Twordle is designed to be used in a Twitch stream, and needs both Streamer.bot and OBS. The OBS scene is designed around the Minecrafter font, available at Dafont.

Additionally, the scene makes use of the shaderfilter plugin for OBS. To import the scene, the Source Copy plugin is recommended.

Installation

1. Download the json file for the Twordle scene, and import it via Source Copy
   • Optionally, you can search and replace the font name “Minecrafter” with another font. This may cause some alignment issues however
2. Decide which of your existing scenes you want to be able to play Twordle on, add the Twordle scene as a source to all of them, and align it on the scenes as you want
   • There are two types of scenarios Twordle works with: Normal and Restart.
     • Normal scenes will only show the Twordle game on request, and remove it when the game is finished
     • Restart scenes will show the game when switched to, and restart the game when it is complete
   • Any scene switches will continue games in play, and honour the new scene as to whether to stop or restart
   • If a game is started, and no-one makes a guess within 2 minutes, the game will be stopped
3. Add five persistant global variables to store:
   • twordleWordFile – the full location of the file with your possible words. No file is supplied, you’ll have to make your own. It should have each word on it’s own line, and all words should be 5 letters. You can add words to this file with the !addtwordle command as well. example “X:\Files\twordle.txt”
   • twordleRemoveFile – if you grab a big list of words you may find you don’t want some of them for whatever reason. The !removetwordle command will let you keep a record of words you want to remove later (as we can’t edit the main word file easily). example “X:\Files\remove.txt”
   • twordleNormalScenes – this is a comma separated list of your “Normal” scenes. For example, “Main,Chatting” or just a single scene “Main”.
   • twordleRestartScenes – as above, but for “Restart” scenes, eg “BRB,Problems”
   • twordleSaveLocation – when the word is guessed correctly, a screenshot is made of the result, and this will saved to this location named with the timestamp and the user who guessed the word. To disable this feature (which has no further use at this point) set this to “None”. example: “X:\TwordleGrabs” (note: no trailing slash)
4. Add two Groups (if you already have a bots group, change “My Bots” in the “Twordle Message” action
   • My Bots – holds bots, which should be ignored for submitting words
   • playedTwordle – this is a list used to track whole played a game, to count them
5. Import the Twordle.sb code into Streamer.bot
   • By default there is a trigger for a channel point redemption called “Twordle!”. If you don’t want to have one, or can’t, disable this action. Otherwise, make sure your redemption has the same name, or change it in Streamer.bot. The redeem will have to be created through Streamer.bot as it is paused when the game is being played.
   • The !twordle command is set to the broadcaster and mods only.
6. Test it all works (should work fine offline)

Commands

!twordle	Start a game. By default limited to mods and above
!addtwordle <WORD>	Adds a word to the word list, though it won’t be in play until Streamer.bot is restarted. Only 5-letter words are accepted
!removetwordle <WORD>	Add the word to the “remove me later” file
!resetwordle	If things have gone awry, this will reset the game
!howtoplay	Shows basic instructions
!mystats	For a user, shows their play stats in chat
!clearstats <username>	Resets a user’s stats

Stats

The following stats are recorded for anyone who plays:

• How many games they’ve guessed a word in
• How many correct words they’ve guessed, and how many times they gave the wrong one on guess six
• How many words they’ve guessed in total, how many of those got at least one letter right, and how many times they got at least one letter right in the right spot
• Their earliest correct guess, and how many times they got it right on the last chance

Future Ideas?

Ignore words already used.

Configure channel point redemption name.

Standings – stats are currently stored per chatter, which makes it difficult to get all-time numbers, and Streamer.bot doesn’t seem to offer the sort of database backend that would make it easy to collate them. Possibly it could be done through pushing the stats to a central site.

Downloading results – the screenshot function can save the (good) games, but I think it would need to upload them somewhere for chatters to then download them.

_{§ praise not guaranteed}