Slot 1

BMT Tip Goals

by butter_my_toast

Version 0.0.11

Updated March 28, 2023

Note that the "BMT" (by username butter_my_toast) series of Apps in V2 is replacing the "Dorothy" (username chelsea2950) series from V1, as we've rebranded everything. Most features will still be available, but some things are moving around as we learn from experience and try to take advantage of the V2 framework. See the bottom of this page for details on giving feedback. The following Topics are covered below - Tips & Features - Settings - Command List - Personalization - colors, emojis, etc TIPS & FEATURES: 1. The launch page is divided into three sections, and the personalization area is further broken down into multiple subsections: -- The first section has three settings you would likely change frequently for variety, such as the show description, if you're counting up or down, and how to handle the movement from one goal to the next. -- The next section is the goals themselves -- The remainder of the settings are optional and for personalization, where you can change various settings to make the bot look and behave exactly how you want. This includes subsections for room title settings, colors and themes for the recurring notice, and draw panel settings (the graphic that appears in a box under the stream). 2. It's important to enter the goals in the slots 1 thru 20 in the order they will be performed during the show (unless using the "select next goal" option in Setting 1.2). You can either specify a final goal in the room description, or set it as the last goal defined in the settings. 3. If you don't know what order you want to do your goals in, be sure to take advantage of Setting 1.2 to define that you will choose the next goal yourself after each goal finishes (using the /goal command). 4. You can put a negative sign in front of the amount for a goal to temporarily disable it from being used in the show without deleting it. 5. Most of the configurations you set on the launch page can be changed during the show with commands so you don't have to restart and lose tip counts and other in-show data. However, the changes you make using the commands within a show are not permanently updated to the start page - you have to make those changes there for them to be saved when you launch or using the "Settings" link. 6. Additionally, with the "Settings" link now available in V2, it is easier for the broadcaster to use that to change a setting, but the commands are still available so that moderators can continue to help out with settings if you don't your hands free :). When you update a setting with the App still active, you will receive a confirmation notice from the App, and then if further action is required, such as to update the goal list that the App is maintaining, that will be done as well. However, sometimes you may attempt to update a setting that cannot be changed, for example, setting a new goal amount that is less than the amount tipped already tipped for that goal. In this case, even though the setting page will successfully update, the App will ignore the new setting until you've made a valid update. 7. See the "Personalization" section below for more detail on themes and color settings in general. 8. Moderator trust levels are also available, be sure to read the below details on that feature. 9. You can control your background and text color in the draw panel. If you'd like to use a personalized background, there is also now a "self-service" method of uploading your own panel images and using them in the App! See additional details in the personalization section E below. 10. In the near future, this App will be able to take in certain centralized settings from the BMT Helper App so that you only have to maintain certain things in a central location, such as your fan club list, color themes, moderator settings, etc. 11. You can configure a maximum Tip Amount that can be applied to goals in setting 1.4. Be sure to set this above the highest menu item or other "tip for something" price that would be considered a normal part of the show, but then you could have other unique menu items above that where you do not want them to contribute to the goal progress. SETTINGS: Setting 1.1 - Show Description - Describe what you are going to do in the show. Use hashtags to help people find your room by a theme. Note that there are several options you can choose in the personalization section for how the Room Title is formatted (setting 4.1). Setting 1.2 - Next Goal behavior - You can choose to have the App automatically start the next goal in sequence (excess tokens from the first goal carry over), or have the app wait after a goal is finished and only start the next one when you're ready and enter a command, or have the app show you the goal list and let you select which goal you want to do next. With the third option, you can go in any order or repeat goals - note that the app will not go to "All Goals Complete" in this mode since you're always allowed to choose another goal. Setting 1.3 - Up or Down - Goals can count up to the goal amount, or count down from the goal amount to zero based on your preference. Setting 1.4 - Maximum Tip Amount to be applied to goals - Set to zero to disable, or set an amount and anything over this will not be applied to the goal progress. The tipper, broadcaster and moderators will receive a message when this occurs, and there is also a warning in the recurring notice if enabled. Section 2 - GOALS - Configure up to 20 goals with goal description and goal amount. Note the goal amount is the amount just for that specific goal, not the cumulative total. You input a negative goal amount by putting a dash '-' in front of the number to temporarily disable a goal from being used so you don't have to delete it and recreate it for a future show. Setting 3.1 - Enable a welcome message - if yes, enter the welcome message below in setting 3.2. Setting 3.2 - Add a welcome message if you don't already have one in another app or bot you are running Setting 3.3 - Moderator Level - Set a moderator trust level based on how well you know and trust your moderators and want to give them access to certain commands - see further details in the Personalization notes section D below Setting 3.4 - Text wrap length - Update the default if the text wraps on your display - depending how you watch your own chat, you may want to increase or decrease this to make it wrap at the appropriate point for your display. Setting 4.1 - Room Title Format - Format your room title, you can control what information is shown in terms of the goals. You can show the current goal, next goal, current goal only, or no goal description information (just your Show Description from setting 1.1) Setting 4.2 - Show description position in Room Title - Controls if the Show Description from Setting 1.1 appears before or after the current goal/next goal information. Setting 4.3 - Display "Remaining Tokens" in Room title - You can enable the display of the remaining number of tokens to goal in the room title as well, and control if it shows up first or last, however, note that by doing so, the room title will be published to the chat every time someone tips since CB requires that any changes to the room title are published. Setting 5.1 - Goal Notice Interval - Choose how often you would like the Tip Goals recurring notice to display (in minutes), in the format of something like "3.1" or "4.6" (quotes not included. In general, try to use an interval that is not a whole number minute value or a multiple of other recurring notices, this will keep you from having a bunch of notices display at the same time and push the chat off the screen. Setting 5.2 - Include Goal List in Notice - When the recurring notice is displayed, do you want to show the list of remaining goals as part of the notice? Setting 5.3 - Color Themes - Choose one of the preset color themes or choose to define your own "Custom" theme, with up to 3 blended background colors. Setting 5.4 - Custom Theme Background Color 1 - If selecting "Custom" in setting 5.3, input the first hex color code for background color 1 ("#" prefix plus the 6 character hex color codes, such #ffffff). See Personalization Section A for additional notes on hex color codes. Setting 5.5 - Custom Theme Background Color 2 - If selecting "Custom" in setting 5.3, input the first hex color code for background color 2. If you leave this blank and only input one color above, the second color will default to white. Setting 5.6 - Custom Theme Background Color 3 - (optional) If selecting "Custom" in setting 5.3, input the first hex color code for background color 3. Setting 5.7 - Custom Theme Text Color - If selecting "Custom" in setting 5.3, input the hex color code for the text color you would like to use in the notice. Setting 5.8 - Custom Theme Color fade direction - If selecting "Custom" in setting 5.3, input the direction that you would like the colors to fade into each other horizontal, vertical, or diagonal. Setting 5.9 - Notice Separator Style - The border of the recurring notice is by default dashes, you can choose to make these another character or Emoji, and enter it in Setting 5.10 below. Setting 5.10 - Separator character or Emoji - If setting 5.9 above is set to a custom character or emoji, paste it here. Setting 6.1 - Panel Background Image - Choose one of the pre-defined panel backgrounds, or choose None, or your own custom panel if you have created one and updated the image file name. Setting 6.2 - Panel Text Color - Choose one of the pre-defined panel text colors, or choose "Custom" and define a color below in setting 6.3. Setting 6.3 - Panel Custom Text Color - If selecting "Custom" in setting 6.2 above, input the hex color code for the text color you would like to use in the panel. Setting 6.4 - Show Total Tips for the show in the panel - Some of the panel displays have the option of including the total tips for the show, which you can enable if you like. COMMANDS: Most of these are available for moderators and broadcasters only, with some exceptions. Note that you can also type "/goalhelp" within the chat to see this same list of commands as well. Any changes you make with commands are not stored permanently, they are only stored within the current session. /skipgoal (or /sg): Used to bypass the rest of the current goal and start the next goal. /nextgoal (or /ng): Used to advance to the next goal once the current goal is complete when not configured for automatic advance. /listgoals (or /lg) [sendto]: List the current full set of the goals. The [sendto] parameter is optional, if excluded the default is to send to yourself. Broadcasters and Moderators can also use the 'all' and 'bc' values or a specific username to send it to others. /listremgoals (or /lrg) [sendto]: List the remaining goals. Add the "all" parameter to send it to everyone. The [sendto] parameter is optional, if excluded the default is to send to yourself. Broadcasters and Moderators can also use the 'all' and 'bc' values or a specific username to send it to others. /addtips [tokens]: Simulate users having tipped and advance the token count within a goal. Indicate the number of tokens you are adding as the [tokens] parameter, and note the value can be negative to subtract. You can add more than the current goal, but you cannot subtract less than has been tipped in the current goal. /goal [goalnumber]: Used to manually select the next once the current goal is complete, when auto advance is turned off. You can choose a new goal or one that was already completed. The list of goals is shown when the previous goal completes so you can choose the goal number from the list. /restartgoal: If you'd like to repeat a goal (common if you have a single goal you're recycling), you can use this command at any time to reset the tip count on the current goal to 0 (even if already complete) /setgoal1, /setgoal2, /setgoal3...(thru /setgoal20) [goalamt] [description]: These are the commands that let you edit the goals for your show. Both the [goalamt] and [description] parameters must be entered every time and will update both values. Note this is also only a temporary change made within the session, it does not permanently update the launch page config. -- The 1-20 designation as part of the command identifies which entry you are modifying. -- The [goalamt] parameter is the new value you are setting for the goal amount. Even if you are not changing the goal (only changing the description, you must still enter the existing value for the goal. -- The [description] Parameter is the new value you are setting for the goal description. Even if you are not changing the description (only changing the goal amount), you must still enter the existing value for the description. -- An example of the syntax for this command would be "/setgoal4 400 Blow job", which would set goal 4 to be a Blow Job once you reach 400 tokens. -- Note that you can't make updates to the current goal or past goal, only future goals. /rmvgoal [level]: Remove the goal entry for goal level of [level] (amount and description are both removed). Note this is also only a temporary change made within the session, it does not permanently update the launch page config. /resetapp : Reset the to the very beginning, starting over at goal 1. /reversegoal : Go back to the previous goal. The Tip count will remain intact, unless it is greater than the previous goal total, in which case it will be set back to zero, and you can use the /addtips command to get back to the appropriate tip level. /chgpanelbg [imagename]: Change the background of the draw-panel to one of the valid images. Images are updated regularly, so you can see the current list by entering this command with no parameter and the error message will show the current valid choices. Note that you can also see the images by going to the 'Source Code' tab for the app and clicking the link for 'App Images'. /chgpaneltext [newcolor]: Change the color of the text in the draw-panel to either a hex code (#0000ff) or the exact text of one of the color choices from the menu ('Dark Green', 'Dark Red', etc). You can lookup hex codes for any color on a site such as Color-hexa: /chgtextposn [0 or 1]: Update the default setting for whether the General Text shown across all App features is shown at the beginning or the end of the room title. Valid values for the parameter are "0" for the beginning and "1" for the end of the room title. /chgtitle [newtitletext]: Update the user-editable portion of the room title that is the general description of the show /chgmodlevel [1,2 or 3]: Update the moderator trust level. Values are 1 for Basic, 2 for Standard, 3 for Advanced. See the "modlevels" section above for more detail on what each level includes. /chgtheme [newthemeshortcut]: Update the color theme used for recurring notices. You can enter the command without any parameters to see the list of valid theme IDs. /chgnext [1,2 or 3]: Change the "Next Goal" behavior controlled in setting 1.2. Valid values are 1 for "Auto-start next goal", 2 for "Manually start next goal with command", or 3 for "Select next goal myself from the list". /addcustompanel [imagefilename]: Add a custom panel background image that you have created for yourself. This image can be used when your panel background is set to "My Custom Panel". See section E of the Personalization details below for more info. /dspcustompanels: Display the list of custom panel images that you have uploaded and added through the /addcustompanel command. /rmvcustompanel [panelnumber]: Remove a custom panel that you previously added. /chgcustompanel [panelnumber]: Change which custom panel is the active one if you have uploaded more than one. /goalhelp: See the help menu for the Tip Goals App. /about: See information about the App. /modlevels: See information on the mod levels and the abilities for each level. PERSONALIZATION: One of the strengths of all of the BMT Apps is the ability to personalize them to make the appearance of chat messaging and panel background unique to your room. Each of the sections below goes into more detail on these topics: A. Colors and Themes There are few concepts to follow with regard to defining your colors within the App. Note that these same themes are available across all of the "BMT" Apps, so you can easily present a consistent look and feel to the messaging in the chat even when multiple apps and bots are used together. -- Color themes will be used for the recurring notices and the goal completion notices -- The color theme can also be customized with up to three background colors and a text color -- You can apply the gradient effect (gradual color fade) to all of your individual background color settings or use a solid color for custom colors... the predefined themes all use a gradient color When selecting custom colors, for themes or individual feature settings, you must use what are known as "hex codes" for each color. These codes are in the format of a # sign followed by 6 alpha-numeric characters, hence the term hex". For example, the code for white is "#ffffff", and the code for one common shade of red (there are thousands) is "#ff0000". In order to use the correct code, you'll need to look up your code and enter it in the app launch page where there are custom color settings available. Note that is a good site for looking up the hex color codes for the colors you'd like to use. There is also to see how multi-color gradients backgrounds will look. These are just some suggested sites, there are plenty more available if you do a search online. B. Emoji's Emoji's can be used in a couple places in the App, primarily goal text and the border on several of the recurring notices. Some commonly used Emojis's and unicode characters are listed below, however this is just a few, there are tons of emojis available, and you can browse a more complete list here: ...or elsewhere, just search for "emoji list" on google. I've chosen to list the fairly generic ones that are mostly symmetrical. Simply drag your cursor over each to highlight and then copy and paste the emoji into the launch page or your room title to use it. You can also use the /emojis command in the app to see the same list. Note that there are only certain ones that can be used in your room title, as the more complex ones will not display, and those are repeated on separate lines as well. Random 1: ➖ ➕ ✖ ❕ ⚜ 💲 💰 💢 💥 🕳 🖕 👁 👅 👄 🍥 🌎 🧭 🎠 🎡 ⭕ ✔ ❌ Random 2: 🛑 🛸 ⌛ ⏰ 🕰 ☀ ⭐ ☁ ⚡ 🔥 🕸 🔮 👠 💎 📽 ⚔ 🛡 🛁 🧻 💠 🔶 🔷 Faces: 🙂 🙃 😇 😍 🤠 😎 😱 💀 ☠ 😈 💩 🤡 👽 Animals: 🐶 🦊 🦁 🐯 🐮 🐷 🐼 🕷 🤖 😺 🐵 🧸 Hearts: 💗 ❤ 🧡 💛 💚 💙 💜 🤎 🖤 🤍 Seasonal: 🎅 ☘ 🍀 ❄ ⛄ 🎃 🎄 👻 Flowers: 🌸 🏵 🌻 🌼 Food: 🍓 🍒 🍆 🥨 🍔 🍿 🍩 🍪 🎂 🍷 🍺 Gifts & Awards: 🎁 🎗 🎟 🏆 🥇 🥈 🥉 Sports & Gaming: ⚽ ⚾ 🏀 🏈 🎱 🕹 🎮 🎰 🎲 🎵 Symbols: ♠ ♥ ♦ ♣ 🃏 👑 Mail: ✉ 📧 📪 Signs: ⛔ ⚠ 🚫 ☢ ☣ ➡ Circles: 🔴 🟠 🟡 🟢 🔵 🟣 🟤 ⚫ ⚪ Squares: 🟥 🟧 🟨 🟩 🟦 🟪 🟫 ⬛ ⬜ ◼ ◻ ◾ ◽ ▪ ▫ Unicode characters and the following emojis can be used in your room title: Unicode characters: ℃ ℉ ⇐ ⇑ ⇒ ⇓ ⇔ ⏺ ♕ ♚ ❶ ❷ ❸ ❤ ❖ ❉ ✭ ❀ ➤ ⯎ ꖻ ꕤ Ꙭ � Room Title Set 1: ⌛ ❄️ ✨ ⭐ ☀️ ❤️ ⛵ ⛪ ⚡ ⌚ ⛔ ⚔️ ⚠️ ⛄ ⚓ ☘️ Room Title Set 2: ♣️ ♥️ ♠️ ▪️ ◾ ▫️ ◽ ☕ ✉️ 1️⃣ 2️⃣ 3️⃣ 4️⃣ 5️⃣ 6️⃣ 7️⃣ 8️⃣ 9️⃣ C. Background Panels The area (usually) underneath the video stream where the current goal or ticket show status are displayed is call the Draw Panel. The Tip Goals App has several different predefined panels that can be displayed here as a background to the text, and you can also have a custom one made. The option "My Custom Panel" is selected if you have your own panel uploaded into the App (must be coded into the App), if you use this option without having your own panel, it will just use the default panel. If you would like to submit a custom panel to be added for your room, the graphic must be 270 x 69 pixels, contact us here or on twitter to arrange adding it. To see the full list of the available panel backgrounds, they are shown here: Unfortunately this page only lists the CB file names, and does not show the names of the panels used in the app, but you should be able to narrow it down by the descriptions in the choices. If you just have an idea for a theme for additional panels to be added, let us know. We've tried to include most major holiday themes, and are open to adding more. D. Moderator Trust Levels Moderator Levels let you identify how much your mods can do based on a trust level. These rules apply to both mods assigned in CB and App mods. Essentially, "Basic" level lets them use low-risk level features, "Standard" gives more authority to more commands, such as editing the content of goals and managing your ticket shows, and "Advanced" lets them act on your behalf and do nearly everything the broadcaster can do with the app as far as commands go. However note that it is *not* possible for a bot or app to give authoirty to other CB functions that a broadcaster does, like ban people from the room, start private or group shows, etc. The default setting is "Standard", but you can decrease it if regularly assign new mods and don't want them to have a lot of authority, or increase it if you have trusted mods that manage your show for you. "Basic" Moderator Abilities - Use the List Goals and List Remaining Goals commands - Update the room title and other goal related text - Display the emoji list - Access the moderator help page "Standard" Moderator Abilities - All "Basic" ablities plus the below - Edit and maintain goals, restart a goal - Update the panel background and text color - Update the theme color (background and text) - Skip and manually advance goals - Manually add tips to a goal "Advanced" Moderator Abilities - All "Standard" ablities plus the below - Reset the current app feature and start over Only the broadcaster can use the /setmodlevel command to update the moderator trust level setting during the show. E. Self-Service custom background panels now available!! To use your own background that you've created, follow these steps: 1. Create your own image with a size of 270x69 pixels (width x height). 2. Create your own app, call it anything you like, this is just to get the image uploaded because once uploaded, image files are available across all apps. Therefore, this BMT Tip Goals App can use the image you create and upload. 3. Add the image to your app under the "Images" section, you don't even have to update the app onto the test bed or publish it, images become available in the general database as they are added. 4. Copy the image ID using the link next to the image in your App, and paste it into the command below where it says filename (not including the [] brackets), and enter this command in your room while the BMT Tips Goals app is running. You must be logged in as the broadcaster to do this, or you can allow mods to do it if you have "Advanced" Moderator settings. Command: /addcustompanel [image-filename] Note that if you add more than one panel, the latest one added is always the one that becomes active (and will be displayed immediately if you have your panel background set to "My Custom Panel"). If you would like to activate a different one, use this command to view your list of custom panels, each will have a number next to it and a note will appear next to the one that is active: /dspcustompanels And then enter the command to select the one you want active (this will stay in memory across shows until you change it): /chgcustompanel [custompanelnumber] You can also remove a custom panel from your list: /rmvcustompanel [custompanelnumber] ADDITIONAL BMT APP NOTES: While the source is available in V2 to copy and modify this App for individual cammers (which is ok to do), please keep in mind that by doing so you'll miss out on fixes and new features that are added to this public App. 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 App so you can continue to take advantage of the latest version. I've also created a Twitter DM group for users of the "Dorothy" and "BMT" Apps and Bots we'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 with other broadcasters and moderators on how they can best be used. Finally, check out our bios for other useful tips and general info about CB and broadcasting, great for new cammers! or


PermissionsAll permissions granted.
© Copyright 2011 - 2024. All Rights Reserved.