twitch-sm4shbot

A Twitch bot for Smash 4 streamers.

Feedback & Support

If you need help adding Sm4shbot to your stream or want to submit feedback or a bug report, here is how you can reach us:

• File support issues in the support repo.
• Make a post in the sm4shbot subreddit.
• Tweet at @sm4shbot
• Email us at [email protected].

Contributing

Sm4shbot is an open source project! If you know how to code, feel free to make a PR or create an issue for any ideas/code bugs.

Setup

Simply make twitch-sm4shbot a moderator of your stream. Then login with your twitch account to Sm4shBot.com which provides a graphical dashboard to manage your stream.

Chat Commands

Here's how to interact with the bot inside your chat.

Protip: Many commands have Aliases that might be quicker to type or easier to remember.

Keyword

The kewyord to trigger bot commands is !sm4sh. E.g.:

<zssrocks> !sm4sh on
<twitch_sm4shbot> @zssrocks, Sm4shBot has been activated. Happy sm4shing!

Aliases: !smash

Challenger (Public)

The following commands can be used by anyone in the chat.

enter <NNID> <In-Game Name>

Enters you into the challenger list.

<rosaluma> !sm4sh enter popOff22 Danny

Aliases: join, register

leave

Drops you from the challenger list.

<rosaluma> !sm4sh leave

Aliases: lv, drop

list

Shows the list of challengers. This command only works once every 30 seconds to prevent spamming.

<rosaluma> !sm4sh list

Aliases: ls

Admin

These commands can only be run by trusted admins. The streamer is always a trusted admin.

on

Activates Sm4shbot in your chat. No commands will work until activation.

<zssrocks> !sm4sh on

Aliases: activate

off

Deactivates Sm4shbot in your chat. No commands afterward will work.

<zssrocks> !sm4sh off

Aliases: deactivate

open [subscriber only]

Opens the challenger list for entries.

<zssrocks> !sm4sh open

If you add true, subs, or subscribers, the list will only be open for subscribers.

<zssrocks> !sm4sh open true
<zssrocks> !sm4sh open subs
<zssrocks> !sm4sh open subscribers

To switch back to both subs and viewers, just send open with nothing else.

<zssrocks> !sm4sh open

close

Closes the challenger list for entries. Admins are still able to manually add challengers with the add command.

<zssrocks> !sm4sh close

add <Twitch Username> <NNID> <In-Game Name>

Manually adds a challenger to the end of the list. This command can be used even if the list is closed or full.

<zssrocks> !sm4sh add rosaluma popOff22 Danny

remove <Twitch Username>

Manually removes a challenger from the list.

<zssrocks> !sm4sh remove rosaluma

Aliases: rm

next

Shows details about the next challenger. This does not move to the next match.

<zssrocks> !sm4sh next

start

Starts the next match in the list. It also notifies the challenger on-deck to start getting ready.

<zssrocks> !sm4sh start

Aliases: s

win

Registers a game win for the streamer. If the game was a set winner, everyone is notified and the match is ended. To start the next match, you must send the start command.

<zssrocks> !sm4sh win

Aliases: w

loss

Registers a game loss for the streamer. If the game was a set winner, everyone is notified and the match is ended. To start the next match, you must send the start command.

<zssrocks> !sm4sh loss

Aliases: l

forfeit

Register a match forfeit. Does not count as a loss or a win for the streamer. To start the next match, you must send the start command.

<zssrocks> !sm4sh forfeit

Aliases: ff

set <option> <value>

Sets a value for an option. These will not be applied to matches that are currently in progress.

<zssrocks> !sm4sh set firstTo 5

Here's what you can set:

limit <number of challengers>

Sets the max size the challenger list can grow to. Admins are allowed to surpass this limit. The default is 20 challengers.

firstTo <number of games>

Sets the number of games a challenger or the streamer must win to take the set. The default is 3 for viewers and 5 for subs. This will overwrite the first to criteria for both viewers and subs.

Aliases: firstto, first

firstToViewer <number of games>

Sets the number of games a viewer or the streamer must win to take the set. The default is 2 (best of 3).

Aliases: firsttoviewer, firstviewer, firstviewer, fv

firstToSub <number of games>

Sets the number of games a sub or the streamer must win to take the set. The default is 3 (best of 5).

Aliases: firsttosub, firstSub, firstsub, fs

License

Copyright (c) 2015 Alexander Martin

MIT (http://www.opensource.org/licenses/mit-license.php)