Format docs, add changelog updates.

3 files changed, 224 insertions, 41 deletions

diff --git a/1ring technical docs.txt b/1ring technical docs.txt
index f536056..cdd4b90 100644
--- a/1ring technical docs.txt
+++ b/1ring technical docs.txt
@@ -3,9 +3,19 @@ This is basic technical docs for how to customize things in 1ring.
 Construction and prim contents.
 -----------------------------------------------
 
-Any 1ring object needs at least three prims.  The main prim has most things in it.  Linked to that main prim is a prim that should have the OhSillyThreatDetector script in it, coz it listens to the DEBUG channel for errors from the other scripts, and LSL scripts can't listen for things sent from their own prims.  The other prim is the one that becomes the "big yellow heart" vehicle prim, and is called "1AOor2 prim"  The script inside it is really simple, and allows the main 1ring to send stuff to it after rezzing it.  This prim just sits in the contents of the main prim until needed.
-
-There is a "onefang's leash holder and 1ring  support" script that you can put into any leash holder object.  Put it into the prim the leash should attach to.
+Any 1ring object needs at least three prims.  The main prim has most
+things in it.  Linked to that main prim is a prim that should have the
+OhSillyThreatDetector script in it, coz it listens to the DEBUG channel
+for errors from the other scripts, and LSL scripts can't listen for
+things sent from their own prims.  The other prim is the one that becomes
+the "big yellow heart" vehicle prim, and is called "1AOor2 prim"  The
+script inside it is really simple, and allows the main 1ring to send
+stuff to it after rezzing it.  This prim just sits in the contents of the
+main prim until needed.
+
+There is a "onefang's leash holder and 1ring  support" script that you
+can put into any leash holder object.  Put it into the prim the leash
+should attach to.
 
 The main prim should have at least these things in it -
     objects - 1AOor2 prim
@@ -29,28 +39,44 @@ The main prim should have at least these things in it -
     textures - soap-bubble, leash_chain, others beginning with "leash_" for optional leash textures.
     animations - loooots.
 
-The various .data notecards are used to store data that may or may not fit into scripts, coz various viewers have various limits on the length of scripts.  So we just read those into memory.  ~animations.data lists the viewer built in animations.
+The various .data notecards are used to store data that may or may not
+fit into scripts, coz various viewers have various limits on the length
+of scripts.  So we just read those into memory.  ~animations.data lists
+the viewer built in animations.
 
-The ZHAO II card is a standard ZHAO II compatible AO definition card.  It can be replaced by any other ZHAO II compatible AO note card.  Make sure the animations listed in it are actually in 1rings contents.
+The ZHAO II card is a standard ZHAO II compatible AO definition card.  It
+can be replaced by any other ZHAO II compatible AO note card.  Make sure
+the animations listed in it are actually in 1rings contents.
 
 .POSITIONS stores couples positions data, exactly like the ones used for MLP scripts.  The format is -
 {pose name} followed by four vectors of position and rotation for both animations in the pose.
 
-The .settings notecards store the various settings that are configurable by the user.  They are name=value pairs, one per line.
+The .settings notecards store the various settings that are configurable
+by the user.  They are name=value pairs, one per line.
 
-The .theme note cards are where the menus are defined, and are the bits you might want to customize.
+The .theme note cards are where the menus are defined, and are the bits
+you might want to customize.
 
 // and # can be used for comments in these cards.
 
-They start with a "FOR x" line, where X is one of the script names.  This means that by default the commands in the rest of the note card are commands from that particular script.
+They start with a "FOR x" line, where X is one of the script names.  This
+means that by default the commands in the rest of the note card are
+commands from that particular script.
 
-Next might be an "ALIAS x | y" command.  Mostly used so that "boss" can be replaced by something like "Owner" or "Parent" or whatever.
+Next might be an "ALIAS x | y" command.  Mostly used so that "boss" can
+be replaced by something like "Owner" or "Parent" or whatever.
 
-The rest are commands for defining the menus.  If you are familiar with MLP menus, this part is similar.  There is no need for adding Exit commands, nor for breaking the menus up to fit the silly LSL menu system limitations.
+The rest are commands for defining the menus.  If you are familiar with
+MLP menus, this part is similar.  There is no need for adding Exit
+commands, nor for breaking the menus up to fit the silly LSL menu system
+limitations.
 
 MENU name | title text | permissions.
 -----------------------------------------------------
-Start defining a menu.  "name" becomes the button text, "title text" becomes the title of the menu as displayed.  "permissions" is a code word that defines who can use this menu.  This line is followed by lines defining the menu items.
+Start defining a menu.  "name" becomes the button text, "title text"
+becomes the title of the menu as displayed.  "permissions" is a code word
+that defines who can use this menu.  This line is followed by lines
+defining the menu items.
 
 Permission codes.
 --------------------------
@@ -66,7 +92,8 @@ MOST       Anyone that is a BOSS, TRUSTEE,  WEARER, or matching group member.
 PUBLIC    Anyone.
 ALL           Everyone.
 
-Note that GROUP and PUBLIC are controlled by the group and public toggles in the access... menu.
+Note that GROUP and PUBLIC are controlled by the group and public toggles
+in the access... menu.
 
 BUTTON name | command
 ---------------------------------------
@@ -74,21 +101,30 @@ A menu button with the label "name" that does "command" when clicked.
 
 TOGGLE name | setting
 ----------------------------------
-A menu button with the label "☐ name" or "▣ name" that toggles boolean setting "setting" when clicked.
+A menu button with the label "☐ name" or "▣ name" that toggles boolean
+setting "setting" when clicked.
 
 TOMENU name
 ----------------------------------------
-A menu button with the label "name..." that shows the named menu when clicked.
+A menu button with the label "name..." that shows the named menu when
+clicked.
 
 TOMENU name | command
 ----------------------------------------
-A menu button with the label "name..." that runs the command when clicked.  The command likely shows another menu.
+A menu button with the label "name..." that runs the command when
+clicked.  The command likely shows another menu.
 
 POSE name | animation0 | animation1
 ---------------------------------------------------------
-A menu button with the label "name" that animates the couple that are sitting  on the 1AOor2 prim.
-Unless swapped, animation0 is for the tallest person, animation1 for the shortest.
-The .POSITIONS note card stores the actual positions and rotations for the poses.
+
+A menu button with the label "name" that animates the couple that are
+sitting  on the 1AOor2 prim.
+
+Unless swapped, animation0 is for the tallest person, animation1 for the
+shortest.
+
+The .POSITIONS note card stores the actual positions and rotations for
+the poses.
 
 SINGLE_POSE name | animation
 ------------------------------------------------
@@ -98,7 +134,9 @@ command
 ---------------
 Commands are in the form "script.command arguments".
 
-"script" is optional, as is the . if script is left off.  It's the script the command is for.  If a FOR command is at the top of the script, that's the default script.
+"script" is optional, as is the . if script is left off.  It's the script
+the command is for.  If a FOR command is at the top of the script, that's
+the default script.
 
 "command" is the name of the actual command.
 
@@ -106,10 +144,14 @@ Commands are in the form "script.command arguments".
 
 setting
 ----------
-Like commands, settings have an optional "script." bit at the beginning, which works the same.
+Like commands, settings have an optional "script." bit at the beginning,
+which works the same.
 
 animation
 ----------------
-This can be just the animation name, either a viewer built in one, or one that is included in the 1ring contents.
+This can be just the animation name, either a viewer built in one, or one
+that is included in the 1ring contents.
 
-It can include a :: followed by another animation name, typically the built in emote_* viewer animations.  Used for things like puckering up your lips for a kiss, or poking your tongue out while licking.
\ No newline at end of file
+It can include a :: followed by another animation name, typically the
+built in emote_* viewer animations.  Used for things like puckering up
+your lips for a kiss, or poking your tongue out while licking.
\ No newline at end of file
diff --git a/1ring test README.txt b/1ring test README.txt
index 8da6819..d18a75d 100644
--- a/1ring test README.txt
+++ b/1ring test README.txt
@@ -1,13 +1,13 @@
-This is a test version of onefangs 1ring thingy.  This is a prerelease
+This is a test version of onefangs 1ring thingy.  This is a pre-release
 test version, it's not even alpha quality yet.  Things will be broken. 
 There are known bugs.  There are bits not written yet.  You get to keep
 both parts.  I'm not happy with the speed when running under standard
-OpenSim, but it's fine with OpenSim-SC.  It's not documented, except the
+OpenSim, but it's fine with opensim-SC.  It's not documented, except the
 few things you'll find in this notecard.
 
-1ring is a combination of things.  AO / collar / couples carry &
-interaction / emoter / swimmer / probably something I forgot, but those
-are the main ones.
+1ring is a combination of things.  AO & swimmer / collar / couples carry
+& interaction / emoter / smiler / poser / probably something I forgot,
+but those are the main ones.
 
 RLV will be needed for the couples carry thing, and the collar.
 
@@ -25,6 +25,9 @@ things in the menu will have little circles obscuring the letters, that
 means you don't have access to that (likely other people wont have access
 to it on YOUR device).  Hopefully it's reasonably self explanatory.
 
+AO & swimmer
+---------------------
+
 The AO part is a more or less standard ZHAO II compatible AO.  You can
 edit the ZHAO II notecard and add the animations from your own AO, or
 just drag the ZHAO II card plus animations from your AO.  It currently
@@ -40,6 +43,9 @@ under water, you'll swim.
 The AO might fight with your existing AO, but it's needed for the couples
 carry thing.  You can turn it on and off.
 
+Collar
+---------
+
 The collar part is a fairly standard basic collar.  You can even use the
 usual method of bringing up the menu - "/1ormenu" for example (first
 letters of your name, and the word menu, in channel 1).  It supports RLV,
@@ -50,8 +56,12 @@ the leash connect here" function, it is a helper script for the border
 crossing and TP following features.  BTW, it is compatible with ***insert
 the standard leash holder names here***.
 
+Couples carry & interaction
+----------------------------------------
+
 The couples carry & interaction part is probably the main reason people
-will want this.  Among other things it lets one avatar carry another. 
+will want this.  Among other things it lets one avatar carry another.
+
 There is no end of problems with how OpenSim and Second Life "work" that
 had to be worked around to get this to work at all, mostly coz it is
 strictly forbidden to sit on an attachment.  Even the old work around has
@@ -68,8 +78,14 @@ not well tested, still working on that.  I plan to add TP follow support
 in the future.  It currently works better if the 1ring wearer is the one
 selecting the pose and stuff, this will get fixed.
 
-It tries to be clever about who is in what role, but there's a swap menu
-(that I need to actually write code for) to take care of that (or not).
+It tries to be clever about who is in what role, but there's a swap
+button to take care of that.
+
+Note that you can walk off sim, but steering then becomes horrid. 
+Rotations are hard, m'kay.
+
+Emoter
+----------
 
 The emoter part is from something I wrote long ago.  During a sub
 auction, the subject of emoters came up.  I declared that they are
@@ -78,8 +94,25 @@ every one watched.  Who says programming isn't a spectator sport?  Oh
 wait, that was me that said that.  That code is now a part of 1ring.  You
 say something in channel 12 or 123 -
 
-/12 something     Script owners first name is used for a "/me something"
-emote. /123 someone something     someone: something
+/12 something
+    Script owners first name is used for a "/me something" emote.
+/123 someone something
+    someone: something
+
+Smiler
+----------
+
+Randomly changes your smile every now and then.  Planning to do more.
+
+Poser
+-------
+
+Single person animations are also available.  There are several
+categories, and a "left overs" category that is just any animation that
+isn't part of something else.
+
+Menus
+----------
 
 1ring has customizable menus, though it is beyond the scope of this
 document to describe any of it.  Have a look at the .1AOor2.theme and
@@ -87,6 +120,104 @@ document to describe any of it.  Have a look at the .1AOor2.theme and
 are clever you might be able to work out how they work.  Some of the
 commands are similar to MLP menu commands.
 
+The common menu buttons are -
+▲ Exit                Exits out of the current menu, back to the previous menu.
+◄ Previous      If a menu is too long for the stupid limitations of LL menu system, it's broken into pages.  Go to the previous page.
+Next ►              Go to the next page.
+☐   ▣                    Any menu item with one of these squares is something you can turn on and off.
+                              Do I have to say that the empty square ☐ means off, the one with a solid square in it ▣ means on?
+
+The default menus are -
+access...           Access control for everything, like setting who owns your collar and similar.
+clothes...          Put on or take off clothes.  Uses #RLV inventory folder, and RLV.
+couples...         Couples carry & interactions menu.
+leash...              Collar leash menu.
+mood...             Non functional mood adjustment menu for the smiler.
+moves...            Control your speed, go places, sit, AO, teleport.
+other...              Various things, most of which are not written.
+PANIC                 Release you from everything.
+poses...              Individual poses.
+restrictions... Control RLV restrictions, mostly not written.
+sound...            Control sound, mostly not written.
+
+Menu - access...
+-------------------------
+Add or remove a boss / trustee / or blocking someone.
+Set group or public access.
+Control the built in RLV relay.  (Did I actually write that?)
+Run away from your current set of bosses / trustees.
+List all these details.
+
+Menu - clothes...
+------------------------
+RLV is needed for any of this to work.
+outfits...       is the #RLV inventory folder, where you can put on and take off outfits.
+attached... is for removing attachments.  Note that RLV does not tell scripts WHAT is attached, just what attachment points have                                  something.  For mesh avatars this is a big problem.  Are you about to remove their skirt, or their legs?  Be careful.
+worn...          is for removing "system" clothing.  Might work on BoM clothes to.
+
+Menu - couples...
+-------------------------
+adjust...       For adjusting the positions of the couple.
+save                Save the adjusted positions.  Makes a backup of the .POSITIONS note card first.
+sync                May or may not resynchronize poses that have drifted out of sync.
+swap...          Swap menu.  I may or may not have written this.  lol
+
+The others are collections of couples things you can do.  Currently
+includes dances, hugs, hugglefucks, kisses, lay cuddles, rides, sit
+cuddles, spank, wash, and XXX.
+
+You first select the thing you want to do, then who you want to do it
+with.  If that's an NPC, they automatically join you, otherwise they are
+asked if they want to join you.  If OhSilly Threat System lets you, and
+you have RLV enabled, them the thing happens.  Otherwise one or both of
+you needs to sit on the big yellow heart manually.  If you are not
+allowed to rez things where you are, the big yellow heart doesn't appear. 
+The other person might need to sit first.
+
+Both people can use normal movement keys to move you around.  While
+adjusting, the movement keys will adjust instead.
+
+You can both hop on and off the big yellow heart.  Note that if there are
+two people on it, one of them has to be the 1ring wearer, for technical
+reasons that I blame LL for.  So the one that is not wearing 1ring can
+hop off, and someone else can hop on.
+
+Menu - leash...
+----------------------
+Grab their leash, leash them to something / someone, unleash them, adjust
+the length of the leash, the size of the leash, and the texture of the
+leash.
+
+Menu - moves...
+-----------------------
+Adjust your speed slower, faster, or back to normal.  This applies to AO
+and couples movement.
+Follow someone.  Goto someone / something.  Stop following them.
+Sit on something.  Stand up.
+AO... -
+    Turn AO on or off.
+    Various types of AO menus that are not currently written.
+    Turn on and off the various OhSilly Threat Level system OpenSim functions that might cause error messages.
+        NOTE - 1ring tries to detect these, but OpenSim devs are smoking the wrong drugs.  Or something.
+
+Menu - other...
+---------------------
+Only thing that works here is hide, for hiding 1ring.
+
+Menu - poses...
+---------------------
+Various sub menus for various individual poses.  Most are built in viewer animations.
+left overs...         Any animations that are in 1ring but not used by oter parts of the system.
+                                 So you can just drop animations in, and they'll turn up here.
+dancing...          Built in dance moves, that don't loop.  Blame LL I suspect.
+submissive...    OpenCollar sub poses.
+viewer animations...  All built in viewer animations.
+The other sub menus I hope are self explanatory.
+
+
+Other stuff
+---------------
+
 https://sledjhamr.org/mantisbt/project_page.php?project_id=12 is the
 issue tracker for 1ring. Feel free to create an account if you want to
 report an issue or request a feature.  Accounts need to be approved by
@@ -97,12 +228,10 @@ I'm sure I should have mentioned other stuff here.
 The source code is available at https://sledjhamr.org/cgit/1ring/
 
 
-The soap bubble image was downloaded from
-https://www.pngall.com/soap-bubbles-png/download/26145 From the
-collection at https://www.pngall.com/soap-bubbles-png License Info:
-Creative Commons 4.0 BY-NC  I think "Rojal"
-https://www.pngall.com/author/rojal was the creator, it doesn't really
-specify.
+The soap bubble image was downloaded from https://www.pngall.com/soap-bubbles-png/download/26145
+From the collection at https://www.pngall.com/soap-bubbles-png
+License Info: Creative Commons 4.0 BY-NC  I think "Rojal" https://www.pngall.com/author/rojal was the creator, it doesn't really specify.
 
 Most animations are from  Linda Kelly, some are from OpenCollar.  The
-leash textures are from OpenCollar.
+leash textures are from OpenCollar.  Most of the individual poses are
+built into the viewers.
diff --git a/changelog.txt b/changelog.txt
index 978ab77..a67f013 100644
--- a/changelog.txt
+++ b/changelog.txt
@@ -1,7 +1,19 @@
-V0.13 test - 2019-07
+V0.13 test - 2020-09
+    Various bug fixes and tweaks.
+    Make the emoter work.
+    Lots of couples poses added, in more categories.
+    Leash texture, size, and length adjustments.
+    Allow different speeds of movement.
+    Less jerky leash following.
+    Better smilage.  B-)
+    MLP style "emotes".
+    Individual poses, including OpenCollar submissive poses and built in viewer poses..
+    More docs.
+
+V0.13 test - 2019-07 
     checkAO() on either AO on or AO off.
     Actually SET AO options.
-    Many more poses.
+    Many more poses. 
 
 V0.12 test - 2019-07-04
     Make sure all scripts are actually running on reset.