Check that your box contains the following assets:

• [Black Tulip] Fireplaces v2
• [Black Tulip] Fireplaces v2 ~CFG~
• [Black Tulip] Fireplaces v2 - AUXILIARY TOOL
• [Black Tulip] Fireplaces v2 - AUXILIARY TOOL ~CFG~
• [Black Tulip] Proof Of Purchase - Fireplaces v2
• [Black Tulip] Fireplaces v2 ~DOC~

and these sample assets, necessary to follow the step-by-step guide:

• [Black Tulip] Fireplace #1 - Start Here
• [Black Tulip] Fire Crackling
• [Black Tulip] Fireplace #1 - Finished Sample

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.

• Starts/Stops all the fire effects (animated textures, particles)
• Light on/off for the light points we define
• Light menu options
• Access menu options
• It can work with AVsitter or standalone
• New clickMode variable, shows the menu when you want it to

The configuration notecard has already set up two particles effects (sparks and smoke), so we're going to make this step by step guide as short and simple as possible. Let's rez the sample object [Black Tulip] Fireplace #1 - Start Here

and think in what we want to achieve from it:

• When we turn the fireplace on, the animated fire will light, sparks and smoke particles will emit.
• When we turn the fireplace off, the animated fire will disappear, the sparks and smoke particles will stop.
• While it's on, we want a sound clip for fire crackling noise
• We want to set up a light point so when we turn the light on/off, the light will emit from that point we've decided.
• We want that this menu shows on touch, unless it's setup together with another engine like AVsitter; then it will show only from the corresponding AVsitter button

This is telling us one thing: some prims are special, and they need to be recognized by the script, somehow. This somehow will be by writing things in the corresponding prim description (don't confuse it with the prim name).

First we will decide which prim will be the particles smoke: the logs. So we click on Edit linked, click on the logs prim, then click on the General tab, and change the description this way, to the word smoke:

Now we decide which prim will be the particle sparks: the animated fire. Still with Edit linked checked, we select that prim, make sure we're on the General tab, and write this description, sparks:

If we want that this prim is also the light point, then we add the # character as a separator in the description, and after it, we add the word light. The whole description is now sparks#light as the picture shows:

This animated texture turns on and off, so we're not done yet. First, the script has to know how to animate it. We write another # character in the description and then the following data, sparks#light#flames;19;1;1;0.5;-1 :

In the advanced section we'll see what flames;19;1;1;0.5;-1 means and how to obtain it.

Finally, we have to tell the script how transparent it is this prim when showing, and how transparent when in off state. We can also specify glow values. So we write another # character and the following, showHide=a:

being the final description for this prim sparks#light#flames;19;1;1;0.5;-1#showHide=a

This last part is only to identify the prim as special, as a prim that will show and hide when turned on and off. It needs of a second part: Information on the configuration notecard to tell what happens exactly when on and when off. The auxiliary tool will tell us what to write on the configuration notecard. We study it in the next section.

So far, we've set up the following:

• Source of smoke particles
• Source of sparks particles
• Light source
• Animated texture prim parameters
• We've marked this prim too as a prim that will show/hide when the fire is on/off, the rest of the definition of this being in the configuration notecard

The rest of the parameters are set up in the notecard, to help things being simple in your first time using the script. The particles go at the end because they're a long section. We can write above those parameters the necessary ones to make the animated fire show and hide. In order to obtain the specific values we want, we use the auxiliary tool that we explain in the next section.

Close the edit window if it still was open, and let's continue.

The auxiliary tool helps us to obtain the values the script expects for the prims that should show/hide when we click ON/OFF. Those prims must be already identified, like we've shown (the parameter showHide=name) in the description, and now we're using the auxiliary tool to set them up.

To use it, we first drop the [Black Tulip] Fireplaces v2 - AUXILIARY TOOL ~CFG~ configuration notecard into the contents of the fireplace, and after it, the [Black Tulip] Fireplaces v2 - AUXILIARY TOOL script. The script is immediately ready to work.

When we do this, we set the prims that show/hide with the transparency and glow that we want for them when we turn on the fireplace.

Then we click for the menu:

and select the SAVE F.ON option. This outputs text in local chat:

Now we make the fire prim completely transparent (and remove the glow):

Then we click on SAVE F.OFF, which outputs the following text in chat:

Now with those lines, we add them to the main [Black Tulip] Fireplaces v2 ~CFG~ configuration notecard. You'll find them added to help in this first experience, but remember that you have to do this with yours, removing these example lines and changing them with yours.

Once we're done with the auxiliary tool, we click for its menu and select [DELETE]. This will remove the [Black Tulip] Fireplaces v2 - AUXILIARY TOOL script and its configuration notecard, [Black Tulip] Fireplaces v2 - AUXILIARY TOOL ~CFG~, from the prim's inventory.

Drop the included [Black Tulip] Fire Crackling sample sound in the fireplace object's contents. Then drop the [Black Tulip] Fireplaces v2 ~CFG~ configuration notecard. Then change permissions for next owner of the [Black Tulip] Fireplaces v2 script, and drop it in too. The script starts reading the configuration notecard. Once it's done, your fireplace is ready to go!

We discuss in the next section all the related notes about the advanced setup, including how to make this script work with AVsitter. Read those notes carefully.

There's a finished fireplace included so you can compare with your own setup, in case you run into trouble. It's the [Black Tulip] Fireplace #1 - Finished Sample object.

The advanced setup of this script involves the following:

• Learning how to set up the animated texture (Description Format)
• Learning a note on the prims marked with showHide (Description Format)
• Learning the parameter clickMode of the configuration notecard, which allows us, among others, to be able to use this script with AVsitter and others (Notecard Configuration in Detail)
• Learning the button parameter of the configuration notecard (Notecard Configuration in Detail)
• Learning important details about the particles setup (Notecard Configuration in Detail)

Q: I've set textures in the configuration notecard, but instead I keep seeing circles. What can be done to fix this?

A: Remember this note from the documentation.
IMPORTANT: If you plan on using a particles emitter that is not the root prim (most likely case), then you must drop the texture in the prim with the script and in the emitter prim. If you don't do this, you will see the default texture, a circle.