Mina's App

Short Description:

Basic, easy to use all-in-one app

Full Description

Basic, easy to use all-in-one app with tip menus, goals, ticket shows, automated notices, top tippers menu, timers and some games.

This app was built from the ground up and does a lot of things differently than many other apps. It's not a bot because it automatically updates the room subject and the panel below the cam with the most useful information depending on what is happening.

There are commands for literally everything! The app does not need to be restarted to set anything up! Every setting can be changed while the app is running.

There is a setting that allows moderators to operate the app for broadcasters. You can type /help after starting the app to get a complete list of all available commands (viewers will only get a short list of commands that apply to them).

This app was originally written for a specific model, hence the name, but I've finally decided to write some decent documentation for it, which you can find below. If you like this app, feel free to use it. It's completely free of charge!

Setting up the app

1) The app will automatically update the room subject depending on which modules are active. When goals are active, it will use the goal description as the room title. When a Ticket Show is running, it will use the ticket show subject. When neither is active, it will use "Username's room", where "Username" is that of the broadcaster. You can change this default subject by using the first setting in the app ("Default Room Subject when no goal or Ticket Show is active").

2) Because the app will modify the room subject, it needs to be aware of your hashtags! You can set hashtags that you want to always add to the subject, no matter what modules of the app are active (goals, games, Ticket show) by using the setting "Hashtags to always add to room subject".

3) The app has a built in timer that will prevent the interruption of a "yellow wall" of small tips. This will halt any room subject updates or notices by a set number of seconds after someone leaves a tip of an amount lower than a preset maximum. Use the setting "Yellow wall waiting period in seconds" to set the number of seconds (1 to 60 or 0 to disable this function) and "Maximum tip amount for yellow wall tips" for the maximum amount of tokens that count as yellow wall tips (any tip bigger than this will not invoke this timer).

4) To change these settings while the app is running, use these commands:

/subject new_subject (where new_subject is the new default room subject)
/hashtags new_hashtags (where new_hashtags is the new list of hashtags, separated by spaces)
/yellowwait sec (where sec is the new number of seconds for the yellow wall timer)
/yellowmax tkns (where tkns is the new maximum tip amount for yellow wall tips)

Using the tip menu(s)

This app has 3 different tip menus of which only 1 can be active at any time. You can switch between menus without restarting the app. You can add and delete items or change token amounts and item descriptions without restarting the app. Remember that these changes are lost when restarting the app!

1) Use the "Activate tip menu" to select which tip menu should be active when starting the app.

2) Select whether or not to show the tip menu when users enter your room by using the "Display tip menu on user entry" setting. Users can always request the tip menu by typing /menu or /tipmenu

3) Select whether or not to show the tip menu periodically by using the "Display tip menu periodically" setting and select the interval between the times that this happens using the "Display tip menu every x seconds" option below it.

4) Enter up to 20 items for at least the tip menu that you activated in step 1. You can also enter the items for the non active tip menus before starting the app.

5) To change to a different tip menu while the app is running, use this command:

/startmenu n (where n is the number of the tip menu, so 1, 2 or 3)
/stopmenu (to disable all tip menus)

6) To change the "Display tip menu on user entry" setting while the app is running, use this command:

/menuonentry opt (where opt is either ON or OFF)

7) To change the "Display tip menu periodically" setting while the app is running, use this command:

/menudisplay opt (where opt is either ON or OFF)

8) To change the "Display tip menu every x seconds" setting while the app is running, use this command:

/menuint sec (where sec is the number of seconds)

9) To see the list of menu items (with their item number), use these commands:

/menuitems (for the items in the active menu)
/menuitems all (for the items in all menus)
/menuitem n (for the items in menu n. n can be 1, 2 or 3)

10) To add items to a tip menu while the app is running, use these commands:

/menuadd tkns desc (where tkns is the amount of tokens and desc is the item description to add an item to the active menu)
/menuadd Mn tkns desc (where M is just a capital letter M to add an item to menu n. n can be 1, 2 or 3)

11) To remove an item from a tip menu while the app is running, use these commands:

/menudel itm (where itm is the item number found by /menuitems to remove an item from the active menu)
/menudel n.itm (to remove an item from menu n. n can be 1, 2 or 3)

12) To edit a tip menu item while the app is running, use these commands:

/menuset itm tkns (where itm is the item number found by /menuitems to change the amount of tokens for an item in the active menu)
/menuset n.itm tkns (to change the amount of tokens for an item in menu n, n can be 1, 2 or 3)
/menuset itm tkns desc (where desc is the item description to change the amount of tokens and description of an item in the active menu)
/menuset n.itm tkns desc (to change the amount of tokens and description of an item in menu n. n can be 1, 2 or 3)

Starting goals

1) If you want to start a goal right after starting the app, set the "Activate goal" setting to "Yes".

2) Select the type of goal(s) you want to do using the "Goal type" setting. The difference between "Progressive goals (automatic)" and "Progressive goals (manual) is that the latter will pause goals after a goal has been reached and you need to type /nextgoal to start the next one. Any tips between goals do not count towards the next goal in manual mode!

3) Tell the app what to do after the final goal has been reached by using the setting "After last goal is completed".

4) If you selected to repeat the last goal x times in step 3, use the "Number of times to repeat the last goal" setting to define x.

5) You can optionally set a room subject to use after the final goal has been reached (e.g. "All goals have been reached. Thanks to all tippers!") using the setting "Room subject after final goal is completed. If you don't set this, the description of the final goal will stay as the room subject with [0 tokens remaining] added to it.

6) Enter a token amount and description for at least one goal.

7) To start predefined goals (when goals have not yet started) while the app is running, use this command:

/startgoal type (where type is either "single", "auto" or "manual". type can be omitted to use the preset type)

8) To stop all goals while the app is running, use this command:

/stopgoal (tips will not be lost and you can just continue later where you left off by typing /startgoal)

9) To change the "After last goal is completed" setting, use this command:

/afterlastgoal what (where what can be "stop", "repeat", "repeatforever" or "startover"

10) To change the "Number of times to repeat the last goal" setting, use this command:

/repeatlastgoal x (where x is the number of times to repeat the last goal)

11) To change the "Room subject after final goal is completed" setting, use this command:

/lastgoalsubject subj (where subj is the new room subject. subj can be omitted to keep the description of the final goal as the room subject)

12) To see the list of goals (with their goal number), use this command:

/goals

13) To add a goal (for progressive mode) while the app is running, use this command:

/addgoal tkns desc (where tkns is the amount of tokens and desc is the goal description)

14) To remove a goal (for progressive mode) while the app is running, use this command:

/delgoal n (where n is the number of the goal found by the /goals command)

15) To change a goal while the app is running, use this command:

/setgoal tkns (where tkns is the number of tokens to change the number of tokens for the active goal)
/setgoal Gn tkns (where G is just a capital letter G and n is the goal number found by /goals to change the number of tokens for goal n)
/setgoal tkns desc (where desc is the goal description to change the number of tokens and the description for the active goal)
/setgoal Gn tkns desc (to change the number of tokens and the description for goal n)

16) To move on to the next goal in manual progressive mode, use this command:

/nextgoal

17) To reset the tip counter and restart the current goal, use this command:

/resetgoal

18) To skip a goal in progressive mode, use this command:

/skip (tokens contributed towards the current goal will be carried over to the next one)

19) To switch to any goal in the list of progressive goals, use these commands:

/gogoal n (where n is the goal number found by /goals. tokens contributed towards the current goal will be carried over to the new one)
/gogoal n reset (to reset the token counter after switching goals. tokens contributed towards the current goal will be lost)

20) To quickly set up a new single goal when no more goals are active while the app is running, use this command:

/setgoal tkns desc (where tkns is the number of tokens and desc is the goal description)

Set up a Ticket Show

1) If you want to start ticket sales immediately after starting the app, set "Activate Ticket Show" to "Yes" or "Yes and start timer".

2) If you know the subject for the Ticket Show before starting the app, use the setting "Room subject for Ticket Show".

3) You can enter a description for the Ticket Show, but this will only be shown as a notice when sales are started. The setting "Description of the Ticket Show" is optional.

4) Use the setting "Default timer (in minutes)" to set the default period for ticket sales. If you start the Ticket Show timer, the app will automatically hide your cam from public after the time has run out (unless there are no ticket holders).

5) If you know the ticket price before starting the app, use the setting "Ticket price" to enter the number of tokens for a ticket.

6) You can also enter a (lower) price for fans using the "Ticket fanclub price" setting.

7) If you want to give moderators a free ticket because they're "working" during the show, set "Mods get a free ticket" to "Yes".

8) You will probably want to keep the setting to "Suppress public chat during ticket show" enabled, so users that don't have tickets don't pollute the chat with their messages. If you don't mind people who don't hold a ticket talking, you can set this to "No".

9) If you have set up the Ticket Show, but not activated it yet ("Activate Ticket Show" was set to no), you can start sales using this command:

/ts on (to start sales, without timer)
/ts timer (to start sales, with the default timer)

10) If you didn't set up a Ticket Show when starting the app, but want to do one without restarting the app, use these commands in order:

/tssubject subj (where subj is the subject for the Ticket Show)
/tsdesc desc (where desc is the description of the Ticket Show. desc is optional and can be omitted)
/tsprice tkns (where tkns is the number of tokens for a ticket)
/tsfanprice tkns (where tkns is the number of tokens for a ticket for fan club members)
/tstimer n (where n is the number of minutes for ticket sales)
/ts timer (to start ticket sales and automatically start the show after the time for ticket sales has run out)

11) To start a Ticket Show timer (or restart an already running one), use these commands:

/tsstarttimer (to start the default timer)
/tsstarttimer min (where min is the total number of minutes for the timer)
/tsstarttimer MM:SS (MM = minutes, SS = seconds)
/tsstarttimer HH:MM:SS (HH = hours, MM = minutes, SS = seconds)

12) To stop the Ticket Show timer, use this command:

/tsstoptimer

13) To add time to the running Ticket Show timer, use these commands:

/tsaddtime min (where min is the number of minutes to add)
/tsaddtime MM:SS (MM = minutes, SS = seconds)
/tsaddtime HH:MM:SS (HH = hours, MM = minutes, SS = seconds)

14) To subtract time from the running Ticket Show timer, use these commands:

/tssubtime min (where min is the number of minutes to subtract)
/tssubtime MM:SS (MM = minutes, SS = seconds)
/tssubtime HH:MM:SS (HH = hours, MM = minutes, SS = seconds)

15) To add users to the Ticket Show guest list, use this command:

/tsadd users (where users is a list of usernames, separated by spaces, e.g. "user1 user2 user3")

16) To remove users from the Ticket Show guest list, use this command:

/tsdel users (where users is a list of usernames, separated by spaces, e.g. "user1 user2 user3")

17) Other commands that can be used during a Ticket Show:

/startshow (to start the ticket show manually)
/showover (to inform users that the show is ending and buying a ticket now is not recommended)
/showend (to inform users that the show is almost over and suspend ticket sales)
/showstop (to stop the Ticket Show and return your cam to public)
/newshow (to restart ticket sales. ticket holders keep their tickets and can use it again)
/showreset (to clear the list of ticket holders, e.g. after /newshow so users have to buy again)

18) To turn off the Ticket Show module entirely ("Ticket Show" will be removed from the room subject), use this command:

/ts off

Automated notices

1) If you want to periodically inform users of certain things, like your room rules or promote your social media, you can set up automated notices in the app by setting "Enable notices" to "Yes".

2) The app can go through the list of notices from top to bottom and then start over or pick notices at random from the list. Use the setting "Display notices" to change this behaviour. "Manually" means that notices will only be shown to users every time you type /anotice n (where n is the notice number found by /notices).

3) You can change the interval between periodic automated notices using the setting "Display a notice every x seconds".

4) Enter at least one notice. You can use emoticons/GIFs just like in the chat, starting with a colon (:).

5) To enable automated notices while the app is running, use this command:

/startnotices

6) To disable automated notices while the app is running, use this command:

/stopnotices

7) To change the "Display notices" setting while the app is running, use this command:

/displaynotices how (where how is "inorder", "random" or "manual")

8) To change the interval between automated notices while the app is running, use this command:

/noticesint sec (where sec is the number of seconds between periodic automated notices)

9) To see a list of all notices (with their notice numbers), use this command:

/notices

10) To add a notice to the list, use this command:

/addnotice nt (where nt is the text for the notice)

Example 1: /addnotice Don't be shy, join the chat!
Example 2: /addnotice Follow me on Twitter @username

11) To remove a notice from the list, use this command:

/delnotice n (where n is the number of the notice you want to remove, found by the /notices command)

12) To change the text for a notice, use this command:

/setnotice n nt (where n is the notice number, found by /notices and nt is the notice text)

Spin-the-Wheel

1) If you want to activate Spin-the-Wheel right after starting the app, set "Activate Spin-the-Wheel" to "Yes".

2) Set "Price to spin the wheel" to the amount of tokens required to spin the wheel. Users have to tip the exact amount to spin!

3) Set "Fanclub price to spin the wheel" to the amount of tokens fanclub members have to pay to spin the wheel.

4) Set "Inform users the wheel is active" to "Yes" if you want the app to periodically send a notice to users that the game is running.

5) Set "Every x seconds" below it to the interval between those notices.

6) Add at least one prize. You decrease the chance of winning a certain prize by lowering the number of occurences.

7) Commands to control this game while the app is running:

/startwheel (to activate Spin-the-Wheel)
/stopwheel (to deactivate Spin-the-Wheel)
/wheelprice tkns (where tkns is the number of tokens to change the price to spin the wheel)
/wheelfanprice tkns (where tkns is the number of tokens to change the price for fanclub members to spin)
/wheelnotice opt (where opt is ON or OFF to change the "Inform users the wheel is active" setting
/wheelint sec (where sec is the number of seconds between Spin-the-Wheel notices)
/wheelprizes (to show a list of prizes with their prize numbers)
/addprize occ: desc (where occ is the number of occurences from 1 to 10 and desc is the description to add a prize)
/delprize n (where n is the prize number found by /wheelprizes to remove a prize)
/setprize n occ: desc (to change the number of occurences or description of a prize)
/freespin (to spin the wheel yourself for free)
/freespin user (where user is the username of a viewer you want to appoint as the winner of the prize for your free spin)

Roll-the-Dice

1) If you want to activate Roll-the-Dice right after starting the app, set "Activate Roll-the-Dice" to "Yes".

2) When "Remove prize won after each roll" is set to "Yes", each prize can only be won once. When a user rolls a number that has already been rolled, they will get no prize!

3) Set "Inform users Roll-the-Dice is active" to "Yes" if you want the app to periodically send a notice to users that the game is running.

4) Set "Every x seconds" below it to the interval between those notices.

5) You need to enter all 12 prizes! Only the rare prize (rolling 13) is optional. The probability of rolling a certain number is not the same for each number. Keep this in mind when setting prizes! There is one chance of rolling 2 and 12, 2 chances of rolling 3 and 11, 3 chances of rolling 4 and 10, 4 chances of rolling 5 and 9, 5 chances of rolling 6 and 8 and 6 chances of rolling 7! There is 1 chance of rolling 13 every 3 rolls (6 + 6 will become 6 + 7).

7) Commands to control this game while the app is running:

/startdice (to activate Roll-the-Dice)
/stopdice (to deactivate Roll-the-Dice)
/diceprice tkns (where tkns is the number of tokens to change the price to roll the dice)
/diceremove opt (where opt is YES or NO to remove the prize won after each roll)
/dicenotice opt (where opt is ON or OFF to change the "Inform users Roll-the-Dice is active" setting)
/diceint sec (where sec is the number of seconds between Roll-the-Dice notices)
/diceprizes (to show a list of prizes)
/setdprize n desc (where n is the number rolled and desc is the description to change the prize description. omit desc to remove a prize)
/freeroll (to roll the dice yourself for free)
/freeroll user (where user is the username of a viewer you want to appoint as the winner of the prize for your free spin)

Top tippers menu

1) To activate the top tippers menu, set "Periodically show list of top tippers" to "Yes".

2) Set "Show list every x seconds" to the interval between top tipper notices in seconds.

3) You can change the number of tippers in this menu by setting "Number of tippers to show" to a number between 1 and 10.

4) "Add amount a user has tipped to their messages" adds the amount a user has tipped since the app was started to their messages. This is an easy way for users to see who has been supportive and might even encourage people to tip more! Don't restart the app during a broadcast or the tip count will be lost!

5) "Give the top tipper of the day a crown" adds a little crown to the messages of the highest tipper of the day. Note that the list is cleared every time the app is restarted, so if you restart the app during a broadcast, the current king loses his crown!

Using timers

The app can run up to 10 timers at a time (maximum of 2 hours per timer) that can be customized with a personal message. For example, if you have an item like "Topless for 5 minutes" on your tip menu, you can set a custom timer for 5 minutes with the message "Topless". The app will then regularly send notices to users as time runs out, saying things like "Timer 'Topless' ends in 2 minutes".

1) To start a new timer, use these commands:

/starttimer min (where min is the number of minutes)
/starttimer min msg (where msg is an optional personal message, like "Topless" in the above example)
/starttimer MM:SS (MM = minutes, SS = seconds)
/starttimer MM:SS msg

2) To see a list of running timers (with their timer numbers), use this command:

/timers

3) To stop a running timer, use this command:

/stoptimer n (where n is the timer number found with the /timers command)

4) To add time to a running timer, use these commands:

/addtime n min (where n is the timer number found with the /timers command and min is the number of minutes to add)
/addtime n MM:SS (MM = minutes, SS = seconds)

5) To subtract time from a running timer, use these commands:

/subtime n min (where n is the timer number found with the /timers command and min is the number of minutes to subtract)
/subtime n MM:SS (MM = minutes, SS = seconds)

Custom notices

1) To send a one time custom notice to all users, you can type the following command:

/notice nt (where nt is the text for the notice)

Example: /notice Follow me on Twitter @username

2) To send a one time custom notice to one user (this is a great way to send a pm in an alternative way that doesn't let normal users reply), use the following command:

/pm usr txt (where usr is the username of the viewer you want to send the notice to and txt is the text)

Example: /pm username Thanks for your tip. I will pm you after I stop broadcasting.

Moderators and Super Users

1) The setting "The following super users have access to all app commands" should be left alone. It's mainly for assistance from the developer and debugging. You can technically use it to have someone off camera operate the app for you, but it's not recommended.

2) If you have good moderators that you can trust, you can enable the "Mods have access to broadcaster commands" setting. This will basically give almost full control over the app to moderators so they can type most of the commands for you.