Ultimate Tip Jar Range

From Marcus Zenoria Designs - Tip Jars & Tech - Wiki
Revision as of 08:22, 20 March 2019 by Mzenoria (talk | contribs) (Ultimate Tip Jar Script)
Jump to: navigation, search
Ultimate Tip Jar Range
Version 5.34

Information

This page has all the information that I think you need to use your Tip Jar. However, since your Jar is “Rez N Go” you don't have to adjust any settings before you use it.
Touching the jar will bring up your Admin menu & if you go into Jar Config most day-to-day configuration can be made there. I suggest you rez your Tip Jar and test it before you change anything.
Please find some time to set-up your Tip Jar before you work, as all settings are best changed when not in use.
Tip Jars are copy and mod, so you can make as many as you like and adjust them so you can have different settings for different clubs etc.

Jar Loading Times

Your MZD Tip Jar is designed for use in busy and laggy Sims, script usage is reduced to a minimum and our fast-boot script system, means that loading times are extremely quick compared to other makes of tip jars. On average your tip jar scripts will take 2-3 seconds to load, even in a busy sim. There are however a couple of times when you will find the fast-boot, won't work:
The first time you rez the jar. On first rez, all settings are reset and the jar loads all information afresh from the note-card. It will also check for jar updates, which due to Second Life limitations can freeze certain jar features for a few seconds. If you edit the note-card, or add items to the inventory. Adding gifts, note-cards, textures etc to the jar inventory means the jar will recheck what you have changed and re-read the note-card.

We suggest you always 'First Rez' your jar or update settings etc, before you need to work, to allow the everything to all load correctly

Ultimate Tip Jar Script

If you purchased the script only version of the tip jar, then preparing to use it is very easy, the object you intend to use as a jar must be mod and preferably also copy.

  • Right click the object you intend to use and select EDIT
  • In the build window that appears, go to "CONTENT"
  • Drag and drop the following into the object
    • _ulttjs_config (Notecard)
    • MZD Update (Script)
    • MZD_02_UNT_TJS (Script)
    • MZD_01_UNT_TJS (Script)
    • MAKE SURE THE "MZD_01_UNT_TJS" is dropped in last.
  • Now just wait for it to load

Sometimes if the object you are using is a sculpt or a mesh item, the hover text might appear too high, or too low. You can correct this by adding another single prim to it and setting it as the object 'root'. Then the hover text will appear over this prim. Now your scripts are in place, using the jar is the same as all other jars in the Ultimate rang below.

Using Your Tip Jar

To use your Tip Jar it's easy!

  1. Rez the Tip Jar where you want to use it
  2. Wait for the Configuration to load (10-15 sec)
  3. You will receive a confirmation when your Tip Jar is ready

Tip Jar Rotation

Your Tip Jar can rotate when in use.

  • To do this:
    1. Touch the Tip Jar
    2. Click Admin
    3. Click Jar Config
    4. Click Jar Rotation
    5. Select Rotate On or Rotate Off as required

Using Other Textures

Your Tip Jar can use either your profile picture (default) or one or more textures from its inventory. Selecting how you do this is done through the tip jars configuration menu.

Before you edit the config nc, make sure you have added the all items needed to the inventory, see here.

Adding more that one texture to your Jar inventory will enable the jars slide-show facility, when you instruct it to use textures from the jars inventory.

  • To do this:
    1. Touch the Tip Jar
    2. Click Admin
    3. Click Jar Config
    4. Click Textures
    5. Click Inventory

Change Hover Text Colour

You can change the colour of the text that appears over your Tip Jar.

  • To do this:
    1. Touch the Tip Jar
    2. Click Admin
    3. Click Jar Config
    4. Click Jar Text
    5. Select your text colour

Change Tip Info Displayed

You can change what tip details you want displayed over your Tip Jar. For example, some users prefer to hide the total tips received as it can impact on tips received if you have earned a high amount of tips.

  • To do this:
    1. Touch the Tip Jar
    2. Click Admin
    3. Click Jar Config
    4. Click Tip Display
    5. The buttons displayed will allow you to turn on or off the following:
      • List On or List Off - Displays a list of your last 3 tippers names
      • Recent On or Recent Off - Displays the highest of your last three tips
      • Total On or Total Off - Displays the total of the tips you have received
      • Last On or Last Off - Displays the name & amount of your last tip

Change Jar Particle Effects

You can change the particle effects of your Tip Jar, or turn them on or off using the menu system.

  • To do this:
    1. Touch the Tip Jar
    2. Click Admin
    3. Click Jar Config
    4. Click Particles
    5. To turn on or off particle effects click on Part. On or Part. Off
    6. Choose from the list displayed: Music Hearts Kisses L$ Coins Smileys
    7. Your Jar will now use your chosen effect when a tip is received

Controlling Request System

A DJ Auto-Request System is featured with our Ultimate Tip Jar range. It enables your guests to click on a “Request” button in the jars menu and then send you a request. This message will arrive to you as a Drop Down Menu and also a message in Local that only you can see. You have to click “OK” on the drop down menu, which means you cannot miss the request!

  • The system will run automatically. When someone clicks on the “Request” button, they are sent a private message in Local, and a drop down text box, telling them how to send you a request.
  • When you receive that request, it appears as a drop down menu with an “OK” button, clicking “OK” closes the menu.
  • Your request will also arrive as a message that only you can see in Local, you will also get a link to the persons Profile, in case you wish to contact them!
    ▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄ REQUEST RECEIVED ▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄
    Request from: Marcus Zenoria
    Request: Can I hear Shinedown - Unity please?
    To Reply: secondlife:///app/agent/538d6203-11d8-4d65-914e-8f5ea1c2ffb6/about
    ▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄ REQUEST RECEIVED ▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄
  • The tipper also gets a message:
    [04:12:14] Marcus's Tip Jar: Eric Tempest thank you for your request! I'll play that just as soon as I can!
You can also customise the response to the request and the channel if necessary. See Setting Up Request System.
Using Request System

The request system is activated by default. But turning it on or off is easy:

  • Touch your tip jar
    1. Click Admin
    2. Click Jar Config
    3. Click Requests
    4. Then choose On or Off

Controlling SHOUTcast Features

This tip jar features SHOUTcast integration. If you are a DJ or work in a club using a SHOUTcast stream, then you can enable this feature. This will display the current music track above the tip jar & also announce it in Local Chat if you wish.

Before you set up your SHOUTcast choices, ensure you entered your stream IP (URL) into the configuration note-card. See Entering SHOUTcast IP.
  • Now you have entered your SHOUTcast stream address, you need to enable the service on the tip jar
Enable SHOUTcast
  • Touch your tip jar
    1. Click Admin
    2. Click Jar Config
    3. Click SHOUTcast
    4. To turn on or off your SHOUTcast features click on S-Cast On or S-Cast Off
Control Announcements
  • Touch your tip jar
    1. Click Admin
    2. Click Jar Config
    3. Click SHOUTcast
    4. To turn of the broadcasting of the tracks in Local Chat click on Say On or Say Off

Stats & Lists

Your Tip Jar is set up to keep track of your tips and also how many requests it has received for information, group joins, gifts etc. It will keep a running total of tips you have received since you first set up the jar and also a total per gig. You can view these totals yourself with just the press of two buttons!

Tip & Giver Stats

Your Tip Jar will give you your tip and giver stats, since the last time you reset it and a money total since you set up the jar.

  • To do this
    1. Touch the Tip Jar
    2. Click Admin
    3. Click Tip Stats
    4. You will see a list of your givers and joiners, with how many clicks they have received, and also two money totals:
      • Total Tips - How much you have earnt since you rezzed the Jar
      • Overall - How much you have earnt since you started using that Jar

Viewing Tipper List

All your tip notifications are sent to you as private messages in Local chat. However, sometimes (especially in busy clubs) you maybe busy & you miss a tip coming in.

  • Your Tip Jar can give you this information.
    1. Touch the Tip Jar
    2. Click Admin
    3. Click Tip Stats
    4. Click Tippers
    5. You can reset this list by clicking on Clear

Resetting Tip & Giver Stats

You can reset your tip stats without re-rezzing the Jar:

  • To do this:
    1. Touch the Tip Jar
    2. Click Admin
    3. Click Reset All
    4. Click Yes Reset

Product Updates

Your Jip Jar will automatically check for updates every 10 days, when rezzed. However, if you want to check manually for an update, you can do that very easily:

  • To do this:
    1. Touch the Tip Jar
    2. Click Admin
    3. Click Update
    4. Your product will now connect to the MZD Update server to see if there is a newer version. If there is, you will receive a message and one will be sent to you.
    5. You can also go to any MZD Store and touch the Redelivery Terminal and have the latest items sent to you.

Please note: Certain operations on your Jar may take a few seconds to respond while checking for an update, this is best done when you are not working!


Getting Help

  • Need some help with your Jar?
    1. Touch the Tip Jar
    2. Click Help
    3. Click Go to page

Settings - Configuration Note-Card

Most Jar settings are stored on the configuration NC, this is not done by accident, it is done to prevent you from loosing all your settings!
Some tip jars out there, allow you to enter your settings by menu. This may seen like a great idea, but the problem is, if you decided to rez another copy for another club or gig, or should you be gigging when a SIM crashes, you run the risk of loosing all your settings and having to re-enter them all again.
Entering important settings by menu means that your settings are stored on the script. If you need to do a script restart, rez another copy or experience a bad SIM crash, will result in you loosing all those settings you have spent time to set-up!

Remember - Always Keep a Copy of your configuration note-card!
Before editing the note-card, drag it out of your Tip Jar and into your inventory so you will always have a copy!

Finding Config Note-Card

Your configuration note-card is stored in the Tip Jar. To find it do the following:

  1. Rez the Tip Jar
  2. Wait for the Configuration to load (10-15 sec )
  3. Right click and select Edit
  4. Select the Contents tab
  5. You will see your configuration note-card listed:
    • The settings note-card for your Tip Jar is named: _ulttjs_config

Editing Config Note-Card

Find and open your config note-card as [above]

  • You will see the settings listed:
# MZD Ultimate Tip Jars Config 5.0  -  Script Configuration File
 #  ***** PLEASE READ ONLINE INSTRUCTIONS BEFORE YOU EDIT *****
 #
  1. To make changes, be careful to always leave the first part of the line, the '=' sign and the space before & after the '=' sign and make your changes.
    • Not correct:
      • Local MessageHigh 5's for that rockin' tip
      • LocalMessage=High 5's for that rockin' tip
    • Correct:
      • Local Message = High 5's for that rockin' tip
  2. You can now edit the entries on the note-card
  3. Then press Save
  4. Your changes will be updated in your Jar

Hovertext Name

By default your Tip Jar uses your display name for the hovertext over your jar. You can easily change this by editing the configuration notecard. In the notecard find the line:

#
Hover Text Name = DISPLAYNAME
#

Change the text DISPLAYNAME to whatever you want it to read and save the notecard.

Changing Messages

Your Tip Jar has two Thank You messages that you can customise. These are used whenever a tip is received.
There is a local message (seen by everyone on local chat) & a private message to your tipper (seen by tipper only).
Start by opening the configuration note-card as [above]

#
Local Message = Thank you so much for that great tip 
Local Message 2 = It is much appreciated!
Private Message = DISABLED
#
Public Message
  1. The local message, is the message sent in local to the tipper that everyone can see, it is split into two parts
    • The main Thank You
    • And a 2nd part (added after the tippers name)
  2. Edit the part after the '=' sign
    • For example Local Message = High 5's for that rockin' tip
Save
Private Message

The private message is a message you can send to the tipper only. It is disabled by default, but you can enable it, just by adding a message:

  • For example: Private Message = If you would like a request, please send me an IM!
Save
Touch Message

You can customise the message that someone gets when they touch your Jar if you wish.
Open the configuration note-card as [above]

#
Menu Message = To tip me, please right click my Tip Jar and select "PAY".
#
  • For example: Menu Message = Click on the "Join Group" button to join my group, or to tip me, please right click my Tip Jar & select "PAY"
Save

Givers & Joiners

  • Your Jar is designed to give out a range of items, and to also allow your guests to join your group or view your website.
  • Certain designs in this range also have "Easy View" buttons, so that your guests can easily see and click on a choice without having to use the jar menu. These buttons use the same set-up as the Tip Jar menu buttons.
  • Can can use as few of these or as many as you wish. You can choose from:
    • Group Joiner
    • Web Site Link
    • Two separate 'Givers' that will give out landmarks, notecards, clothes or objects. So you can give out one or two items of whatever you chose, for example, your schedule, your booking info, or even a free gift!
  • If you disable these features in the configuration note-card, then no buttons will display and the tip jar will work just fine, so it's totally your choice whether you want to use them or not!

If you do want to use one or all of these features, here is how you set them up:

Group Joiner

Find and open your config note-card as [above]

  • You will see the settings listed:
# ***** SET-UP GROUP AND BOTS IF REQUIRED *****
#
# Enter your group key here:
Group Key = 00000000-0000-0000-0000-000000000000
  1. All you need to do to activate the group joiner is to paste the UUUID (or key) of your group into the note-card on this line.
  2. Several viewers will give you this key when you look at the group profile. If your's doesn't, simply rez the Group UUID Detector from your Tip Jar pack and follow the instructions to get your groups UUID.
  3. Save
  4. Your changes will be updated in your Jar and your Jar will give anyone requesting it a link to click on to join your group.
  5. To disable this feature just enter DISABLED or 00000000-0000-0000-0000-000000000000
Using A Bot

It is also possible to use a bot to send automatic invites for your group. These are much easier, for your guests to use, since all they have to do is to click on one button to join. This Jar is compatible with Smartbots and Pikkubots, should you wish to use one. To read more about bots read: Using Bots To Automate Your Group Invites

Setting Up A Bot

Find and open your config note-card as [above]

  • You will see the settings listed:
# ***** SET-UP TO USE BOTS *****
# MZD Tip Jars can work with Smartbot or Pikkubot
#    To use, enter Smartbot or Pikkubot for Bot Type
#       or leave it set to DISABLED if not required:
Bot Type = DISABLED
#
# For Smartbot 
#   enter Security Code    
Code = DISABLED
#
# If using Pikkubot
#   enter Pikkubot UUID
Pikkubot UUID = DISABLED
  1. Enter either Smartbot or Pikkubot for the Bot Type, depending on what type of bot you are using
  2. If using Smartbot, enter your Bot Security Code, or if using Pikkubot, enter your Bot UUID in the relevant places
    Save
  3. If you are using Pikkubot, that's all you need to do!
  4. If you are using Smartbot, then find the Smartbot administration script that came with your MZD Product. It will be named SmartBots AdminBot Professional v....
  5. Copy the Smartbot script into your Tip Jar inverntory, see here
  6. Your product is now set up and ready to use your bot for group invites!
Item Givers

You Jar can also give out items such as landmarks, clothes, notecards or even gifts. If you don't want to use these, simply enter DISABLED after each of the button names.

Before you edit the config nc, make sure you have added the all items needed to the inventory, see here.
  • Open the configuration note-card as [above] and find these lines.
#
Giver Button 1 = DJ Info
Giver Item 1 = DJ Info Pack
#
Giver Button 2 = DISABLED
Giver Item 2 = My Landmark Name
#
  1. In the first of the two items, it is set to give away an item (could be a NC, LM, clothing or object) called DJ Info Pack
  2. The button that is shown when a person clicks on the Jar will look like DJ Info
    (In any of the designs with Easy View buttons, Giver 1 is used to give out the Info note-card. If you aren't using one of our designs with an Info button, you can use this to give away anything you want!)
  3. In the example above, the second item will not work since it is set to DISABLED, but of course you can add a second item here instead!
    (In our Modern 4 Button Jar, Giver 2 is used to give out the Gift. In any other jar, you can use this to give away anything you want!)
  4. Save

Setting Up SHOUTcast

Before you can use your Tip Jars integrated SHOUTcast system, you need to enter your stream address into the jars configuration note-card.

  • Open the configuration note-card as [above]
  • Find this line:
#
ShoutCast URL = http://my.stream.address
#
  1. Change the entry to your own Stream IP (URL)
    • If you have been given a stream address with a / on the end, you must remove it
      • This is incorrect: SHOUTcast URL = http://mystream.com:8080/
      • This is correct: SHOUTcast URL = http://mystream.com:8080
  2. Save
Please Note: You have now set up your SHOUTcast stream information. You now need to read Controlling SHOUTcast Features.

Setting Up Request System

Your tip jar features an integrated MZD DJ Request system. For information on how to control the request system see Controlling Request System. But you can also customise some of the Request System features in your configuration note-card.

  • Open the configuration note-card as [above]
  • Find these lines:
#
Request Channel = 96
Request Confirmation = thank you for your request! I'll play that just as soon as I can!
  1. Your request system uses channel 96 by default. Normally there is no reason to change this, unless you find something else in the SIM using the same channel.
  2. To change the channel, simply replace 96 with another channel. DO NOT use 1 as a channel.
  3. When a request is received your system sends an automated confirmation to the person sending it.
    • The confirmation starts with the name of the person requesting the song and adds your chosen message:
      • For example the default gives you:
        [04:12:14] Marcus's Tip Jar: Eric Tempest thank you for your request! I'll play that just as soon as I can!
  4. You can edit this message as you wish
  5. Save
Please Note: You have now set up your Request settings You now need to read Controlling Request System.

Customising

Remember - Always Keep a Copy!
Save any changes you make to the Tip Jar by “Taking” it into your inventory after you have finished.
This ensures you always have a back-up copy!

Naming Your Tip Jar

Want to change your jars name?

By default your Tip Jar will be automatically be named as “Your First Name's Tip Jar”, so if it were my Jar it would be named “Marcus's Tip Jar”.

If you wish to change your Tip Jar name to something different, then simply do the following:

  1. Rez the Tip Jar
  2. Wait for the Configuration to load (10-15 sec )
  3. Right click and select Edit
  4. Select the General tab
  5. Enter your chosen Tip Jar name into the Name: field
  6. Close the Edit window
  7. Right click and select Take

Your Tip Jar is now renamed and in your inventory.


Resizing Your Tip Jar

Want to make your Jar bigger or smaller?

  • Then simply do the following:
    1. Rez the Tip Jar
    2. Wait for the Configuration to load (10-15 sec )
    3. Right click and select Edit
    4. Select the Object tab
    5. Select Stretch
    6. Use the white corner squares to increase or decrease the size
    7. When happy, close the Edit window
    8. Right click and select Take

Your Tip Jar is now resized and in your inventory.


Adding Items To Your Jar

Your Tip Jar can use a texture or even more (as a slideshow) from your inventory, instead of your profile picture.
It will also give away certain items when requested. These can be notecards, landmarks, clothing or objects.
You will need to set up thing to give away in the configuration note-card (above), but before you can do that, you need to add them to the tip jars inventory.
So, whether it is a texture to display or an item to give away, you need to put them into your Tip Jar inventory.

Never drag a texture out of your inventory & onto the surface of your Tip Jar to texture, always drop it into the inventory as described below:
  • To do this:
    1. Right click on your Tip Jar & select Edit
    2. Select the Contents tab
    3. Drag your item/s from your viewers inventory to the jars Contents
      • You must have permissions to copy anything you add to the Jar, but the permissions you set for the next owner aren't important.
    4. Close the Edit window
    5. Wait for the Configuration to load (10-15 sec)


Support Issues

Have you got a question or a problem with one of our products?

  • Then we need to hear from you!
  • Product problems are bad for business, and we value your business!
  • Please use our Product Support page to report a problem or ask a question
    We will contact you with a fix or a replacement product as soon as possible.
Product Support >>>

Our Guarantee
Our Guarantee