PotatoBot User Manual English
PotatoBot Release Notes
Welcome | Tokens | Theta Event Messages | Basic Commands |
Command/Bot Permissions | Timer Based Messages | User Queue System
Message List Management | Advanced Commands | Polls | MiniGames
EULA | Support | Comments
(Clicking on shortcuts you will be redirected to google document)
Welcome To PotatoBot!
Thank you for choosing to use PotatoBot, the first app in the Theta.TV App Store and growing still with currently over 500 users. This bot comes standard with a default Follow and Donation Message. To remove them on install type: /removefollowmsg and /removedonationmsg in your chat.
All commands can be done “hidden” by using ! instead of / in the command. This can be used to keep all the setup commands hidden from others/keep your chat clean for the viewers. All commands are entered either from your Theta.TV streamer user dashboard or your channel chat. PotatoBot has access to all emotes the streamer can use on Theta.TV.
Visit the PotatoBot Support Discord to easily see how to set up such commands as: Shout Outs (to give props to fellow streamers), Magic 8 Ball, Uptime, and much more. If you would like to help participate in the translations please let us know! We are still looking for the Quick Start and Potato Bot Commands in Spanish and any additional languages. If you know anyone who is unable to use Discord, please share this document with them, but make sure to save it as a link and not a Word Doc so when it changes, you get the update!
To see all commands that have been setup use /commands.
To see all timers use /listtimers.
Latest Updates: (2020.12.29)
War - only one game at a time, max 5 rounds; GuessTheNumber - provide status/info
GuessTheNumber - provide 3 clues using “/guessthenumber clue” <= streamer only
Hello Messages customizable for mods and subs
Raids - set messages and added tokens (you raiding others and others raiding you)
Multi Language Support (French, German, Polish, and Serbian)
Timers - ListTimers shows timerName and interval in (#),
Timers - Anti-Clumping - will use online start time + timer time to fire 1st time
Lists - showallcontents gives numbers/details while showall will show all items
Text Token and Variables for Commands
User Queue - Option to pull a random person from the queue added
User Queue - Added ability to clear queue instead of having delete/recreate
Admin - Disallow public commands, reset and pause are now added bot tools
Donation Messages Based on Amount and new Message Token
A few minor bug fixes and small enhancements.
Note on TOKENS:
A limited but expanding set of tokens can be used inside commands, the tokens are:
{Bot.Alias} <-- bot alias
{Streamer.Username} <-- streamer's username
{Streamer.Uptime} <-- streamer uptime reported by Theta
{Streamer.Followers} <-- provides current number of followers
{Streamer.Viewers} <-- provide current number of stream viewers
{Sender.Username} <-- donor/chattor/event issuer's username
{Target.Username} <-- Target of emote's username
{Amount} <-- tfuel amount (available on tfuel based actions)
{Message} <-- dono msg with a dono (available on tfuel based actions)
{Level} <-- only available on level up messages
{Text} <-- will pass everything after the command name as variable
** {Text} explained down below under Advanced Commands
THETA Event Messages
Theta Events are reponses/changes the bot can make for an event/option on Theta.TV.
Rename your channel bots name using the /alias command.
Example: /alias YourMom Results: PotatoBot is now called YourMom.
Test theta events without having to have the action occur. Use “/test eventName”.
Example: /test followmsg Example: /test hellomsg Example: /test donationmsg
/followmsg msg
Sets the message to output when an user follows your stream
Example: /followmsg Hello and thanks for the follow!
Example: /followmsg @{Sender.Username}, thanks for the follow!
/hellomsg msg
Sets the message to output when an user does the stupid hello hand wave thing
Example: /hellomsg Hello and thanks for the wave!
Example: /hellomsg Hello @{Sender.Username}, thanks for the wave!
/hellomsgsub msg
/hellomsgmod msg
Custom hellos. If the user is both a sub and mod, the mod message is returned.
/donationmsg msg
Sets the message to output when an user donates
Example: /donationmsg @{Sender.Username} gave{Amount} and said {Message}!
/submsg msg
Sets the message to output on either a sub or gifted sub:
Example: /submsg Wow @{Target.Username} thank you for the sub!
/levelupmsg msg
Sets the message to output when an user levels up:
Example: /levelupmsg Hey @{Sender.Username} welcome to level {Level}
/removefollowmsg
/removedonationmsg
/removehellomsg
/removesubmsg
/removelevelupmsg
Basic COMMANDS
/add commandName msg
Adds/Updates a command.
Example: /add toxic TenthReality is toxic
Usage: /toxic Usage: !toxic Output: PotatoBot: TenthReality is toxic
Example: /add toxic @{Sender.Username} is toxic
Usage: /toxic Output: PotatoBot: @UserWhoTypedCommand is toxic.
Example: /add toxic @{Sender.Username} thinks @{Target.Username} is toxic
Usage: /toxic @SKACLE
Output: PotatoBot: @UserWhoTypedCommand thinks @SKACLE is toxic.
/remove commandName
Removes an existing command **must match command name exactly
Example: /remove toxic
/commands
Lists all commands created via the /add command; Streamer and Mod Only
Command/Bot PERMISSIONS
/subonly commandName
/modonly commandName
/streameronly commandName
/minlvl commandName level
set to 0 if you want to re-allow free access
/maxlvl commandName level
set to 100 if you want to re-allow free access
/hiddencommands
Toggle to enable/disable the ability for users to use ! to fire hidden commands.
/publiccommands
Toggle to disable/enable the ability for users to use / commands.Use ! to fire.
/history
See the last 5 commands fired and who fired them.
/togglemodpermissions
Allows ALL Mods access to add/update/remove commands and start games.
Warning: This gives access to add/edit/remove any of your commands.
/pause
Toggle to pause/unpause the bot (no chat/timers/events will appear until unpaused).
/resetbot yourUserName
Will 100% reset the bot and remove all commands, timers and event messages.
/setlanguage language
Will allow the bots reponses and minigames to be in the language set.
Possible languages: english, french, german, polish, serbian.
TIMER Based Messages
Timer events will only fire while you are actively online and streaming. If you create new timers while offline use the /test command to verify your timer messages.
/addtimer minutes timerName msg
Adds/Updates an timer based message on the minute interval
Example: /addtimer 10 tacos I love tacos
/enabletimer timerName
/disabletimer timerName
Enables or disables an existing timer by name
/listtimers
Provides a list of all timers setup including the time set.
/changetime timerName #
Allows the changing of time without having to delete/recreate
Example: /changetime tacos 15
/removetimer timerName
Removes a timer with the timerName
Example: /removetimer tacos
User QUEUE System
/adduserqueue commandName responseMessage
Adds or updates an User Queue which responds to command name
Example: /adduserqueue !signup @{Sender.Username} has registered!
Output: User types !signup; Bot responds and adds user to the queue.
/closeuserqueue commandName
User queue stops accepting new users
Example: /closeuserqueue !signup
Output: No further sign ups allowed for !signup
/listuserqueue commandName
Outputs a comma sep list of usernames in queue list
Example: /listuserqueue !signup
Output: Outputs a comma sep list of usernames in queue list
/randomuserqueue commandName
Outputs a random user in the queue.
/clearuserqueue commandName
Will clear userqueue leaving it empty
/removeuserqueue commandName
Removes an User Queue which responds to command name
Example: /removeuserqueue !signup
Output: Queue is removed
Message LIST Management
/list create name
/list add name msg
/list remove name number
/list mode name random <-- toggles between list being called in order or random.
/list prefix name someMsgPrefix
/list suffix name someMsgSuffix
/list showall name
** Will now show the contents of the list with no extra info.
/list showallcontents name
** Will display “Contents of List” Message as well as each item with its number.
Check out “PotatoBot Discord” - “Samples Or Shared Scripts” - “SocialLinksBestPractices” to see this in use for Social Media links on a timer for easy socials management.
Advanced COMMANDS
Variables
/setvar variableName variableValue
Examples:
/setvar IncentCode 1234
/add incent Check out my incent: TEST-{IncentCode}
when /incent is called it will say: Check out my incent: TEST-1234
/setvar IncentCode 5678
when /incent is called it will say: Check out my incent: TEST-5678
/setvar UserName TwistedNattyB
/add twitter Check out my Twitter: https://twitter.com/{UserName}
/add theta Check out my Theta.tv: https://www.theta.tv/{UserName}
when /twitter or /twitch is called it would show with TwistedNattyB
/getvar variableName
Returns value in case you forgot what was set
/removevar variableName
Removes the Variable.
If it was used in a command. the command will show blank for this variable
/listvars
Shows a list of all Variables that have been created
{Text} Token
Example:
/add prizes We are giving away: {Text}
/prizes 1 crate, 1 poro, 15 badges, and 15 cap buffs!!! <3
Output: We are giving away: 1 crate, 1 poro, 15 badges, and 15 cap buffs!!! <3
POLLS
Allows the streamer to set a poll to last a designated time which can be started with commands and will provide results of any viewer who replies “1”, “Yes”, “2”, or “No” during the time frame specified. Bot will output reminders at 45, 30, 15, 10, 5 and 1 minutes left of the poll.
/poll add pollname interval question
Adds a new poll with a time interval and a text question.
Can be removed, started, stopped with further commands.
Questions should be answerable with a Yes/No. All Votes Count
Example: /poll add GFuelPoll 10 Who loves GFuel?
Output: Adds a new poll that when started will last 10 minutes.
Example: /poll start GFuelPoll
Output: Poll is started. After 10 minutes Poll Results are shown.
/poll start name
/poll stop name
/poll remove name
/poll list name
Lists all polls and specifies which ones are active/”started”.
/poll results name
Outputs the results at that time during the poll or even after the poll is stopped.
MINIGAMES
Guess The Number
/guessthenumber optionalNum optionalPrize optionalRestrictions
EACH PARAMETER IS REQUIRED TO USE A LATER ONE.
(must set optionalNum to use optionalPrize )
(must set optionalNum and optionalPrize to use optionalRestrictions)
Bot will immediately output a "start of game" message.
Bot will report the winner when someone gets it right.
optionalNum sets max if single number (ex. 10, will do 1-10) or a range (ex. 5-10)
optionalPrize will list the prize but not hand it over: feel free to get creative.
Can limit WHO can guess: modonly, subonly, minlvl/maxlvl.
Example: /guessthenumber
Outputs: starts a 1-200 guess the number game.
Example: /guessthenumber 100
Example: /guessthenumber 1-100
Outputs: starts a 1-100 guess the number game.
Example: /guessthenumber 100 My Love
Outputs: starts a 1-100 guess the number game where a user will win: My Love.
Example: /guessthenumber 100 My Love subonly
Outputs: starts a 1-100 guess the number game where a sub will win: My Love.
** Only pays attention to replies from Subs.
Example: /guessthenumber 100 My Love minlvl10
Outputs: starts a 1-100 guess the number game where a viewer will win: My Love.
** Only pays attention to replies from viewers lvl 10 and above.
Example: /guessthenumber stop
Outputs: Stops the currently running guess the number and ends the game.
** Displays the number which was selected.
Example: /guessthenumber clue
Outputs: Will give one of three clues about the number:
odd/even, number of digits, and number of unique digits
** Streamer Only
Example: /guessthenumber info
Outputs: Will provide if a guessthenumber game is active.
** Streamer Only
War
/war @Target
War permissions can be changed by using modonly, subonly, minlvl, maxlvl.
Example: /war @tenthreality
Results: Starts a 3 hand game of the card game War
Example: /war @tenthreality 5
Results: Starts a 5 hand game of the card game War; 5 is now max
Example: /modonly war
Results: Mods of the chat can call war.
Example: /minlvl war 1
Results: Anyone in your chat can start a game of war.
Random Number
/rand number
Example: /rand 100
Output: Outputs a random number from 1->100
Example: /rand 500
Output: Outputs a random number from 1->500
Streamer Says
/streamersays # RepeatText
Allows a game to be started where viewers must reproduce “RepeatText” in chat.
Will go until “RepeatText” is repeated # times.
“RepeatText” can be anything - from a sub only emote to any text you would like.
Example: /streamersays 5 <3 I LOVE YOU <3
Output: A game is started. After 5 “<3 I LOVE YOU <3”’s in chat a winner is picked.
EULA
PotatoBot is provided free of charge. The PotatoBot development team assumes no liability or risk related to your use of PotatoBot. The PotatoBot development team reserves the right to restrict your access to the bot at any time for any reason without notice. Users are responsible for any local laws related to their use of PotatoBot.
SUPPORT
If you need support for PotatoBot, please visit The Potato Bot Support Discord:
If you would like to support PotatoBot, please donate/support/tip:
COMMENTS:
Huge thanks to twistednattyb, takeasmoke and SKACLE for the initial development/testing, as well as various Theta.TV staff members for putting up with my annoying questions. Additional thanks to all of the initial Theta streamers that were willing to deal with an occasionally wonky bot. PotatoBot is written/maintained by TenthReality, you can find him on Thetas or PotatoBots discord.
Comments
Post a Comment