Dorothy's Ultra Fembot

Short Description:

Ultrabot includes: Tip Menu, Positions Menu, Token Poll, Lush Menu, PMs, VIP List, External Fan Club List, Blocked words, silence levels, graphics levels, Leaderboard, Nice List, Tip Count Display, User Group Icon by name, 5 rotating notifiers

Full Description

Latest enhancements and fixes:

12/19/2018 Release (1.3) (Current Version):
- Added Social Media contact list. Put all your web links and social media IDs in one place that displays on a recurring basis in the chat. Unfortunately hyperlinks not allowed, but users can copy and paste.
- An update was necessary to change the Token Poll field names in the program, so you'll need to re-input your token poll settings for this release, apologies in advance.
- Updated the colors on the private messaging functions to make them stand out more (/pm, /tm, /tbm, /bc).
- Added an auto-start of the token poll timer when you start a crazyticket show, there's a setting to enable and a setting for the timer length to be used.
- Added ability to pre-define a ninja list so you can silence annoying people ahead of time and they won't receive a notification. With the regular silence list, they receive a notification when they try to chat.
- Added icon for Top 3 Tippers in current session, configurable as a gif or character.
- Fixed some general issues with the timer and token poll timer functions, as they had issues with adding time or subtracting time under a minute.
- Keep alive function now works in the token poll as well - when the poll timer drops below 30 seconds, it'll add 30 seconds the first time anyone votes.
- Added control for automatically ending the positions menu poll at the time of /showend or /stopshow when doing a ticket show.
- Also fixed the /stopclock and /pollstoptimer functions.
- Fixed option to remove token poll entries during the show (/polloptrmv).
- Fixed issue with notifier custom color lookup (would result in error saying the positions menu color was invalid).

12/13/2018 Release (1.2):
- Added Lush Menu. Note that this is a display only, it does not actually control the lush, that is done through the lush app. This feature would be used if you were not using the chrome extension to publish the lush price ranges to the chat, or if you only use the extension to publish the connectivity messages.
- Added commands to add the top tippers from the leaderboard (/addlbtop, /addlbamt).
- Fixed issue with the /addclock, though /stopclock still doesn't work, so continue to add negative time to end the clock.
- Enabled the /pm command for VIP and External Fan Club.
- Added command to display all current notifier messages (/dspmsg [1,2,3,4,5, or all]).
- Enhanced the /prepticket command to have unique controls in the config menu for what options it executes.
- Added section separators on the config menu page to make it easier to find certain sets of settings.
- Added the /dumpsettings command to send all current config settings to the chat to assist with developer troubleshooting.

12/9/2018 Release (1.1):
- Fixed an issue with the custom color settings, you may have to re-enter your colors for the tip menu.
- Added the back-up ticket list feature to allow for saving the ticket list in the event of a CrazyTicket crash.

Summary

I created this bot with all of the functionality of the 'Easy Fembot' with some upgrades for more experienced cammers. The primary reason I started this was to create apps and bots that do not have developer backdoors giving people you don't know access to your show. As you can see, the source for my apps an bots will always be visible, I don't encode it or try to hide the source - it's a good bet when you see that on other bots it's because the developer and their friends and the neighbor's dog special access.
As with the 'Easy' version, I've borrowed some existing features from many places/bots including 18yearold, allinone and ultrabot for most, so I'd like to give credit to those who have gone before for all your hard work (britney and justin, alice and shaggy, lund, acrazyguy, and I'm sure many others).
Special thanks to 4science for the Tip Menu and Token Polls (which were built off work by badbadbubba and NotThatFrank).

Note that I've made 3 copies of the bot, as I expect that people may want to create 2 or 3 versions that they can save for different types of shows.
For example, all of the tip menus and token polls may be different between a couples show, solo show, and shark week show, so by having three separate bots you can configure and save, you don't have to change the setup when you switch between shows, just swap out the bot.
The primary bot is this one, secondary bots are "Dorothy's Ultra Fembot - Show 2" and "Dorothy's Ultra Fembot - Show 3".

One thing to keep in mind with all of the changes you make using the commands within a show are not permanently updated to the configuration page - you have to make those changes there for them to be saved.
This includes things like tip menu changes, positions menu changes, additions to the blocked word list, users added to the external fan club or VIP List, etc.
I recommend keeping all of these lists in a separate notepad document so you can update them as you go, and copy and paste them into the boxes on the setup page when you start a show, especially in case something happens and the configuaration page gets reset.

Main features from the Easy Fembot are:

1. Messaging for mods and broadcasters


2. Private Messages to other users - Send messages to the broadcaster, moderator group, or specific users in the chat so there is no need to switch to a new tab for PMs.


3. Silence Level and Graphic Level - Restrict ability to chat or to post graphics by whether users have tokens or have tipped a certain threshold.


4. Leaderboard - Display a Leaderboard in the chat of top tippers from the current session.


5. Nice List - Maintain a list of users that are allowed to chat when the silence level is increased.


6. Tip Count next to name - Show the user's current tip count totals by their name with each chat message.


7. Silence individual users - Add users to a silence list that prevents them from chatting, advantage of this over regular silencing is that it can easily reversed and sends a note to the user telling them to stop being rude.


8. Silence individual users without notification (ninja) - Ideal for silencing people who have been tipping but still being rude or demanding, they do not receive a notice. Note that neither of these affects tipnotes the way that silencing through CB will.

Added features in this bot:

1. Tip Menu (based on 4sci menu) - Tip Menu function with up to 30 slots. Automatic sort by price. Can be split into two sections if too long. Menu displays on a defined interval and you can set the text and background color.


2. Positions Tip Menu - Similar Tip Menu function with up to 8 slots intended to be used for sex position tipping. Automatic sort by price. Menu displays on a defined interval and you can set the text and background color.


3. Token Poll (based on 4sci Poll) - Use a token poll to have people vote for options such as cumshot location. Has multiple modes to be ended manually by moderator or broadcaster, ended after a timer, or ended based on hitting a target amount. Poll progress displays on a defined interval and you can set the text and background color.


4. VIP List - You can add really good tippers or friends to the VIP list and define which level of access they will have (PMs, ticket show, or both) or don't give any special access but still be announced on entry to the room, and get a badge next to their names in the chat.


5. External FanClub List - Simliar to the VIP list, you can add people who may have bought an external fan club membership to the list and define which level of access they will have (PMs, ticket show, or both) or don't give any special access but still be annuonced on entry to the room, and get a badge next to their names in the chat.


6. Blocked word list - Add words to this list to prevent rude comments in the chat or use pieces of repetitive spam messages from bots to prevent them from being shown.


7. Additional Notifiers (up to 5 rotating) - Display up to 5 messages in the chat on a scheduled interval, and you can define the colors used for the text and background.


8. User Group icons - a defined .gif is displayed next to a user's name in the chat for the 4 groups (mods, CB fan club, external fan club, VIP list)


9. Ticket prep function - This is used to automate many of the functions you do when you switch to a ticket show during a session, such as disable regular tip menu, enable positions menu, enable token poll, enable backup ticket list, add top tippers to the show, and add VIP and Fanclub users to the show. This should be run afetr crazyticket has been turned on, and by a user with authority to the /add command.


10. Lush Menu - When using a lovense lush, display a menu in the chat for the tip ranges. Note this does not actually control the lush, it is just information published to the chat. Often people will uses the chrome extension to publish the menu directly to the chat and then this feature is not needed in the ultrabot.


11. Convert Messages in all Upper Case to Lower Case so people can't 'yell' in chat.

Commands

Most of these are available for moderators and broadcasters only, with some exceptions.

A. Chat Control

1. /silencelevel [x]: set silence level where x = 0-3
   0 = All users can chat
   1 = Only users with tokens can chat
   2 = Only users who have tipped can chat
   3 = Only users who have tipped 10 tokens can chat


2. /graphiclevel [x]: set graphic level where x = 0-3
   0 = All users can post gifs
   1 = Only users with tokens can post gifs
   2 = Only users who have tipped can post gifs
   3 = Only users who have tipped 10 tokens can post gifs


3. /ninja [user]: silence a user without notification


4. /unninja [user]: remove ninja silence


5. /ninjalist: display the ninja list


6. /silence [user]: silence a user with notification


7. /unsilence [user]: remove from silence list


8. /silencelist: display the silence list

B. Timer Functions

1. /startclock [x]: start a timer for x minutes... timer will display a notice at 15, 10, 5, 4, 3, 2, 1 min and 30 sec remaining


2. /clockadd [x]: add x minutes to the timer


3. /clocktimeleft: display the time left on the timer

C. Private Messaging

1. /pm [user] [msg]: send a message to a specific user


2. /reply [msg]: send reply to someone who has PM'd you


3. /bc [msg]: send a message to the broadcaster


4. /tm [msg]: send a message to the moderator group


5. /tbm [msg]: send a message to the broadcaster and the moderator group

D. Chat Notices

1. /cn [msg]: send a notice to the chat.


2. /cnd [msg]: send a notice to the chat with dashed line separators


3. /cnh [msg]: send a notice to the chat with highlighting


4. /cndh [msg]: send a notice to the chat with dashed line separators and highlighting


5. /chgmsg1 [msg]: update the notifier message in Slot 1 to a value of [msg]


6. /chgmsg2 [msg]: update the notifier message in Slot 2 to a value of [msg]


7. /chgmsg3 [msg]: update the notifier message in Slot 3 to a value of [msg]


8. /chgmsg4 [msg]: update the notifier message in Slot 4 to a value of [msg]


9. /chgmsg5 [msg]: update the notifier message in Slot 5 to a value of [msg]


10. /dspmsg [X]: Display the current value for the message in notifier Slot [X], where [X] can be the integers 1-5 or "all".


11. /usenotifier [on/off]: enable or disable the display of the notifier... however, the recurrence can only be set when activating the bot.

E. Nice List

The nicelist enables users who would otherwise not be allowed to chat due to the silence level setting to still chat.

1. /addnice [user1, user2, etc]: Add a user or list of users to the nice list, separate user names by a comma.


2. /rmvnice [user]: Remove a single user from the nice list (individual names only, does not support removal of a user list).


3. /nicelist: display the nice list

F. Leaders and Tippers

1. /leaders [group]: display the leaderboard on-demand... does not require that the leaderboard be enabled. Displays to [group] from list:
   'mods' - display to moderators
   'tbm' - display to moderators and broadcaster
   'bc' - display to broadcaster
   'all' - display to public chat
   ...defaults to current user if none selected.


2. /useleaderboard [on/off]: toggle the recurring display of the leaderboard on and off, overriding the initial config setting... recurrence from initial config is still used


3. /usetipcount [on/off]: toggle the display of the tip count in front of a user's name on and off, overriding the initial config setting... tips are still counted when off as long as the bot is active


4. /tippers [group] [x]: display a list of the top [x] number of tippers since the bot was activated. Displays to [group] from list:
   'mods' - display to moderators
   'tbm' - display to moderators and broadcaster
   'bc' - display to broadcaster
   'all' - display to public chat
   ...defaults to current user if none selected.

G. Tip Menu

1. /tipmenu: (all users) Display the tip menu in chat, only shown to the user that requests it.


2. /usemenu [on/off]: (mods/bc only) Toggle the setting for whether the Tip Menu is "on" or "off". Overrides the initial setting to turn the Tip Menu on or off during the show.


3. /tipmenurequests: (mods/bc only) Show recent tip menu requests, defaults to a maximum of the 10 most recent when no quantity is entered.


4. /tipmenurequests X: (mods/bc only) Show the last "X" requests.


5. /tipmenurequests all: (mods/bc only) Show all the requests, maximum of 50.


6. /tipmenuadd X Y: (mods/bc only) Add an item name "Y" with a price of "X" tokens to the menu.


7. /tipmenurmv X: (mods/bc only) Removes every item with a price of "X" tokens.


8. /tipmenurmv Y: (mods/bc only) Will removed any item labeled "Y" regardless of price.

H. Positions Tip Menu

1. /posmenu: (all users) Display the tip menu in chat, only shown to the user that requests it.


2. /useposmenu [on/off]: (mods/bc only) Toggle the setting for whether the Positions Tip Menu is "on" or "off". Overrides the initial setting to turn the Positions Tip Menu on or off during the show.


3. /posmenurequests: (mods/bc only) Show recent tip menu requests, defaults to a maximum of the 10 most recent.


4. /posmenuadd X Y: (mods/bc only) Add an item name "Y" with a price of "X" tokens to the positions menu.


5. /posmenurmv X: (mods/bc only) Removes every item from the positions menu with a price of "X" tokens.


6. /posmenurmv Y: (mods/bc only) Will removed any item labeled "Y" regardless of price from the positions menu.

I. Token Poll

The Token Poll is used to allow users to vote on different poll choices to choose an audience selected winner.
Most often this is used for voting on a cumshot location but can be used for any set of choices you want the audience to vote on.
There are two levels of control, enabling the Poll, and whether the poll is running or not. The Poll is enabled if turned on when starting the bot and it is also running by default.
Within the show, the poll can be ended to declare a winner, and is therefore no longer running but poll commands can still be executed, including restarting the poll, and poll messages will still be shown.
The poll can be completely disabled as well, after which no poll commands can be used and no messages will be shown.

1. /poll: (all users) Display the current poll results board in the chat for the requesting user. Displayed to all when requested by moderators.


2. /usepoll [on/off]: (mods/bc only) Toggle the setting for whether the Token Poll is "on" or "off". Overrides the initial setting to turn the Token Poll on or off during the show.


3. /endpoll: (mods/bc only) When running under manual control, end the poll and display the winner.


4. /restartpoll: (mods/bc only) If the poll is accidentally ended, or suspended, it can be restarted using this command.


5. /addvote X Y: (mods/bc only) Add or remove "Y" number of votes to the poll item with a price of "X". If "Y" is not specified, defaults to one vote added or removed. Number can be shown as negative (-2) to remove votes. Moderators have to be enabled to use this command.


6. /polloptadd X Y: (mods/bc only) Add an item named "Y" with a price of "X" tokens to the poll.


7. /polloptrmv Y: (mods/bc only) Will remove any item labeled "Y" from the token poll.


8. /pollstarttimer X: (mods/bc only) Starts a timer for "X" minutes for the poll when run under timed mode. Poll will automatically end when time runs out.


9. /polladdtime X: (mods/bc only) Adds "X" minutes to the poll timer if a timer is running.


10. /pollstoptimer: (mods/bc only) Ends the timer if running under timed mode.


11. /pollleader: (all users) Post the poll leader message to the chat for the requesting user. Displayed to all when requested by moderators.

J. External Fan Club

This allows for setting a list of users that will have special access from purchasing a Fan Club membership on an external site such as FanCentro, etc.
Adding a user to the External Fan Club list gives them a badge icon in the chat, PM ability, and includes them in the export list sent to the ticket show (future feature).
Users can be added and removed within a session, but a master list should be maintained and updated on the bot's configuration page so it is saved (updates made within the session are not permanent).
The list should also be saved externally in case the configuration page is ever reset.

1. /addfan [user]: (bc only) Adds a user to the External Fan Club list where [user] is the person you want to add.


2. /rmvfan: (bc only) Removes a user from the VIP List where [user] is the person you want to remove.
   The syntax for using this command is "/rmvfan [X]", where [X] is the user you want to remove from the External Fan Club list.


3. /fanlist: (mods/bc only) Displays the list of users currently in the External Fan Club list.


4. /exportfan: (mods/bc only) Displays the list of users currently in the External Fan Club list in a format that can easily be repasted in the chat to add users to a ticket show.
   Note that this logic will also be executed using the /prepticket command.
   Also note that exporting the list will add these users to the backup ticket show list as well (tlist).

K. VIP List

This allows for setting a list of users that will have special access though they may not be in the Fan Club (friends and all-time high tippers, etc).
Adding a user to the VIP list gives them a badge icon in the chat, PM ability, and includes them in the export list sent to the ticket show (future feature).
Users can be added and removed within a session, but a master list should be maintained and updated on the bot's configuration page so it is saved (updates made within the session are not permanent).
The list should also be saved externally in case the configuration page is ever reset.

1. /addvip [user]: (bc only) Adds a user to the VIP list where [user] is the person you want to add.


2. /rmvvip: (bc only) Removes a user from the VIP List where [user] is the person you want to remove.


3. /viplist: (mods/bc only) Displays the list of users currently in the VIP list.


4. /exportvip: (mods/bc only) Displays the list of users currently in the VIP list in a format that can easily be repasted in the chat to add users to a ticket show.
   Note that this logic will also be executed using the /prepticket command.
   Also note that exporting the list will add these users to the backup ticket show list as well (tlist).

L. Blocked Word List

This allows for setting a list of words that will cause a user's message to be suppressed if they use one.
Words can be added and removed within a session, but a master list should be maintained and updated on the bot's configuration page so it is saved (updates made within the session are not permanent).
The list should also be saved externally in case the configuration page is ever reset.
Also it only works for single words, not phrases.

1. /addword [word]: (bc only) Adds a word to the Blocked Word list where [word] is the word you want to add.


2. /rmvword: (bc only) Removes a word from the Blocked Word list where [word] is the word you want to remove.


3. /wordlist: (all users) Displays the list of words currently in the Blocked list.

M. Ticket Show Support

There are a few features added to support the use of the CrazyTicket App alongside the ultrabot. Note most of these are specific to crazyticket and not generally for ticket shows.

1. /usetlist [on/off] : (bc/mods only) When the tlist (backup ticket list) is enabled, any tips of the ticket price or greater will add that user to a backup list for the show.
   This allows the ticket holder list to be be saved within the ultrabot in the even the crazyticket app crashes or is ended.
   If this happens, the ticket list can be restored using the commands below.
   The Crazyticket /add commands will also add users to the tlist.
   The VIP and external fan list will also be added to the tlist if they are added to the show through /prepticket or the export commands for each.
   Note that the /prepticket function will automatically enable the tlist if it is not already on.


2. /prepticket: (mods/bc only) Prepare for a ticket show by performing the following actions (note that there is control for each of these actions on the config page so you can turn them on or off individually):
   - disabling the regular Tip Menu if running
   - enabling the Positions Menu if not already enabled
   - enabling the Token Poll if not already enabled
   - performing the export of the VIP List and/or the External Fan Club list to the ticket show if they are used and granted these privileges
   - performing the add of the VIP List and/or the External Fan Club list to the backup ticket list if they are used and granted these privileges
   If the ticket show is running this will add the lists to the show if the user executing them has authority to the /add command in the CrazyTicket app.


3. /add [user]: (bc/mods only) This is actually the CrazyTicket command, if a user is manually added to the ticket show, the same command will also add them to the backup list, they don't need to do a second command.


4. /del [user]: (bc/mods only) This is actually the CrazyTicket command, if a user is manually removed from the ticket show, the same command will also remove them from the backup list, they don't need to do a second command.


5. /ctprice [newamount]: (bc/mods only) This is actually the crazyticket command being executed to manually change the ticket price, and the additional update is made here to also update the price used for the Backup list.
   Users are added to the backup list anytime they tip more than the amount currently defined as the show price, so it needs to be kept up to date as it is changed in Crazyticket.


6. /tlistprice [newamount]: (bc/mods only) This can be used apart from the /ctprice command being used to set the comparison amount for adding people to the Backup list.
   This would commonly be used if turning on the Backup list without the price being set on the initial configuration screen, it can be updated later when the ticket app is started even if not changing the price in Crazyticket.


7. /dsptlist: (bc/mods) Displays the backup ticket list.


8. /exptlist: (bc/mods) If a ticket show has failed, once the CrazyTicket app is restarted, use this command to add the users from the tlist back into the show.
   The Crazyticket /add command is executed, which will add them to the show if the user executing them has authority to the /add command in the CrazyTicket app.


9. /addlbtop [X]: (bc/mods) Add the top [X] number of tippers for the current session to the ticket show. Moderators may only use this if allowed per configuration.
   The Crazyticket /add command is executed, which will add them to the show if the user executing them has authority to the /add command in the CrazyTicket app.


10. /addlbamt [X]: (bc/mods) Add tippers who have tipped at least [X] number of tokens for the current session to the ticket show. Moderators may only use this if allowed per configuration.
    The Crazyticket /add command is executed, which will add them to the show if the user executing them has authority to the /add command in the CrazyTicket app.

N. Lush Menu

The Lush Menu is available to post a recurring message in the chat showing the lush tip ranges. This bot does not communicate with the lush or provide notification about whether the lush is connected, it is simply meant to provide chat notifications.
Broadcasters can also make use of the lush chrome extension to publish only the connection status to the chat and still use this menu for the price info, or use the chrome extension for all info and then this menu is not needed.
This menu was built specifically for the lush with the available menu selections (8 levels, 1 random amount, 4 pattern amounts), but could be used for any interactive toy by changing the text template.

1. /lushmenu: (all users) Display the lush menu in chat, only shown to the user that requests it.


2. /uselushmenu [on/off]: (mods/bc only) Toggle the setting for whether the Lush Menu is "on" or "off". Overrides the initial setting to turn the Positions Tip Menu on or off during the show.

O. Other Commands

1. /newsubject [title]: (mods/bc only) Update the room subject to a new value [title].


2. /dumpsettings [title]: (mods/bc only) send a listing of the full configuration settings list to the chat for the current user.

Additionally the bot will adjust any messages sent in all upper case to lower case for non moderators and broadcasters.