Unique Applause - adrianomesl/script_shack_support GitHub Wiki
SS{sng}'s Unique Applause system is composed of two parts:
-
Applause machine. The object with which the public interacts by touching it. There can be multiple machines rezzed at the same time.
-
Updater. An object that makes it easier to change settings in bulk to all rezzed machines and on-the fly. No more than one updater is needed or even recommended.
When an avatar touches the Applause machine the following happens:
-
Play a sound. The sound is picked semi-randomly from a list of predefined sounds.
-
Emotes as the touching avatar. The phrase said in local chat is picked semi-randomly from a list of predefined phrases. Emotes can be turned of, in which case only the sounds (if there's any) will be played.
The Applause machine is a must-have gadget for venues where attendance is meant to applaud live performers.
A configuration file will be processed up to the first 60 000 bytes. Everything beyond this limit will be ignored to prevent the script from crashing due to memory overflow.
When updating the machine with a new set of emote phrases, it helps to sort the lines by length from shortest to longest. This way more lines will fit.
If you have more lines than the script can process, split the file and use the updater to strategically load new phrases during the show.
Applause machine is configured via a notecard. The settings are grouped in the following optional sections:
- [General]
- [AdminGrantList]
- [EmoteVars]
- [Emotes]
- [Sounds]
ShowEmotes (yes|no) - Default: yes
Whether the emote should be said in local chat or not.
ClickPause - Default: 0
Time to wait between clicks of a single avatar. This pause 8does not* apply to clicks from different avatars.
ClickPause - Default: 0
Time to wait between clicks of a single avatar. This pause 8does not* apply to clicks from different avatars.
StatusMessages (hover|local|none) : Default hover
When Applause machine is in a state other than running (initializing, updating, admin mode, etc.) clicks are disabled or enabled only to admins.
To help everybody know what's going on a hover text is shown by default above the machine object.
There are three possible outputs for these messages:
- hover (default). Shows in hover text.
- local. Messages are whispered in local chat.
- none. No messages are displayed.
List of UUIDs of the avatars that are granted administration access to the machine. Having administration access means that they avatar can open and interact with the administration menu which provides a way to modify the [General] settings.
Each lime must have only one UUID, without spaces before or after.
We can define variables to be used in emote phrases to inject values in real time. A variable must have a name and a value; as shown in the example below:
ArtistName = Paradorn
List of phrases that are emoted in local chat by the avatar who clicks on the machine.
Since these are emotes the phrases must be written in third person not including the author, for example: screams loudly.
If we want to inject a variable we just use the name of the variable enclosed by {} like this: screams {ArtistName}'s name loudly. When this phrase is emoted everyone will see: ... screams Paradorn's name loudly.
Variables are not needed in most cases because the Applause machine allows us to update phrases on the fly, so we can just hardcode the artist name in the phrase. However, using variables makes it easier to share phrases with other Applause users.
Don't worry if all this is a bit confusing now. Just know that the feature exists and go on using the Applause machine without variables. You'll find out what they are good for when you need them.
You can use any Unicode characters listed in the following page:
https://wiki.secondlife.com/wiki/Unicode_cheat_sheet
You may use as many sounds as you want. The number is limited by available script memory. Keep in mind however that the script itself uses memory, as well as the list of emote phrases and, if you are using throttling, a record of users who have touched the object is also kept.
There are two ways you can use sounds:
-
Sound name. If you have restricted permissions on a sound; the only way you can use them is to copy them inside the object hosting the script and invoke them by name.
-
Sound UUID. If you have enough permissions on a sound you own, you can use it's UUID. Also, if you know the UUID of a sound you don't own but it's available in SL, you can use it.
To get the UUID of a sound you own:
- Open your inventory and look for the sound file.
- Right-click on the sound to open the contextual menu.
- Click the option: "Copy Asset UUID".
This will copy the UUID in your clipboard. From there, go to the settings notecard and paste the value as a line below the section titled [Sounds].
While in running state we can put the Applause machine in admin mode. For this we need to click on the object and hold down the mouse key for 3 (three) seconds or more. If the avatar doing this is the object's owner or its ID is listed in the AdminGrantList, the admin menu will popup.
The admin menu allows to modify the running settings that are under the [General] section.
Applause machine is designed to make it easier for venue owners or officers to adjust it's behaviour by taking a configuration file on-the-fly while in running state.
For this we need a second object: the Applause machine Updater. We are going to discuss this in following sections.
If there are multiple machines running near an Updater, all of them will receive the new configuration file. This process is ideal for situations when multiple artists perform live one after the other and we want each of them to have a distinctive set of emotes.
An object hosting the updater script can communicate with machines and give them a configuration notecard.
The updater is is configured via a notecard. as of version 1.0.0 the only setting available is the [AdminGrantList] which, if present, should be exactly the same used for the Applause machine.
If no grant list is given, the only one allowed to interact with it is the object's owner.
As we mentioned before, the job of the updater is to transfer a notecard with configuration settings to Applause machines nearby.
Administrators can create up to 9 (nine)(*) configuration notecards and put them inside the Updater's inventory.
If an administrator touches the Updater while it's in running state an administration menu will popup containing one button for each available notecard. Touching a button will trigger the dialog between Updater and nearby machines, resulting in the corresponding notecard being transferred to all the machines.
When an Applause machine receives a configuration update, it processes it, it deletes it and goes back to running state with the new settings applied.
We are here to help. Use the Contact page to learn how to ask for help.
If this page was not helpful enough or it's out of date; please let us know; we want to make it better!.