RandomRewarderBot

Short Description:

It's like 3 Wheels of Fortune and a Tip Menu in one Bot

Full Description

The Random Rewarder Bot gives out random rewards for tips. It is build as a Bot to run parallel to any other Game/App you want to run.

There are up to three different Wheels of Fortune, Minor/Medium/Major, with a different tip cost for each and almost unlimited number of rewards per wheel (as of Version 1.3). Additionally you can enable a 'Choose from List' prize on each wheel.

And you can have a list of almost unlimited number of direct rewards (as of Version 1.3) given for a specific cost, like a tip menu.

The RandomRewarder Bot is inspired by SweetDann's original Wheel Of Fortune, thanks to her!

##### Version History #####

• Version 1.4: 2017-1015-23
  • A list of the last rewards won has been added, that can be viewed by the chat command /lrw


• Version 1.3: 2017-05-21
  • Virtually unlimited Rewards per List, as you can put more than one reward in a slot
  • Easier change of lists between shows through same mechanic
  • Added Option to show one list when advertizing
  • List & Notification colors made changeable
  • Added some Separators
  • Minor cosmetic changes


• Version 1.2: 2016-05-07
  • Added commands for Broadcaster & Mods to change costs for the reward lists without restarting the RandomRewarder
  • Added Option to deactivate a populated Reward List by setting the cost to zero (for Broadcaster & Mods)
  • Added Option and commands to de-/activate the Direct Reward List for Broadcaster & Mods
  • Minor cosmetic changes


• Version 1.1: 2015-10-12
  • Added different separators for Reward Lists
  • Added Group Tipping Option
  • Added Group Tipping commands for Broadcaster & Mods
  • Minor cosmetic changes


• Version 1.0: 2015-09-27
  
  • Three Wheels of Fortune and a Tip Menu

##### Configuration #####

The RandomRewarder is fully preset with values for a female model and usable out of the box. Of course you can change every value to customize it to your needs
As I noticed some have copied the RandomRewarder just to change the colors used for list and advertizing, I made those changable now (new as of Version 1.3)

• The Bot gives basic instructions about its use on Startup, to a user with tokens entering the room and every so often, determined by the first setting in minutes. If you dont want adverizing just set it to a high number like 300 (that would advertize every 5 hrs)


• "Show one List when advertising" controls, if automatically one list will be shown, when the bot advertises itself. The lists rotate, so every time another list is shown. Default is Yes (new as of Version 1.3)


• With the "List-Seperator"-Choice you determine, if the items in the rewards list are seperated by a line break (default), a hyphen ( - ), a vertical bar ( | ), hearts or stars (new as of Version 1.1), plus glittering hearts, beating hearts, flowers and kisses (new as of Version 1.3).
  Every separator other than a line break will make the list single line, saving space in chat.


• "How many Rewards shall be recorded:" determines, how long the list of won Rewards can be.
  This function is for busy times, where new rewards get tipped for while you still give out a reward.
  The chat command /lrw for "Last Rewards Won" shows a list of last rewards won, from last one to first, so you can see what happened while you were busy, without scrolling up in the chat.
  Minimum is 5, maximum is 30, with the last 10 rewards being the default.
  Any User can use the chat command, only he sees the list. If the broadcaster or a mod gives the chat command all user see the list(new as of Version 1.4)


• You can choose, if you want to allow Group Tipping on one of the lists.
  Default is 'No', choosable is one list. If one list is chosen, little tips add up until they exceed the cost for the choosen list of rewards. Then a prize from that list is rewarded and the group tip jar is reset to zero. (new as of Version 1.1)
  To en-/disable group tipping at runtime without restarting the bot the chat commands /gtoff /gtmin /gtmed /gtmaj have been added.
  This option is introduced to not let small tips go to waste and works especially well with OhMiBod or Lovense shows. But it is also a way to give a reward to a big tip exceeding the cost of the choosen list, but not exactly hitting the tip costs for one of the lists or direct rewards exactly.
  Big tips exceeding the lists cost are rewarded as if the tipper has tipped for that list and don't fill the group tip jar.
  Direct rewards are given before this and also don't fill the group tip jar.


• The next two textboxes define the font- & background-color of adverts in HTML/RGB colorcode. They are predefined with white as fontcolor and dark purple as background (new as of Version 1.3)


• Every section of Rewards starts with a Token Cost for that specific rewards list. The Costs of the 3 lists AND the Direct Rewards MUST be different (or zero), or the Bot may crash!
  Setting a lists cost to zero disables the entire list, even if populated. This can also be done without restarting the bot by a chat command (see there, /scmin /scmed /scmaj)((new as of Version 1.2)


• Every reward can be changed, to match your preferences. Leaving a reward blank will shorten the list and making the rest of prizes more likely to be chosen. Leaving all rewards of a list empty disables this list.


• From now on (new as of Version 1.3) you can put more than one reward into one reward slot! To do so just write them all together in the slot, limited by a ';' (a semicolon). In fact you can write ALL rewards for one wheel into ONE SLOT! At least as long as the whole list is shorter than 255 characters ;)
  This change has three effects:
  • You can put as much rewards per wheel as fit in 2500 characters! Thats a LOT of rewards! No more decisions, what has to go when you have a new toy
  • The second usefull effect is that you can change all your rewards fast and easy between shows (when you put all your rewards into one or two slots).Wanna do a theme show? Prepare the new lists in advance (like 'Reward 1; Reward 2; ...') and change them with a copy paste. No more tedious changing the lists slot by slot!
  • You can influence the chances of a given reward by adding it multiple times. The more often you add it, the more likely it will be drawn


• Per definition the Random Reward Lists know no blanks. Every turn of the wheel is a WIN!
  If you WANT blanks in your rewards, you can define something marginal like 'A KISS and a SMILE!' or say explicitly something like 'Thanks for playing, but no cigar! Try again and better luck next time!'
  Be creative!


• Every list has the option of a 'Choose' Reward. By default this option is disabled.('NO')
  To enable it, choose a set of Lists to choose from. This can be a single list (e.g. 'Minor) or a combination of lists up to all ('Minor-Medium-Major')
  If this option is enabled there is a chance, that the reward is, to chose one reward from one of the specified Lists. The lists choosen should be enabled, i.e. have at least one reward active to avoid undefined results


• The chance to get a 'Choose Reward' is is defined as 1 in xx (e.g. 1/10 is 10%, 1/50 is 2%). If 'Choose from Lists' is enabled, this is evaluated first


• At the end of each rewards list is a textbox defining the fontcolor (in HTML/RGB colorcode) of the list when the list gets shown. It is predefined with the old values, ie blue for minor, green for medium, gold for major and dark purple for direct rewards.(new as of Version 1.3)


• Direct rewards are the Tip Menu. Every Reward has a fixed Token Cost to it and is rewarded when this exact amount is tipped in a single tip


• All Direct Reward Costs must be unique and different from the Tip Costs of ther enabled lists or unexpected results may occur


• Now you can put more than one Direct Reward into into a slot(new as of Version 1.3)! Similar to the normal rewards you can put a whole list of Direct Rewards (up to 255 characters) separated by ; into the list. To designate them a unique reward cost you put the token cost separated by a double colon after the reward. It should look like this:
  Direct Reward 1:10;Direct Reward 2:20;Direct Reward 3:30;...
  If you do so the Direct Reward Cost for that slot is ignored as you designate the costs in the slot itself. All other rules for Direct rewards still apply


• With 'Direct Reward List Active' you can deactivate the whole Tip Menu of Direct Rewards. Default value is active = Yes. To toggle the tip menu in-/active at runtime without restart there are the chat commands /dron & /droff (new as of Version 1.2)

##### Use & Commands #####

• As a Bot RandomRewarder can not change the Title/Goal of your room. It would be nice and useful if you would add the tag '#randomrewarder' to the subject of your room / your main App


• If you only use one list it works similar to SweetDann's Wheel Of Fortune. You must use the minor rewards list in this case.
  


• If you only want to use 2 lists I recommend Minor and Major list, leaving the Medium list empty or deactivated.
  


• Using all three lists and the Direct Rewards gives you three Wheels of fortune and the Tip Menu
  


• Configure the rewards lists as described above and start Bot


• There is a set of commands to announce the content of the rewards list. If a normal user uses them, only he gets to see the results, if a Mod or the broadcaster uses them, all Guests see them.
  
  • /rrhelp Shows the List of Commands
  • /lsr Shows the content of the Minor (small) Reward List
  • /lmr Shows the content of the Medium Reward List
  • /llr Shows the content of the Major (large) Reward List
  • /ldr Shows the content and Tip Costs of the Direct Reward List
  • /lar Shows the content of all enabled Reward Lists
  • /lrw Shows the list of the last Rewards won, from last to first


• The following chat commands are for Broadcaster and Mods only and control the behavior of the RandomRewarder at runtime:
  
  • /gtoff Disables Group Tipping
  • /gtmin Enables Group Tipping on Minor Rewards
  • /gtmed Enables Group Tipping on Medium Rewards
  • /gtmaj Enables Group Tipping on Major Rewards
  • /scmin nn Set Cost for Minor Rewards to nn token. '/scmin 0' deactivates List!
  • /scmed nn Set Cost for Medium Rewards to nn token. '/scmed 0' deactivates List!
  • /scmaj nn Set Cost for Minor Rewards to nn token. '/scmaj 0' deactivates List!
  • /dron Activates the Direct Rewards!
  • /droff Deactivates the Direct Rewards!

If there are any questions left, errors found, suggestions to be made or feedback to be given please use the comments here to let me know! I will check here regularly.