AVsitter2 | AVsitter™ documentation

Edit me

How to get AVsitter2

AVsitter2 can be freely obtained from GitHub and imported into Second Life by following our import guide.

Tip: If you would prefer a packaged version of the latest release, and to receive in-world updates of future releases, visit the SL Marketplace or Kitely Market. Proceeds from marketplace sales are shared with open-source contributors and help support continued development.

Inside the AVsitter2 Package

The main AVsitter package contains:

[AV]sitA & [AV]sitB scripts

The main scripts that must always be used in a pair (A+B), one pair for each avatar to sit. Each pair will define a SITTER.
[AV]adjuster script & [AV]helper object

These are setup items that allow the default pose positions to be adjusted.
AVpos notecard

AVsitter data needs to be saved in an AVpos notecard. The notecard provided is intentionally empty.
Examples [BOX]

The AVsitter Examples [BOX] contains several example items that demonstrate the use of the system. The imprtance of the examples is often overlooked. Please examine the examples closely to understand how the system can be used for different setups.
Utilities [BOX]

The Utilities [BOX] contains the Utilities.
Plugins [BOX]

The Plugins [BOX] contains scripts that provide special functionality, along with examples. Example items are provided for each script.

Requirements

There are some basic requirements to use AVsitter:

You will need to have a beginner's knowledge of building in Second Life.
You will need to purchase animation files from animation stores in SL or learn to create them yourself.

Setup

Basic Prim Setup

The most basic setup is a prim that seats one avatar.

Drop the following into an empty prim in your furniture:
- [AV]sitA + [AV]sitB scripts
- [AV]adjuster script
- [AV]helper object
- AVpos notecard
- The animation files you plan to use
Note: One pair of [AV]sit (A+B) scripts will mean the prim has one SITTER.
Sit on your furniture, and the menu will appear (if you lose the menu just touch your furniture again to get the menu back).
Choose [ADJUST] then [HELPER] from the menu, and the [AV]helper stick will rez.
Choose [NEW] from the menu, then choose [POSE] to create a singles pose.
After creating a pose, adjust its position by moving the helper stick with the SL building tools until your avatar is in the correct position. Click [SAVE] for each pose you create before moving on to the next.
When you have finished saving all your poses, click [DUMP] to output your settings into chat.
Note: If you use a translator, turn it off before pressing [DUMP].
Copy-paste the [DUMP] result into your AVpos notecard, replacing the contents of the notecard.
Note: A web link is now given as a link at the end of the settings [DUMP], which is more reliable than copying from SL chat.
If required, you can rez the [HELPER] again and add more poses.
To add poses to other prims in your object, simply repeat the process.

Important: When you [DUMP] you’ll see the diamond character (♦) on every line. All text on a notecard line before the diamond is ignored by the script. This allows you to copy-paste chat output directly into your notecard without having to remove the timestamp from every line. If you remove the timestamps from your notecard then you can safely remove the diamonds.

Tip: Once setup is complete, you can (optionally) remove the [AV]helper and [AV]adjuster from your furniture. Leaving them in will allow the next owner to modify and [SAVE] the default pose positions (although they will not have access to [DUMP] or [NEW] unless they are an AVsitter2 owner).

Basic Setup Video

Tip: If English is not your language, the videos have captions for automatic translation.

Couples Prim Setup

Setup of a prim for multiple avatars is the same as for Basic Prim Setup, with a few additions:

Your object must have a prim count equal to or greater than the number of avatars you plan on sitting.
You will need to drop one pair of [AV]sit (A+B) scripts into the prim for each avatar you want to sit. i.e. For 2 sitters you'll need 2 pairs of [AV]sit (A+B) scripts.
Note: SL should automatically name your scripts sequentially when you drop them in together. Please make sure it does this correctly, as the names must be sequential. i.e. [AV]sitA, [AV]sitA 1, [AV]sitB, [AV]sitB 1
In the [NEW] menu, choosing [POSE] will create a singles pose and choosing [SYNC] will create a couples pose.
Note: Choosing [POSE] will add a singles POSE only to the menu of the SITTER you are on. Press [SWAP] first if you need to move to a different SITTER’s menu before adding the pose. The active SITTER # is listed in the menu.

Note: Choosing [SYNC] will add a SYNC pose to the menu of multiple SITTERs (e.g. SITTER 0 and SITTER 1).

Important: Singles poses should be positioned so that they do not overlap the positions set for other sitters. e.g. SITTER 0 poses on left-hand side of the furniture, and SITTER 1 on right-hand side.

Important: The first pose in each SITTER is the default pose for the seat. Even in couples furniture, you should usually make the first pose in each SITTER’s menu a singles POSE.

Couples Setup Video

Tip: If English is not your language, the videos have captions for automatic translation.

Submenus

To create a submenu…

In the [NEW] menu, choose [SUBMENU]. This will create a submenu only in the menu of the SITTER you are on.
Navigate to your submenu and then create new [POSE], [SYNC], or [SUBMENU] inside the submenu.

Note: [SUBMENU] will only add to the menu of the SITTER you are on. If want to have the same submenu in another SITTER’s menu, you will need to press [SWAP] to move to the other SITTER and create the submenu there too.

Important: If adding a [SYNC] pose, the pose will be added to whichever submenu was last selected. This applies separately to each SITTER’s menu. You will need to press [SWAP] to move to the other SITTER and create/select the submenu there too.

Important: Adding poses to submenus via the [NEW] menu is for beginners. You can create, re-order, rename, delete submenus by learning the TOMENU and MENU commands covered in the Notecard Section.

Camera

To save a camera position…

In the [NEW] menu, choose [CAMERA] then [SAVE]. This will save your camera view for all sitters in the prim.
To remove all camera settings from the object, choose [CAMERA] then [CLEAR].
Changes to camera settings will take effect the next time you sit.

Note: The camera setting is a prim property and does not require anything to be placed in the AVpos notecard.

Warning: For camera settings in multiple prims, be aware of JIRA BUG-5494.

Note: If you need a different camera position for each pose, see information for the [AV]camera script instead.

Chat Commands

The following chat commands can be typed into local chat while the [AV]adjuster and [AV]helper are in the furniture:

/5 helper - rezzes the helpers (alternate to using menu).
/5 cleanup - deletes the [AV]adjuster & [AV]helper from the prim.
/5 <avatar uuid> - moves the helper into the exact position of another avatar. Useful for copying positions from poseballs.
/5 targets - briefly shows the SitTargets in hovertext.

Making Corrections

If you do not get things right the first time, you can always make corrections or additions:

To change the position of a pose, or to add new poses, you can always select [HELPER] again, position the pose, and [SAVE]. Remember to [DUMP] your settings again and save them to the AVpos notecard after making any changes.
If you want to rename or change the order of any menu items you can manually edit the AVpos notecard.
To delete a pose, you must manually remove the lines from the the AVpos notecard.
As with all building in SL, you should take a backup of your work regularly to avoid losing progress.

Advanced Setup

The [NEW] menu described on this page is a great way to start using AVsitter, however you will have much more control when you learn to edit the notecard manually. After you can follow the tutorials on this page you should then learn the format of the AVpos notecard and learn about the utility scripts. Advanced users can then consider custom scripting or one of the available plugins.

Multiple Setups

It is possible to have any mix of singles & couples setups in different prims of the same furniture, however you must follow the instructions given in the SitTargets section.

Setups for 3+ Avatars

Setups in one prim for 3+ avatars is the same as for couples setup but needs to include more pairs of [AV]sit (A+B) scripts. The [NEW] menu will allow you to add a SYNC pose for multiple SITTERs but you should also learn to add/edit poses manually in the notecard.

Note: If your furniture does not include SYNC poses you could instead set each avatar’s poses in separate prims. e.g. a table with 4 chairs around would usually be best with a singles setup in each chair, rather than 4 SITTERs in one.

Warning: There is no set limit but it’s not recommended to have more than 6 SITTERs in the same prim.

Animation Sequences

AVsitter provides two ways to do sequences: the AVsequence™ script and the “built-in” sequence method. Read about both and use the method most appropriate for your situation.

Sounds and Songs

Playing sound files is achieved with the AVsequence™ script (includes playing a single sound with a pose, or a complete song).