Short Description:

Reward Bot 0.1.0 - reward tokens with little cute stars

Full Description

This bot was created by cmaldo for teddiex3 but can be used (with little less teddie-specific functionality) by any other host too.

Main functionality of the bot are some stars that appear at the left side of the chat for every user that tipped a certain amount of tokens, they have a specific order, different amounts of overall tipping reveal different colored stars.



Because chaturbate doesn't provide functionality for saving data by a bot, the internal database which holds the tips for the users need to be copied by the host for the next session by issuing a /rsave command in the chat and preserving the result somewhere (for example in an text editor) so that it could be feed into the database-field in the launch dialog on the next start of the bot.



Launch Dialog:

are moderators allowed to save the database via the /rsave command to help you not losing the db: pretty self-explainatory... by default only the host is allowed to save the database. You may set a password so that noone can spy into your bot-database ;)



custom prefix for the star-pictures (default is rrwrdbot): pictures (like the small stars) have a name in chaturbate. If you want to make your own stars, you have to upload the pictures with a common name-prefix, an underscore and a number. stars begin with number zero; the number grows to the length of the tokenlist you provide in the next entry. example: with the prefix "myownstar" the picture named myownstar_0 is the very first own star of yours you have to upload (be sure you replace every star that could appear)



list of tokens where you want your own stars should appear: a list of numbers in raising order where you want your stars to appear. the default list is a teddiex3 secret ;)



how much stars should be secret and do not appear in the /rstar command: pretty much self explaining...



should the bot convert skype-emoticons to pictures?: cmaldo thought it would be convenient for users to write smileys in the way they could in skype and that text would get converted in actual pictures... not every shortkey is implemented for the lack of similar pictures in skype... (skype emoticons)



password for the database: the database which is exposed to the host and maybe to moderators with the /rsave command can contain a password - to load the database on the start of the bot you should provide the password here. You can later change the password in the chat via the /rchangedbpasswd command (dont make a typo, the bot hides only commands from the users that he knows of)



words or part of words that should be censored. regex allowed: rewardbot replaces a few curse-words with a censored-picture. if you want to make your own list you can provide it here, seperate your entrys with a comma. you can use some regex here, but because of chaturbate-api (javascript) limits - dont use brackets, escaped commas, or lookbehind/lookahead logic (regex)



minutes until the bot give you a hint about saving the database via the /rsave command: self explainatory ... if the bot crashes all your updates to the database are gone, so you or some moderator may save regularly...



compressed database-string, revealed with /rsave command for persistent tipper-data: this is the field where you have to insert the string that resulted from a /rsave command in the chat. it contains the data how much your users did tip to you, so the bot knows what star they should get...

Usage:




if a user tips tokens, he will get stars if the overall amount of tokens he tipped when the bot was running with this particular database reaches some point in the internal star-list. a user can "donate" tokens for some other user by typing "stars for <exact username of another user in the chatroom>". By doing that the other user get the stars he would receive if he tipped this amount of tokens the original user donated for him.



when you about to run the bot, it not only provides stars, it accepts some commands too...

You and your users can use the /rhelp command (with some different results).



Notice: -- Reward Bot commandlist: --

Notice: /rhelp - this help

Notice: /rload [dbtext] - load the database on the fly...

Notice: /rlist [namepart] - list tipping info for one or more users

Notice: /ruadd <name> - attach info to one user

Notice: /ruinfo [namepart] - list attached info for one or more users

Notice: /rudel [nr] <user> - delete all or a specific info for one user

Notice: /rchangedbpasswd [password] - remove or changes the database password

Notice: /rsave - get the setting string for the database

Notice: /rstar - list of most of the stars

Notice: -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#

/rload <databasetext>

you could load a previous database with /rload <databasetext> while the bot is running - but - because of chaturbate limitations the database have to be very small, this grows very fast out of perspective. use the database-field in the launch-dialog instead.



/rlist <optional: username>

with that command you could see how much a user tipped. you could also use nameparts instead of using the complete name...



/ruadd <name> <text>

that command attaches text to someone in your database. things you dont want to forget or something you want to do in the future perhaps?



/ruinfo <username>

with that command you could see information you attached to the user. you could also use nameparts instead of using the complete name...



/rudel <optional: rownumber of the information> <username>

use that command to delete some or any information attached to that user from your database...



/rchangedbpasswd <optional: password>

change the password of the database. the next /rsave commands will use it to protect it. dont forget to change the password-field in the launch-dialog on the next start...



/rsave

this command saves the database. copy the result int the chat to your text-editor and use it next time for the start of the bot. it contains the tipping-data of all of your tippers...



/rstar

this command shows all the public stars your users can get...



/me

get augenkrebs ;)




Love:

There are many many weeks of work in this bot - chaturbate isn't exactly the most bugfree platform that exists. if you find bugs or if you have nice ideas or want to provide your love, come and visit one of teddiex3 shows and talk to us.

Have a great life.

- cmaldo