Dorothy's Raffle Bot

Short Description:

Run a simple raffle for a single prize or up to 5 levels of 5 prizes each over multiple shows

Full Description

Welcome to Dorothy's Raffle Bot! This bot is available to everyone for public use.
Current Version: 1.1 (updated 12/20/2019). Change Log of fixes and enhancements in each release is at the bottom of the page. Please follow me on twitter @thechelsea2950 for app and bot updates.

Note: While the source is kept open for the reasons noted below, which makes it easy to copy and modify for individual cammers (which is perfectly fine), please keep in mind that by doing so you'll miss out on fixes and new features that are added to the public bot. If you have a recommendation for something you would like added, please let me know and if it makes sense, I'll put it in the public bot so you can continue to take advantage of the latest version.

I've also created a Twitter DM group for users of the Apps and Bots I've written, please message me on twitter and let me know if you'd like to be added to the group. In that group you'll receive notifications on new features, get tips and tricks, be able to provide feedback on them and request enhancements, and take part in discussions on how they can best be used. I've also created a Discord server, please let me know if you'd like an invite there as well.
And check out my bio for other useful tips and general info about CB and broadcasting, great for new cammers! https://camscaster.com/chelsea2950/

Summary

The Raffle feature allows viewers to tip a specified amount to buy a raffle ticket at one of up to 5 levels. If using the raffle, the prize list should be defined when starting the bot. You can specify a single prize at each level (or only one level), or a list of prizes that are all available for drawing at that level.
Some examples:
--- If doing a raffle for a single prize, just list that prize description in the Level 1 Prize 1 value, and assign a Level 1 ticket price for each raffle ticket to be bought for drawing a winner of that prize.
--- If doing a raffle for multiple prizes, but you want the ticket price to be different for each, put one prize in each of the up to 5 levels, and assign a ticket price for each level. This may be done to have more expensive tickets for more valuable prizes.
--- If doing a raffle for multiple prizes, and more than one prize is available at each ticket price level, enter each prize in one of the 5 fields under the desire level. When the drawing is performed, a winner will be assigned for each prize. If you list multiple prizes in one field as a list, they will all be awarded to a single winner in the drawing

Tickets are 'used' when a winner is drawn - winning tickets are removed from the pool of available tickets if there are multiple drawings. If there are more prizes than there are entries within a given level, the drawing will only assign as many prizes as there are tickets sold.

There are four modes that can be used to define the length of the raffle, and then separate control for whether the actual drawing is performed automatically or by the broadcaster triggering it with a command. The mode can also be changed during the show using the /chgrafflemode command (see below).
--- Broadcaster's discretion - There is no pre-defined length of the raffle, tickets are sold until the broadcaster decides to perform the drawing. This would commonly be used if selling tickets over multiple days and a set date in the future has been decided for the raffle drawing.
--- Timer - Tickets will be sold within the current show while a timer is running and then the drawing performed at the end of the time. The default timer length is defined on the start page but time can be added or removed during the countdown. The drawing can be automatic, or the broadcaster can trigger the drawing with the /raffledrawing command per the setup.
--- Ticket Goal - The drawing will be performed when a total number of tickets threshold is met. The drawing can be automatic (a 2 minute countdown is started when the goal is hit), or the broadcaster can trigger the drawing with the /raffledrawing command per the setup.
--- Token Goal - The drawing will be performed when a total number of tips threshold is met (only includes raffle ticket purchases). The drawing can be automatic (a 2 minute countdown is started when the goal is hit), or the broadcaster can trigger the drawing with the /raffledrawing command per the setup.

In addition to defining the mode and automatic/manual drawing, you can also define if there is a single drawing or continous goal reset with a drawing at the end of each cycle. For example, you could set it to perform a drawing every hour, and start a new one hour countdown each time. If doing a continuous drawing show, there is a setting for whether the pool of tickets bought should be cleared after each drawing, or kept intact and ticket holders have a chance to win in multiple drawings (preferred).

*** If doing a raffle over multiple shows, be sure to save the ticket list before ending the show or the bot! The list cannot be saved permanently within the show, so you must use the "/entries" command to display the current list, copy the list, save it externally, and paste it back into the raffle ticket list field when next launching the fembot. Completely replace the previous list each time. You can also end the fembot and paste the results and restart the bot at the end of the show, but I would still save the list externally as CB sometimes clears bot memories. Note that each ticket purchase is an indvidual entry in the list, so one user may have multiple entries.

Commands

1. /raffle [on/off]: (mods/bc only) Toggle the setting for whether the Raffle Feature is "on" or "off". Overrides the initial setting, and allows you to turn the Raffle on or off during the show. Note that turning the raffle off will suspend the display of the notice, and tips will no longer buy a ticket, however, the ticket purchase history is kept until the fembot is restarted.


2. /entries (or /raffletickets, or /raffleentries): (mods/bc only) Display the list of raffle ticket entries in a format that can be pasted directly into the bot launch page "previous show" raffle list. As noted above, this must be done to track ticket purchases between shows, or restarts of the fembot.


3. /previousentries : (mods/bc only) Display the same list of previous ticket purchases that was specified when launching the bot, mainly for informational purposes if there is a question of what was bought in previous shows vs the current total list.


4. /resetraffle (or /clearraffle): (bc only) Delete all raffle ticket purchase history and start a new raffle with the existing settings. Obviously be careful using this command as you will lose all outstanding tickets. It will display a list of ticket holders in the chat for the broadcaster in case this is done by mistake, the list could be put back in.


5. /addraffletkt1 [numberoftickets] [user] (/addraffletkt2, /addraffletkt3, /addraffletkt4, /addraffletkt5) : (bc only) Manually add a number of tickets for the specified user to the ticket purchase level imbedded in the command. The synatx would be "/addraffletkt2 5 john" to give user name "john" 5 tickets for the level 2 drawing.


6. /rmvraffletkt [level] [user]: (bc only) Manually remove a user from the specified ticket purchase level. The synatx would be "/rmvraffle 2 john" to remove user name john's ticket for the level 2 drawing. Note that it will only remove the first occurrence of that user's ticket for that level, the command must be executed multiple times if they have multiple tickets.


7. /raffleprizes: (all users) Display the available prizes in the Raffle, by level, only shown to the user that requests it.


8. /setraffleprice [level] [newprice]: (mods/bc only) Change the price of the specified [level] raffle tickets, setting it to a value of [newprice]. Note this can also be used when adding a price to a level that was not previously set. In order to add prizes to a level, there must first be a price set.


9. /raffledrawing: (bc, mods when configured) Perform the raffle drawing when not set to Automatic Drawing mode. The parameter value should be "all" to perform the drawing for all levels, or a specific level number. For example "/raffledrawing all" or "/raffledrawing 1". When the drawing is performed, the winners from each level will be chosen and displayed in the chat. Note that the winner history is not tracked, so you must distribute the prizes or make note of the winners as they are shown in the chat. If continuous mode is selected, the goals are reset and the next cycle is started, which may clear the ticket pool if configured to do so in continuous mode.


10. /rafflestarttimer (or /startraffletimer) [time]: (mods/bc only) Start a [time] minute timer for the raffle drawing when in 'timer' mode with the drawing to be triggered by the /raffledrawing command. The timer will count down but not automatically perform the drawing (unless set to automatic mode but the auto-timer was ended, and this is a restart of that timer)


11. /raffleaddtime (or /addraffletime) [time]: (mods/bc only) Add [time] minutes to the timer for either automatic or manual drawing mode. The [time] value can be a negative number to subtract time, but cannot be greater than the remaining time.


12. /rafflestoptimer (or /stopraffletimer): (mods/bc only) Stop the raffle timer for either automatic or manual drawing mode.


13. /raffletimeleft : (mods/bc only) Display the time left on the raffle timer for either automatic or manual drawing mode.


14. /chgrafflemode [manual/timer/ticketgoal/tokengoal]: (mods/bc only) Switch between the modes being used to determine when to perform the raffle drawing. If switching from a timer show to a non-timer show, the timer will be ended. Ticket count and Tip Count are being tracked regardless of mode, so switching to a 'goal' mode should not require starting progress at 0.


15. /addraffleprize [level] [prize]: (mods/bc only) Add a raffle prize to the specified [level] (1-5) with a description of [prize]. Note this does not validate the existing entries in the list, so you can add the same prize to the list multiple times if you want to give it away multiple times as a prize in the same drawing.


16. /rmvraffleprize [level] [prize]: (mods/bc only) Remove the specified raffle [prize] from the specified [level] (1-5), the text must match the existing prize exactly (case and punctuation). Note this will remove all occurrences of the the prize in the list that have the same name.

12/20/2019 Version 1.1:
- Updated command for adding tickets to allow for adding multiple tickets at once. Instead of /addraffletkt [level] [user], there are now commands for each level: /addraffletkt1 [number of tickets] [user]... and /addraffletkt2, /addraffletkt3, etc

12/1/2019 Version 1.0:
- Bot Created
- Replacement for Raffle feature in Dorothy's Ultra Fembot
- Added feature for setup of up to 5 individual prizes in each level rather than making a list
- Also added feature to allow for completion of Prize Levels one at a time under the "Single Drawing" mode, and validations duplicate prices, entries missing price or prize
- If you had a multi-show raffle in progress in the Fembot, the same results can be pasted into this separate bot to continue your raffle and perform the drawing

Other Bots and Apps by chelsea2950
Link for Easy Fembot: Dorothy's Easy Fembot - Simpler ultrabot for newer cammers with minimal config, most features related to chat control.
Link for Ultra Fembot: Dorothy's Ultra Fembot - All in One ultrabot with everything I could think to add
Link for UltraApp: Dorothy's UltraApp - All in One app that contains several different types of goal shows (single goal, multiple goals, auto-reset goals, goal counter, goal race, tip sequence, tip jar), plus a full feature ticket show and peep show
Link for Dice game: Dorothy's Dice Game - Roll 2 6-sided dice to win prizes, plus a rare special roll of '13'. Note this same version of the game is also already built in to the Ultra Fembot.
Link for Ticket Show App: Dorothy's Ticket Show - Same as the ticket show portion of this App - Sell tickets and then lock the room for a private show.
Link for Easy Ticket Show: Dorothy's Easy Ticket Show - Same features as the stand alone ticket show, but with a very short launch page setup (4 settings), all other settings use most common defaults.
Link for Tip Goals App: Dorothy's Tip Goals - Run a goal show with either a single goal or multiple progressive goals. Same as the goal feature of the Ultra App in its own separate App. Like the UltraApp, the Tip Goals App also has customizable draw panel backgrounds.
Link for Gamebot: Dorothy's Ultra Gamebot - Includes Dice, Wheelspin, Keno, War! (High Card), Russian Roulette, Press Your Luck, Random Prizes, Charades, and Bad Libs, all with a common prize list that can be used across all the games so you don't have to keep setting up prizes in different bots
Link for Tip Menu Pro: Dorothy's Tip Menu Pro - Ultimate Tip Menu with 2 menus that can be swapped based on type of show (Menu 1 with 50 slots, Menu 2 with 20), plus a positions menu that can be run simultaneously