Skip to content

Latest commit

 

History

History
83 lines (61 loc) · 4.23 KB

README.md

File metadata and controls

83 lines (61 loc) · 4.23 KB

Mustard Mine

"Mustard Mine" banner

Mustard Mine handles Twitch chat and some other functionality. The name harkens back to a conversation between Alice Liddell and the Duchess in the famous book Alice's Adventures in Wonderland; the motto of this bot is: "The more work there is of mine, the less there is of yours".

The source code for this bot is available under the terms of the MIT License and can be found on GitHub. Installing and running your own instance of the bot is possible and legal, though may take some effort. (The bot software is named StilleBot after Oberstille, because he joked around with me about names right at the time when I needed to figure out a name. (On such thin threads...) The actual running bot is the Mustard Mine. The names can be used broadly interchangeably.)

The reference bot is operated by Rosuav and is accessible at https://mustardmine.com/ where he serves a number of Twitch channels.

What can the Mustard Mine do for you?

Running a channel

When Mustard Mine is the primary bot for a Twitch channel, a number of features are available.

  • Classic information/response commands, including shoutouts, automated commands (timers), quotes, etc, etc.
  • A full-power command editor to allow the streamer and mods to edit these commands
  • Twitch alerts (eg when someone follows, subs, cheers, etc)
  • Goal bars of various kinds
  • Giveaway management
  • Channel point redemptions, including dynamic management of the rewards themselves
  • Art sharing with upload capability

Mustard Mine is perfectly happy to coexist with other bots, and if he is working in a secondary role, features can be enabled on an "as-needed" basis, with the bot quietly lurking until called upon.

Details on a number of standard commands can be found in these pages.

To see what the bot would be like if working for you, explore Demo Mode where the bot pretends that you are a mod for a (fake) channel named "!Demo".

See What's Happening

Even for people and channels where the Mustard Mine is not an active bot, some services are available! Some of these require authentication.

  • Emote showcase for any Twitch channel. Shows off your emotes, nice and large, and can also let you see them in greyscale.
  • Raid Finder to help you pick out a raid target, or just to check your follow list in a more useful way
  • Hype Train tracker to see where the train is up to, exactly what it'll take to finish the current level, and how long the cooldown is. Requires permission from the broadcaster.

Other tools

A few tools don't really connect with any specific channel, and can be used by anyone.

Can I haz?

Yes! The bot is available for any streamer to make use of!

To activate the bot in your channel, here's the place to be. Once activated, the bot will remain active until the broadcaster requests its removal (in the Master Control Panel), and all of its features will be available from the channel configuration pages.

More information

To contact the author/maintainer/operator or ask further questions, reach out to Rosuav on Twitch, or join the Discord.