How to use

Three scripts

The WearPose System uses three distinct major scripts. Here is a brief description of their roles and when to use them.

WPS-ConfigServer

The WPS-ConfigServer is a script specialized in reading and parsing the configuration notecards. It verifies the information inside them and transmits them to the other scripts.

WPS-Preparation

The WPS-Preparation is a non transferable script that will help you verify the configuration and, for every pose declared in the configuration:

• define the position and orientation of your attachment (with respect to the avatar)

• test and help you decide which adjustment pose should be used or available

• find the parameters for extra adjustment pose you will be able to create from this website.

The WPS-Preparation script will verify the menu structure but not actually use it.

WPS-MainScript

The WPS-MainScript is a transferable script that handles the whole menu system, animates the avatar and manages all features of the WearPose System in "production mode".

When you are preparing and configuring your product, you will need both WPS-ConfigServer and WPS-Preparation scripts inside your object.

When you will be readying your product for distribution, you will have to remove the WPS-Preparation and install the WPS-MainScript. The WPS-ConfigServer must remain installed at all times.

Step-by-step installation and configuration

In this section I will cover the basic configuration writing along with setting the object position and orientation. For more information about the configuration please see the Configuration reference section. For information about the adjustment facility, please refer to the appropriate section.

Step 1: Build and equip

The first thing to do is build your object and equip its inventory ("Contents" tab in the viewer's edit window) with all the animations and poses you want to use.

Step 2: Attach

Attach your object to your avatar. You can choose any attachment point, but the most reasonable is probably the "avatar center" since this point does not move when the avatar is animated.

Step 3: Create the configuration

Create a notecard named ".menus" in your inventory. In this notecard you have to write a POSE keyword for every pose you want to appear in the menu, with the following syntax:

POSE name|animation

On this line, "name" is the name that will appear in the menu. It must not be too long (keep in mind that button names are very limited in width, at most 12 characters visible).

After the vertical bar is the name of the animation file from your object's inventory. Beware that it is case sensitive ("ANimAtion" is different from "animation") and that spaces count!

Later on, you will be able to organize your poses into submenus and include navigation buttons between menus. For this please refer to the Configuration Reference section.

Step 4: Install the configuration

When your .menus notecard is ready, you can put it into your object's inventory. Then install there first the WPS-ConfigServer, and then the WPS-Preparation scripts. The scripts will then read the .menus notecard and tell you when it's done.

If an error appears while parsing the configuration, the scripts will tell you exactly what is wrong and will wait for you to correct the problem.

Step 5: Try the menu

After all potential configuration problems have been fixed, you can click your attachment to bring the main menu, which shows a number of buttons which will be explained later. For now click "Use pose" and you will be presented with a secondary menu where you can see all your poses. If you click on a button, the corresponding pose will be played.

If you had already defined submenus, you will notice they are not used yet. Indeed the WPS-Preparation script does not care about the menu structure, only the WPS-MainScript does. So let's not worry about that now.

Step 6: Move your attachment

At this point you may notice that your attachment is not correctly positioned while playing one animation or another. You can then edit your attachment and move it where you find it's appropriate for the pose you are currently using: just use the usual "move" and "rotate" edition tools from the viewer. Your setting will automatically be remembered by the script.

Step 7: Repeat and dump positions

Repeat step 6 for every pose you have defined in your configuration. When you are satisfied with your settings, we must dump this positional information to a new notecard so that the WPS-MainScript can use it when we install it.

This is a very easy task: go back to the main preparation menu (the "Back" button) and click the "DUMP pos" button.

Step 8: Copy positional information

After clicking "DUMP pos" at step 7, you will notice in the local chat a number of cryptic messages (only visible by yourself). Copy all these lines into a new ".positions" notecard. Such a ".positions" notecard is provided with the product and intentionally left empty. Save this notecard and put it into your object's inventory.

Do not worry about extra text like chat headers or such when copying the text, the script will safely ignore such extraneous text.

Step 9: Restart and check

On detecting the change in the inventory, the WPS-Preparation script will automatically restart and proceed to read both notecards (".menus" and ".positions"). When it's done you may want to verify that all poses and positions are correct by again selecting the poses in the "Use pose" menu.

Step 10: Install the main script

Remove the WPS-Preparation script for the objects inventory, and then equip the WPS-MainScript. Let it boot and read the notecards. It's done!

More details about the preparation menu

More operations (new as of version 3.0) are available in the Preparation menu, but since some of them involve adjustment, this will be covered on another page of this website. Please refer to the Preparation menus reference page.