Goal
The Goal module allows you to use a goal for users to tip towards. There are several form fields to initialise a goal and a set of commands to control the goal settings during the cam-session. Goal related information may be shown in the Panel, the Room subject and chat window.
Goal: Form Fields
In case you don't want to use the Goal module, you may choose to turn it off completely by setting Use goal to No. All goal-related functionality will be disabled, including the commands. It may be enabled at any time during a cam-session by using the /toggle goal command.
Use Goal type to choose between a Single goal or a Repeating goal. You may also choose None to have no goal initially, but set one during the cam-session by using the goal commands (see below).
When a Single goal is reached, goal counting will stop. When a goal is reached in a Repeating goal scenario, a goal counter is increased and users can continue to tip towards the next goal. In both cases a message will be displayed (see below).
Set the goal Description to let your visitors know what they are tipping for. This description will be added to the Room subject. Also set the goal's tip Amount (in tokens). If the total amount of tips during a cam-session surpasses this amount, the goal will be reached. When that happens the Goal reached notice will be displayed in chat.
Goal: Commands
A goal consists of three parts: the type (single or repeating), the amount and the description. The following four commands allow you to set these.
/goal (host, mods)
This commands allows you set a completely new goal. It requires three arguments: type, amount and description. An error message will be shown if any of these is missing. Running this commands may look like this:
Notice: _pi_ updated the goal!
This example sets a single goal of 2500 tokens and a goal description of "Sexy strip show!" If the Panel shows goal info, it will be updated accordingly.
The following three commands allow you to set each part of a goal separately. Internally the goal command uses these.
/goaltype and /type (host, mods)
With this command the type of goal can be set or changed. It expects one argument: the goal type, which should be one of: single, repeat or none. To make your life easier repeat has some variations that also work: rep, repeating and repeated. So to set a repeating goal, all of the following commands are valid:
_pi_: /goaltype repeating
_pi_: /goaltype repeat
Changing the goal type will update the Room subject and Panel (if it shows goal info). Some more examples:
room subject changed to "Welcome to my room! - Goal: Sexy strip show! - #lovense"
_pi_: /goaltype rep Notice: _pi_ updated the goal type!
room subject changed to "Welcome to my room! - Repeating Goal: Sexy strip show! - #lovense"
_pi_: /goaltype none Notice: _pi_ updated the goal type!
room subject changed to "Welcome to my room! #lovense"
/goalamount, /goaltokens and /amount (host, mods)
This command allows you to reset the goal amount: the total amount of tokens for users to tip towards. The command expects one argument: the amount. For example:
If the Panel shows goal info, it will be updated accordingly.
Note that it is possible that the current goal may be achieved when lowering the goal amount.
/goaldesc (host, mods)
This commands allows you to reset the goal description, which appears in the Room subject. It expects one argument: the description. An example:
Notice: _pi_ updated the goal description!
/goalinfo (host, mods, users)
This commands, which is available to all users, shows the goal progress in chat. It is handy for when you have either disabled the Panel or are not the showing goal progress. This command simply makes use of the Panel functionality to show current goal (when repeating goal), tips, goal total and remaining: