Enchantress Shield Readme

From Grigbertz

---

Revision as of 16:26, 31 July 2010

=== BONDAGE WITCH PROJECT - ENCHANTRESS SHIELD ===

Content:
   *) Introduction
   *) What's Included
           - Enchantress Shield (pelvis)
   *) Fitting
   *) The Menus
   *) Menu Symbols
   *) Locking
          - Operators Notecard and Chat Commands
          - Why "Operator"?
   *) Color and Style
   *) Failing To Respond
   *) Thank You


--- INTRODUCTION ---


The Enchantress Shield is a strapless magical  protection device. 

It attaches itself by magic, and can change its look in a in a variety of
ways. If set to do so, it can punish any unauthorized access with an
electric shock. 


Some of the functions in this item require that you use Restrained Life 
Viewer (or something compatible) as your Second Life client. If not, these 
functions will simply not function. 

This attachment is purely made out of prims, and might fit differently well
on different body shapes - see the "Fitting" chapter below. If you want 
to do any rescaling or make any other modifications to make it fit more 
snugly, always remember to make a backup copy of the original version 
before doing any modification work - that is why it is sold with Mod/Copy 
rights and not Mod/Transfer. 

NOTE: The demo version (if any) does not have the modify permission set. 


--- WHAT IS INCLUDED ---

- Enchantress Shield (pelvis)

As delivered, the item is set to attach to the pelvis attachment point when 
worn, but you may put it on e.g. stomach instead. The item remembers last 
used position for each attachment point, so you can switch back and forth 
between points if you so desire. 


--- FITTING ---

This item is sold with Mod rights, so you, as the buyer, are permitted 
to scale it using the edit tool.  We prefer to give away this right rather 
than adding a resize script, adding to zone lag as you carry it around. 

The item has a position script that remembers the position it had last on 
each separate attachment point. That means that you can easily use more
more than one attachment point as needed, just as long as you do the
initial positioning on each separate point.  These settings are cleared if 
you reset the item. 


--- THE MENUS ---

The menu can be accessed simply by clicking anywere on the 
items, or by giving a chat command. The exact chat command 
varies with your initials, and is given when you wear the 
item. 

Note that Operators (see below), you as wearer, and other persons 
may see slightly different menus. This is fully intentional, and reflects
the wearer's status as plaything. 

This item can be set to give electric shocks when touched. In this
case, only the chat command can be used to bring up the menu, 
so make a note of  what the item says when you wear it. 

--- MENU SYMBOLS ---

These symbols make menus easier to use:

▼ ▲ ► ◄ - Navigation 
   ▼ goes to a submenu. 
   ▲ goes up to a previous menu.
   ► ◄ goes to the next page in a multi-page menu
   
□ ■ - Checkboxes 
   These buttons turn things on and off. Clicking the button toggles 
   the option. An empty checkbox is an option that is currently not active. 
   A full checkbox is an option that is active.

● ○ - Radio Buttons. 
   A series of choices, where only one can be active. For example, 
   your item can have one of a long list of colors. The selected choice 
   is a full ring; the others empty rings. Clicking on the button of an 
   empty ring selects that choice. 

--- LOCKING ---

If you are using an RLV compatible client, you may have the item
locked to you. That means that it cannot be detached or edited, and
the menus are restricted. 


- Operators Notecard and Chat Commands - 

Only those you designate as operators can lock you. Designating operators
requires that you edit the "Operators" notecard inside the item. 

Simply list the name of those you want as operators, one name on each line.

A single asterisk ('*') on a line means that anyone can be operator. This
is the default setting, so beware! The asterisk does not include you,
so if you want to be the operator of your own device, please add your
own name explicitly. 

If you use the '*' wildcard to grant operator access to all, and run into a
person you want to exclude from that privilege in the future, you can add
that person's name with an exclamation point ('!') before to the Operators 
List. That makes the listed person non-eligible. 

If you have a person you want to exclude from all menus in the item, you
can list that person with a double exclamation point ('!!'). 

Some Bondage Witch Project persons may be included in the notecard as
examples. It's up to you if you want to leave them there or not... 

After editing the notecard, either press the "Operators" button in the menu, 
or take off the item and then wear it again, to make the change take. 

You can also add and remove operators "on the fly", by using chat commands. 
You can see what chat commands apply to your item by clicking on "Operators" 
in the menu. These modifications will be lost if the scripts in the item are 
reset, so it is better to edit the notecard for true permanence.

HOWEVER, your operator list CANNOT be modified while the item is locked.

NOTE that proper uppercase and lowercase letters are ESSENTIAL. Entering
"tuft meili" instead of "Tuft Meili" will NOT work.

If the item fails to accept chat or menu commands, something might have gone 
wrong starting the scripts. See "Failing to respond" below. 


- Why "Operator"? -

Why do we call the person given authority over the wearer "Operator"? 

We have chosen this term because "Owner" can be confused with the 
owner of the item itself. "Owner", and other terms such as "Master", also 
have implications that are not necessary true for each individual. Because 
of this we have chosen a more neutral term.


--- COLOR AND STYLE ---

You can set the color and style of the item through the menu. 

Note that due to how coloring is done, it may take a few moments for it 
to completely take effect, and the item might look slightly weird in the process. 

Since there are so many colors to chose from, the color menu is split into
several pages. You move from one page to the next by pressing the right arrow
button (►). Some "colors" ("Kryptonite", "Lava", ...) are glowing and/or 
transparent, while others are more regular. 

There are also several styles that can be set from the menu. Some of these are 
use animated textures, some use static textures. As a general rule, the static 
textures work best with regular colors, and the animated textures with the 
glowing ones. 


--- FAILING TO RESPOND ---

If the item completely fails to accept chat or menu commands, and it is not just 
lag delay, something might have gone wrong with the scripts. The best way to 
fix that is to reset the scripts in the item. 

To do this, right-click on the item and choose "Edit" to select it. Then use the 
"Tools" menu  in the client, and select "Reset Scripts in Selection". 

NOTE: Please do the reset while the item is unlocked (if possible), wait a few
minutes, detach it, and then reattach it. 


--- THANK YOU ---

         I hope you enjoy your purchase.
 
         Signed, Tuft Meili