Friday, May 19, 2017

Script: Hand Poses AVsitter Plugin

Documentation · Hand Poses AVsitter Plugin

Hand Poses AVsitter Plugin script in Marketplace.

Bento's arrival to SL opened a whole world of possibilities to make our creations even more featured than before. With this script, you can play Bento hand poses together with older animations in AVsitter so your engines become more realistic and fun. The best of all is that you don't have to ditch your old animations because they don't have hand poses. All you need is adding Bento hand poses specifically designed, like our hand poses kit to enhance dining animations like holding a spoon, a wine glass, a knife and a fork, and more (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] Hand Poses - AVsitter Plugin 1.0
  • [Black Tulip] Hand Poses - AVsitter Plugin ~CFG~
  • [Black Tulip] Hand Poses Notecard Aux. Tool
  • [Black Tulip] Hand Poses - AVsitter Plugin ~DOC~
  • [Black Tulip] Proof Of Purchase - Bento Hand Poses Plugin v1

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

  • [Black Tulip] Dining Set #2 - Sample w.AVsitter
  • [Black Tulip] Hand Poses - Wine #3 (P5)
  • [Black Tulip] Hand Poses - Spoon #2 (P5)
  • [Black Tulip] Dining Set #2 - Sample w.AVsitter - COMPLETE

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.

Features list

  • Define one or more hand poses to be played when a specific animation has been selected in AVsitter
  • If an animation has no assigned hand poses, then the default hand position takes over
  • AVsitter 2 ONLY

Step by Step Guide

The first thing we need is a finished AVsitter engine. When you're done setting up your engine with all the animations, props, etc., then you can begin using this script. There's a finished AVsitter engine already set up to learn using this script, so we'll use it for this purpose. Rez the [Black Tulip] Dining Set #2 - Sample w.AVsitter sample object:

and inspect its contents: it contains poses, wearable props and the AVpos notecard.

Extract the AVpos notecard in your inventory:

Now rez a box, drop the AVpos notecard in its contents:

Then drop the [Black Tulip] Hand Poses Notecard Aux. Tool auxiliary script to help us build the configuration notecard that the hand poses script needs. We will get something like this in local (nearby) chat:

We can now delete that box. Let's copy the text on a plain text editor in our computer:

We do some clean-up:

and now it's time to complete the information to then copy on the configuration notecard. The first question to answer is, what's the maximum number of sitters using this engine? In this case is 2, for it's ready for a couple, so we write the following in the maxSitters line:

If your engine is meant to be used by five avatars, you would write maxSitters = 5 and so on.

The next step is deciding which sitter will be using an additional hand pose for every animation in the AVsitter menu. Our sample engine has three animations that play for both sitters 0 and 1:

  • Wine for her
  • The Spoon
  • Wine for him

For the sake of our learning example, our decision is that:

  • When the animation Wine for her plays, we'll also play the [Black Tulip] Hand Poses - Wine #3 (P5) hand pose on the female avatar.
  • When the animation The Spoon plays, we'll also play the [Black Tulip] Hand Poses - Spoon #2 (P5) hand pose on the female avatar.

and that:

  • When the animation The Spoon plays, we'll also play the [Black Tulip] Hand Poses - Spoon #2 (P5) hand pose on the male avatar.
  • When the animation Wine for him plays, we'll also play the [Black Tulip] Hand Poses - Wine #3 (P5) hand pose on the male avatar.

Sitter 0 is the female avatar and sitter 1 is the male avatar, so we locate first the lines our auxiliary tool wrote for sitter 0, the female (realize about the number 0 written in these lines):

delete those we won't be adding hand poses to:

and then write the corresponding hand pose file name per Animation line, at the end:

We now locate the lines our auxiliary tool wrote for sitter 1, the male (notice the number 1 written in these lines):

delete those we won't be adding hand poses to:

and then write the corresponding hand pose file name per Animation line, at the end:

Notice on the AVpos notecard that there are different objects assigned to be attached to the female and male avatars:

PROP1 Wine for her|[Black Tulip] Din.Att#1 - Wine Glass - Full - POSITIONED|GROUP1|
PROP1 The Spoon|[Black Tulip] Din.Att#1 - Cutlery - Spoon - POSITIONED|GROUP1|

PROP1 The Spoon|[Black Tulip] Din.Att#1 - Cutlery - Spoon - Him - POSITIONED|GROUP1|
PROP1 Wine for him|[Black Tulip] Din.Att#1 - Wine Glass - Full - Him - POSITIONED|GROUP1|

Although the object is the same, two copies are needed, since the male and female avatars need them positioned differently. Keep this detail in mind when you create your own engines.

We're almost done! Lets have a look at the complete text we've been working on our plain text editor:

Now make a copy of the [Black Tulip] Hand Poses - AVsitter Plugin ~CFG~ notecard, open it:

Copy and paste on it the text from the plain text editor:

and save it.

When the notecard is saved, drop it into the [Black Tulip] Dining Set #2 - Sample w.AVsitter sample object, together with the AVsitter scripts. Also, drop the two hand poses that will be used, [Black Tulip] Hand Poses - Spoon #2 (P5) and [Black Tulip] Hand Poses - Wine #3 (P5):

Finally, drop the [Black Tulip] Hand Poses - AVsitter Plugin 1.0 script after having changed its permissions... and because we have two sitters... Drop it AGAIN! Yes, we have two sitters, so we need TWO copies of the script in our engine:

Notice how SL renames the second copy of the script by adding a number 1 to the end. This is completely normal. You have five sitters? Then you drop five copies. The last one would have a number 4 to the end.

Wait for both scripts to load, and it's ready to go! Now sit two avatars and observe how the hand poses change depending on the selected pose, according to the configuration notecard.

Included, there's a finished object with everything ready, [Black Tulip] Dining Set #2 - Sample w.AVsitter - COMPLETE. You can use it to compare your set up when practicing this step by step guide.

May you create wonderful things with this script :-)

Advanced Setup

We've learned how to add one hand pose per animation in AVsitter, but the script can play several hand poses per animation. Think for example of holding a knife and a fork, having separate animations for holding the knife and the fork. You then need this advanced bit.

Notecard Configuration in Detail

The format of an animation line is as follows:

Animation = AnimationNameInAVsitter | Sitter | PoseFileName,PoseFileName,...

This is, when we want to play more than one hand pose at once, all we have to do is writing the animation file names at the end, one after the other, separated each one by a comma.

Two warnings:

  • Because the comma is the separator character, do not use a comma as part of the animation file name.
  • While you can have more than one pose at once, the script won't read more than 255 bytes per line (this is a SL limit): keep the file names short if you need many. You can rename the hand poses to make their names shorter.

New in v1.1

Use this line on top of the AVSitter notecard:

ADJUST HANDS|-31450000

to get a HANDS button under AVsitter's [ADJUST] menu that will turn on/off the hands plugin.

Once all sitting avatars have abandoned the furniture, HANDS mode turns back to on.

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.