Documentation · Shower AVsitter Plugin
Shower AVsitter Plugin script in Marketplace.
Thank you for having considered this script to enhance the quality of your products. Please read the following instructions carefully, especially the ones explaining which permissions to apply to the scripts for the next owner. Failure to complete this task INVALIDATES the license governing your use of this set of scripts. Should you have problems, please fill the scripts assistance form, explaining what you did and what happened, and I'll get back to you.
IMPORTANT! The script contains a check to prevent accidental give-aways. If you haven't set permissions correctly in your inventory, then the script will self delete when you try to use it. The best way to ensure you set permissions correctly is by doing it NOW in your inventory.Follow these directions carefully. Complete the Step by Step Guide in the first place and then go to the Advanced Setup section for a detailed explanation of all the features. There's a Troubleshooting section at the end. Before asking for help, check that your problem isn't one of the problems described in there.
License of Use: Click here to read the License of use.
What's included in your purchase
Check that your box contains the following assets:
- [Black Tulip] Shower - AVsitter Plugin
- [Black Tulip] Shower - AVsitter Plugin ~CFG~
- [Black Tulip] Proof Of Purchase - Shower Plugin v1
- [Black Tulip] Shower - AVsitter Plugin ~DOC~
- [Black Tulip] Water Particle Shower #1
- [Black Tulip] Water Particle Shower #2
- [Black Tulip] Water Particle Shower #3
and these sample assets, necessary to follow the step-by-step guide:
- [Black Tulip] Shower #1 - START HERE
- [Black Tulip] Water Sounds - Flow #01
- [Black Tulip] Water Sounds - Flow #03
- [Black Tulip] Water Sounds - Flow #05
- [Black Tulip] Water Sounds - Flow #06
- [Black Tulip] Shower #1 - FINISHED SAMPLE
- [Black Tulip] Shower #1 - WITH MOVING DOOR
If any of these is missing, contact Auryn Beorn for a replacement. Keep in mind that sample assets are never provided in full perms state. They're included to illustrate how to use the script. The soundclips in particular, are part of a set that is a group gift.
Features list
Sit on the shower and the water will run. Access from AVsitter to a menu that will let you:
- Turn the water on/off while in the shower
- Select one from up to nine sound clips - or no sound at all
- Change the sound volume
- Have up to two particles effects (falling water and steam)
The water is particles based. Three particles textures are included.
Step by Step Guide
Rez the sample object [Black Tulip] Shower #1 - START HERE, which is already prepared with a couple of animations and the AVsitter engine:
Our goal will be preparing the object so the following actions are possible:
- We'll decide on which sounds we want to offer, and add them to the configuration notecard.
- We'll make a particles effect that will fall from the shower head.
- We'll make a particles fog effect on the shower floor, where the drain is placed.
- We'll add a button under the [ADJUST] menu of AVsitter, to access to our shower menu.
Offering sounds to the user
We'll offer the following sounds (available as samples, for the sake of demonstration):
- [Black Tulip] Water Sounds - Flow #01
- [Black Tulip] Water Sounds - Flow #03
- [Black Tulip] Water Sounds - Flow #05
- [Black Tulip] Water Sounds - Flow #06
The sounds must show on the menu, so we have to give them a name. How? For example, writing this on the [Black Tulip] Shower - AVsitter Plugin ~CFG~ configuration notecard
sound = Water 1 | [Black Tulip] Water Sounds - Flow #03 sound = Water 2 | [Black Tulip] Water Sounds - Flow #01 sound = Water 3 | [Black Tulip] Water Sounds - Flow #05 sound = Water 4 | [Black Tulip] Water Sounds - Flow #06
Notice the format. First we write the keyword sound, then an = sign, and then we write the rest of the line following the format:
MenuLabel | SoundclipInObject
The first part is what will show as a menu button (so don't write anything larger than 24 bytes), and the second part is the name of the sound clip, the file name of the sound clip we'll drop in the object.
The [Black Tulip] Shower - AVsitter Plugin ~CFG~ configuration notecard is actually prepared to be used, so we're explaining what are the parts you see there, to know what to modify in your own builds.
Particles effect that will fall from the shower head
First, we have to give a specific description to the prim where the particles will emit. This description is:
Our shower sample has been designed so particles will emit exactly from the shower head, but if your object isn't ready this way, you can always rez a box, make it small, transparent, and place it where particles should emit.
Then we would need to tweak the [Black Tulip] Shower - AVsitter Plugin ~CFG~ configuration notecard, all the parameters beginning by p1 that are under the comment line:
# Particles definition of the SHOWER effect
However, preparing particles effects might be complicated, so the configuration notecard is already prepared with this effect for you :-)
We must check one line, though. This one:
p1Texture = [Black Tulip] Water Particle Shower #2
Change the permissions to the [Black Tulip] Water Particle Shower #2 texture (the one indicated in that configuration line of the notecard), and add it in two places. Drop it in the root prim with the AVsitter script, animations...
and now also drop this texture on the shower head prim, the prim from where particles will emit:
If we don't do this, then we would see big white dots instead of our particles.
Particles fog effect on the shower floor, where the drain is placed
This part is similar to the shower effect. First, we have to give a specific description to the prim where the fog/steam particles will emit. This description is:
Notice that we're giving the description to a transparent box that is strategically placed so the steam will come from the shower floor.
Then we would need to tweak the [Black Tulip] Shower - AVsitter Plugin ~CFG~ configuration notecard, all the parameters beginning by p2 that are under the comment line:
# Particles definition of the FOG (BOTTOM) effect
Just like before, preparing particles effects might be complicated, so the configuration notecard has too the fog/steam effect already prepared for you :-)
Similarly to the previous case, we must check one line, this one:
p2Texture = [Black Tulip] Water Particle Shower #1
Change the permissions to the [Black Tulip] Water Particle Shower #1 texture (the one indicated in that configuration line of the notecard), and add it in two places. Drop it in the root prim with the AVsitter script, animations...
and now also drop this texture on the transparent box prim, the prim from where particles will emit:
Like in the other case, if we don't do this, then we would see big white dots instead of our particles.
Pro-Tip: Preloading the particle textures
Since the box is completely transparent (by adjusting the transparency value to 100%), we could texture one face with one of the particle textures, and another face with the other particle texture. The box remains invisible, but this forces loading those textures, so when people sit on the shower for the first time, the particles textures are already loaded and will avoid the ugly loading time where we see gray rectangles.
Adding a button under the [ADJUST] menu of AVsitter, to access to our shower menu.
This part is really simple. Edit the AVpos notecard, and make sure of having this text at the top of the notecard:
ADJUST [SHOWER]|-31430000
Now drop the [Black Tulip] Shower - AVsitter Plugin ~CFG~ configuration notecard in the shower object, together with AVsitter and the animations. Drop the soundclip files as well.
Then, change permissions correctly to the [Black Tulip] Shower - AVsitter Plugin script, and drop it in the shower object, with all the other assets.
Reset the AVsitter scripts, and once they've reloaded the AVpos notecard, jump in the shower (effects should start then!) and there will be a [SHOWER] button under AVsitter's [ADJUST] menu:
which, when clicked, shows the shower menu:
The shower menu has a button to go back to AVsitter.
Other things you could do
If you have our Moving Parts AVsitter plugin, you can create effects like having the glass door open when no avatars are using the shower, but closing it when there are avatars inside the shower. The sample [Black Tulip] Shower #1 - WITH MOVING DOOR object shows the effect.
Advanced Setup
Tweaking the particles effects requires of particles knowledge. It's not the purpose of this documentation to teach particles, so we'll mention a few relevant parameters and how to write them correctly in the notecard.
Description Format
This script can be used in conjunction with many other of Black Tulip's scripts as long as we remember this: If two scripts need using the description field, we will separate their values with the # character. Each script will read the part of the description needed and both will be able to coexist together. If it's three, then same rule applies: separate each description part with #
For example, if we're using the texture change and this script in the same object, the description of a prim that both emits the water shower effect and changes textures should be written like this (example values):
t;mirror#showerNotecard Configuration in Detail
SECTION UNDER CONSTRUCTION
Troubleshooting
We haven't been notified of issues at the moment.
If after having followed the directions and checked the troubleshooting list, you have problems making the script work, please click here for the customer service form.
