"MHS Jar Config" notecard help

The configuration notecard (in your jar's Content panel) is named "MHS Jar Config" and provides default values when the jar is first rezzed or reset. A detailed, commented notecard is included in the jar.

In short, the notecard makes use of a "TOKEN=VALUE" format. Beyond the rule that each TOKEN=VALUE setting be on their own line, the notecard has few restrictions as to how you layout your data. For instance:

  • There are no requirements regarding spacing before or after the "=" sign. (i.e., TITLE=MY JAR will work just the same as TITLE  =   MY JAR).

  • Upper/Lower case sensitivity of the tokens is insignificant (i.e., TITLE=MY JAR will work just the same as title = MY JAR).

  • Order of lines does not matter. You can put each line anywhere you wish.

  • Comments can be helpful. Comments are marked with a double forward slash ("//").

  • Blank lines are skipped, so feel free to space lines apart for easy reading.

Sample:

TITLE = My Club's Tip Jar|Please consider tipping! // This is the text displayed publicly
// above the jar. Use the vertical bar "|" as a line-break for creating multiple lines.
// (Note You can also change the title on-the-fly by clicking the jar and selecting Admin|ChatCmd 
// and then chat the desired title over channel 888.  For example, "/888 Zappo's Tip Jar".
// Keep in mind that the chatted text will NOT be saved back into this notecard.) 

GIFT THRESHOLD = 10 // put a pure number here, no "L" after it 

PAY BUTTONS = 10,20,30,40 // spaces before or after each comma are optional

// Employ login parameters. This feature is enabled by clicking the jar,
// then selecting Admin, then Empl Login, then selecting the option to turn on.
// The jar owner and anyone configured in the MHS Jar Operators notecard
// are NOT able to login as employees.  A valid employee is anyone else who
// is a member of the group that owns the land on which the jar is rezzed.
EMPLOYEE LOGOFF RANGE = 0   // value in meters for auto-logoff.  Setting to zero disables auto-logoff.
EMPLOYEE PERCENTAGE = 25  // any value between 1 and 100.

// The following six lines are used when you want the tip jar to hand out
// something OTHER than the MHS Rose.  For instance, if you have an object
// named "My Widget" then place that object in the jar's contents and then
// decide which color slot to associate that widget with.  Then activate
// the applicable rose color in the jar.  You could also assign My Widget to
// all six colors.  That way, the jar would hand out My Widget regardless
// of which rose color is spinning in the jar.
HANDOUT OBJECT RED = My Widget
//HANDOUT OBJECT WHITE =
//HANDOUT OBJECT YELLOW =
//HANDOUT OBJECT PINK =
//HANDOUT OBJECT PURPLE =
//HANDOUT OBJECT BLACK =

RGB TEXTCOLOR = 1.0, 0.7, 0.7 // spaces before or after each comma are optional

// TICKLE TEMPLATE has four variables: !FIRSTNAME!, !LASTNAME!, !FULLNAME!, and !THRESHOLD!
TICKLE TEMPLATE = Greetings !FIRSTNAME!! Tip me !THRESHOLD!L or more, and you will get a nice rose!

// The POPUP TIP NOTIFY offers a very trivial enhancement, and best be disabled for most jar owners.
POPUP TIP NOTIFY= no  // anything other than "yes", "true", or "1" is regarded as disabled.
// Another way to disable this is to simply comment the entire line out
// There is no limit to the number of tip sharing recipients, but keep it reasonable in number // because notecards and script memory DOES have a limit. For each line, put the avatar's key, // then a comma, then the percentage (integers only) of the tip to share. // To get an avatar's UUID, click the jar and select Admin|ChatCmd. Then within 60 seconds,
// say the person's name over channel 999. For instance, "/999 Zappowappy Ball".
// The key will be reported in the chat window. Use a separate SHARE WITH= line for each recipient
// IMPORTANT: Don't forget to remove the leading "//" markers. They are comment markers which
// means the notecard loader will not see anything after it. In our two lines below, only the first // sharing line will be seen. The second one has a leading "//" marker, so it will be ignored.
SHARE WITH=12345678-abcd-ef00-1234-aaaabbbbcccc,15 // 15% to my assistant named blahblah blah //SHARE WITH=87654321-dcba-00fe-4321-ddddeeeeffff,25 // hold off on yadayadayada

As stated above, every occurance of a "//" and any text that follows it are comments. They are not required! So feel free to remove them all, which would result in a smaller, more concise MHS Jar Config notecard:

TITLE = My Club's Tip Jar|Please consider tipping!
GIFT THRESHOLD = 10
PAY BUTTONS = 10,20,30,40 
EMPLOYEE LOGOFF RANGE = 0
EMPLOYEE PERCENTAGE = 25
HANDOUT OBJECT RED = My Widget
RGB TEXTCOLOR = 1.0, 0.7, 0.7
TICKLE TEMPLATE = Greetings !FIRSTNAME!! Tip me !THRESHOLD!L or more, and you will get a nice rose!
POPUP TIP NOTIFY= no
SHARE WITH=12345678-abcd-ef00-1234-aaaabbbbcccc,15

Token Summary

TITLE= This line is for a customized hover text. If this line is blank, then the default text will be: "[Owner Name]'s Donation Jar". Title text can be multi-lined by putting a "|" character where you want line breaks.

You may find times where you need to change your jar title, but don't want to go through the hassle of resetting your jar to reload the notecard. So there's a shortcut! Click the jar, then select Admin | ChatCmd. This activates a listener channel for 60 seconds, allowing you to chat the desired jar title over channel 888. The new jar title will be instantly displayed. Existing hover text tip statistics will remain intact. For example, chat next to the jar the following: "/888 My New Tip Jar Title|Pretty Cool!". This action will not update your notecard.
EMPLOYEE_LOGOFF_RANGE= This defines whether or not you want a logged-in employee to be automatically logged off the jar if (1) the person logs out of Second Life® or (2) the person ventures beyond some distance in meters. Set EMPLOYEE_LOGOFF_RANGE to 0 if you want auto-logoff disabled, or some value between 1 and 96 to specify what distance you want auto-logoff to kick in.
EMPLOYEE_PERCENTAGE= This defines percentage of the tip that goes to the logged-in employee. Note that if you have TipTracer enabled, the percentage applies to the value after the 1.25% TipTracer fee is applied.
HANDOUT OBJECT RED =
HANDOUT OBJECT WHITE =
HANDOUT OBJECT YELLOW =
HANDOUT OBJECT PINK =
HANDOUT OBJECT PURPLE =
HANDOUT OBJECT BLACK =
These six lines are used when you want the tip jar to hand out something other than the MHS Rose. In general, you'll only use one of these lines, that being the one that corresponds to the rose color you have activated. For instance, if you have an object named "My Widget" then place that object in the jar's contents and then decide which color slot to associated that object with. Then activate the applicable rose color in the jar. You could also assign "My Widget" to all six colors. That way, the jar would hand out My Widget regardless of which rose color is spinning in the jar. For more information on this subject, click here.
RGB TEXTCOLOR= This defines the initial Red/Green/Blue components of the hover text color. Each component is a fractional value that must be between 0 to 1. If this line is excluded, then the default text color will be white. Note you can further adjust the hover text color via the options dialog upon clicking the jar.
GIFT THRESHOLD= This is the donation threshold that triggers the jar to hand out a rose (or a custom object, as discussed in this page). Don't include the "L" part, only put the numerical number here. If this line is blank, then it will be set to 10, i.e., 10 Linden. By default, a red rose is handed out. But you can change that to yellow, white, pink, purple, or black via the options dialog upon clicking the jar.
PAY BUTTONS= This is a comma-delimited list of preset Linden amounts that you want displayed as payment buttons. If this line is blank, then the default Linden payment values will be displayed. So if you have a text string of "10,50,100,200", the upper left button will be 10, the upper right will be 50, the lower left will be 100, and the lower right will be 200. Linden limits us to 4 buttons, so any values beyond the 4th value will be ignored. You can "hide" a button by setting a value of 0 in it's place.
TICKLE TEMPLATE= This line allows you to set what you want whispered to whoever clicks your jar. You can further customize it by using one of four variables. Note that the variables are upper case and have a leading and trailing "!":
  • !FIRSTNAME! will be replaced with the person's first name.
  • !LASTNAME! will be replaced with the person's last name.
  • !FULLNAME! will be replaced with the person's full name.
  • !THRESHOLD! will be replaced with the value set in the "GIFT THRESHOLD=" setting

Let's say you have the GIFT THRESHOLD set to 15, and Zappowappy Ball strolls on up and clicks your jar. Here's what he will see for the following TICKLE TEMPLATE examples:

Example 1:*

TICKLE TEMPLATE = Hello !FIRSTNAME!! If you tip me !THRESHOLD!L or more you will get a nice rose!

He will see: "Hello Zappowappy! If you tip me 15L or more you will get a nice rose!"

Example 2:*

TICKLE TEMPLATE = Welcome !FULLNAME!. Tip !THRESHOLD!L or more and you'll get the rose you see here!

He will see: "Welcome Zappowappy Ball. Tip 15L or more and you'll get the rose you see here!"

Example 3:*

TICKLE TEMPLATE = Dear Mr/s !LASTNAME!, fork over at least !THRESHOLD!L and you'll get a surprise.

He will see: "Dear Mr/s Ball, fork over at least 15L and you'll get a surprise."

* In above examples, line-wrap might be observed in your browser. In the notecard, do not line wrap!

SHARE WITH= Add one of these lines for each avatar you want to share your tips with. Include the full key to the recipient, then a comma, then the percentage (integers only) for that recipient.

You can query for an avatar's key over a special chat channel. Click the jar, then select Admin | ChatCmd. This activates a listener channel for 60 seconds. Then chat the avatar's name over channel 999. . For instance, you can chat: "/999 Zappowappy Ball". The key will be reported in owner-only chat.

Important: Sharing is not activated by default! Just because you have one or more "SHARE WITH=" lines in the MHS Jar Config card does not automatically trigger sharing to work. After loading the notecard by clicking Admin | Reset, you must then click Admin | Sharing to activate the sharing mechanism. A Debit Permissions dialog will appear, where you must Grant payment permissions.
POPUP TIP NOTIFY The POPUP TIP NOTIFY offers a very trivial enhancement, and best be left disabled for most jar owners. You would only want it enabled if you have globally muted payment notifications. Why would you want to do this? Well, perhaps you're a a super-successful store owner who doesn't like seeing all those popup sales notifications, but still want to know when someone tips you. If you're one of these fortunate few, then enable the POPUP TIP NOTIFY option by setting it to "yes", "true", or "1".

Changes made to the MHS Jar Config notecard are not immediately loaded. You must reset the jar using Admin | Reset. Resetting the jar will not clear your local tip statistics displayed in the hover text, but the rose color will revert to red, as well as reload your MHS Jar Operators notecard, if it exists.

Home | Intro | Overview | Notecards | Updating | Sales | TipTracer | Login

ZappoWappy™ (c) 2006-2021