You are on page 1of 8

This document is available in PDF and OpenOffice formats at http://www.scribd.

com/doc/84525727/Happy-Cloak-Owner-Manual

INTRODUCTION
Greetings and thank you for purchasing a Second Life Happy Cloak from the Truth & Beauty Lab. A Truth & Beauty Lab Happy Cloak can query Wikipedia, provide answers from Wolfram Alpha, scan the area for objects and avatars, produce a variety of lovely particle effects, respond to chat commands from its owner, send email, and more. A graphical dialog menu allows you to easily configure and use your Happy Cloak. Truth & Beauty Lab Happy Cloaks are configured to query Wikipedia and Wolfram Alpha for responses making them one of the smartest scripted agents in Second Life. This generation of Happy Cloak can detect the user's language and query that language Wikipedia providing responses in the user's language.

CONTENTS
This package contains one or more preconfigured Happy Cloaks from the Truth & Beauty Lab. They are ready for immediate use and should require no initial setup. However, each Happy Cloak can be extensively customized. The instructions below provide simple steps to configure your own custom Happy Cloak. Should you prefer, custom items are available from the Truth & Beauty Lab - simply contact missyrestless@gmail.com or IM Missy Restless inworld.

FEATURES
Truth & Beauty Lab Happy Cloaks contain the following features: Stylishly sculpted and scripted for low lag performance Wikipedia & Wolfram Alpha query support including Unicode character display Emits a variety of particle displays on command, sequentially, or random Scans the area for avatars and objects producing a detailed report Can target an avatar or object for particle beam Email you can use your Happy Cloak to send email Extensive set of chat and dialog menu commands Highly configurable including ability to restrict responses based on name Dialog menu configuration makes it easy to configure Detects user's language and queries that language Wikipedia Configurable as public (local chat) or private channel only low lag

GRAPHICAL DIALOG MENU CONFIGURATION


Although ready to use "out of the box", the Truth & Beauty Lab Happy Cloak can be extensively configured. Simply say configure or menu in local chat or on the configured chat channel and a dialog menu interface will be displayed. Most of the options you would want to customize are available in the dialog menu.

CHAT COMMANDS
The owner can chat the following commands to the Happy Cloak. Note that if a private channel has been configured then the chat commands must be issued on that channel. The chat commands are:

Command menu laser burst bubbles bling sparkle blue balls cycle hearts shamrocks clovers more less faster slower next prev default off avatars scan find <name> sync random lightning anims on anims off draw anim kick anim yoga sit yoga stand

Action display the happy cloak configuration & command dialog menu fire a laser beam from the happy cloak emit a colorful burst of particles emit bubble particles turn on sparkly bling lights emit a shower of sparkles emit bursts of blue balls sequentially cycle through the particle displays and animations emit heart particles emit shamrock particles emit 4 leaf clover particles emit more particles emit fewer particles increase the frequency at which particles are emitted decrease the frequency at which particles are emitted go to the next particle display go to the previous particle display set the particle display parameters back to the defaults terminate the particle display scan the area for avatars scan the area for avatars and objects attempts to locate the named object or avatar synchronize the particle displays from 2 or more happy cloak prims randomly cycle through the particle displays and animations emit lightning particles animate your avatar during particle displays disable avatar animation during particle displays start the double draw animation start the kick animation start the sitting yoga position animation start the standing yoga position animation

Commands are case insensitive. The chat commands are also available as buttons in the Commands sub-menu of the dialog menu.

NOTECARD CONFIGURATION
Your Happy Cloak is delivered with default settings suitable for most uses. Should you wish to change the default settings you can do so by editing the Configuration notecard. A complete list of user configurable parameters can be found in the Configuration notecard in the Happy Cloak object's Contents. Below are most of the commonly used configuration options. Settings are specified in the format "<name> = <value>" DO NOT use "=" in either the <name> or <value> Place any uncommented configuration settings above the END_SETTINGS line. Lines below END_SETTINGS will not be read and are there for information and help configuring.

NOTECARD, LANDMARK & USER GUIDE DELIVERY


When touched by a non-owner the Happy Cloak can be configured to deliver a notecard, landmark, and the Happy Cloak User Guide. The Happy Cloak simply looks for the first notecard and landmark in its inventory and delivers these. To configure your Happy Cloak's delivery items, drop the notecard and landmark you wish delivered to your visitors into the Happy Cloak's contents. Make sure these

are named so they appear first in alphabetical order. For instance, use an underscore or asterisk as the first character in their names. Happy Cloaks can be configured to deliver a notecard, landmark, and additional documents via a dialog menu.

NAME CONFIGURATION
By default, the name of your Happy Cloak is Happy Cloak. The NAME_ENABLED configuration variable is set to TRUE so the default behavior of your Happy Cloak is to reply only to chat that contains either the first or last name (e.g. cloak, who is adam). To change the name of your Happy Cloak, open the Configuration notecard: right click the object -> Edit click the Contents tab right click the Configuration notecard -> Open At the beginning of the notecard add or replace the two name lines: FIRST_NAME = Buffy LAST_NAME = Smartcape This will change your Happy Cloak name to "Buffy Smartcape". Change Buffy and Smartcape to whatever name you want your Happy Cloak to have. When finished, click Save and close the edit window. When NAME_ENABLED is TRUE the name of the Happy Cloak determines which local chat the Happy Cloak responds to. See NAME_ENABLED below for more information on response control.

WOLFRAM ALPHA APPLICATION ID


Wolfram Alpha requires an Application ID for queries made by another application. By default a shared demonstration Wolfram Alpha Application ID is used by all Happy Cloaks which have not been configured with a valid App ID. However, that ID is limited by Wolfram Alpha to 2000 queries per month. Register for a valid Wolfram Alpha Application ID at http://products.wolframalpha.com/api/ and set ALPHA_APP_ID in the Configuration notecard to the ID your are provided. See the next section to see why it is important to register for a valid Wolfram Alpha Application ID.

HAPPY CLOAK QUERY MODES


Your Happy Cloak can be configured to respond in several modes. The response modes can be configured via the dialog menu but those settings will be restored to the defaults when the cloak is reset or re-rezzed. To configure the default mode you can edit the Configuration notecard in the Happy Cloak contents. The following Configuration notecard variables (with defaults) control the various response modes: WIKIPEDIA_ENABLED = TRUE If TRUE some responses will be generated from Wikipedia articles. If a relevant Wikipedia article cannot be found then the response will either be generated from Wolfram Alpha or customized AIML from pandorabots.com ALPHA_ENABLED = TRUE Controls whether the Happy Cloak will query the Wolfram Alpha answer engine. If TRUE and ALPHA_APP_ID is set to a valid Wolfram Alpha Application ID then Wikipedia queries that do not find a matching article or which find a Wikipedia disambiguation page will fall back to Wolfram Alpha query. The combination of Wikipedia and Wolfram Alpha query provides a fairly robust degree of intelligence as these two services in combination cover just about every topic imaginable.

AI_ENABLED = TRUE If TRUE some responses will be formed using AI from pandorabots.com. AUTO_DETECT = TRUE Controls whether the Happy Cloak will attempt to detect the chat language and respond with that language Wikipedia summary. EMAIL_ENABLED = TRUE If TRUE you can use the bot to send email. See the EMAIL_TRIGGERS below. Set to FALSE if you don't want to allow people to use the bot to send email. OWNER_LISTEN_ONLY = FALSE Controls whether the Happy Cloak will respond to other users or just the owner. The default mode, out of the box, is to allow email, respond to everyone, auto detect language, query Wikipedia, query Wolfram Alpha, use AI from pandorabots.com, fallback to AI on Wikipedia misses and fallback to AI on Wolfram Alpha misses. Once a valid ALPHA_APP_ID is configured then the Happy Cloak will fallback to Wolfram Alpha on Wikipedia misses and AI on Wolfram Alpha misses.

CONFIGURATION NOTECARD SETTINGS


Default values for the following variables can be set by editing the Configuration notecard in the Happy Cloak contents: NAME_ENABLED If FALSE the happy cloak will attempt to respond to all local chat. If TRUE the happy cloak will attempt to respond only to local chat containing either first or last name. INTERVAL The interval (in seconds) at which to change cloak texture. Set to 0.0 to disable cloak texture changes GROW Grow and shrink the cloak tentacles on each texture change REVERSE To reverse the direction of movement during tentacle growth TOUCH_ENABLED Should touching the base prim bring up the dialog menu ? HOVER_ENABLED If FALSE the hover text will not be set. If TRUE the hover text will be set. INVISIBLE If TRUE make the happy cloak invisible FIRST_NAME & LAST_NAME The name by which your happy cloak will respond. If NAME_ENABLED is TRUE, the happy cloak will only respond if either string is in the chat message (case insensitive). CHANNEL Setting this to a positive non-zero value configures the Happy Cloak to listen on that channel. In this mode the Happy Cloak becomes a private owner-only agent. All communication with the Happy Cloak must be prefaced with the channel number. For instance, if CHANNEL = 22, the Happy Cloak will only respond to chat prefaced by / 22 e.g. /22 Who is Abraham Lincoln ?

TEXTURE The name or UUID of a texture to use on the happy cloak. By default, all textures in the happy cloak contents are cycled through. If you want your cloak to always have the same appearance and not change textures, specify the texture to use here and set INTERVAL = 0.0 to disable texture changes. SHOW_BOT_MENU Provide additional configuration menu entries for an Actorbot or METAbolt bot if they have been integrated with the Happy Cloak. OWNER_BOT_MENU If TRUE only the owner (or group if group access has been configured) may operate the configuration dialog menu system. If FALSE non-owner/non-group residents will be provided with a subset of the dialog menus suitable for Happy Cloak interaction. AI_ENABLED If TRUE Pandorabot will chat using AI from pandorabots.com when it cannot find a matching Wikipedia entry. Setting AI_ENABLED = FALSE will cause all chat to query Wikipedia regardless of matching trigger phrases (e.g. simply chatting "Abraham Lincoln" will get the Wikipedia article on Abraham Lincoln). ALWAYS_WIKI If TRUE then Wikipedia will be queried even when no trigger phrase is matched. As in AI_ENABLED = FALSE above, this enables Wikipedia queries without the prefacing trigger phrase (e.g. simply chatting "Abraham Lincoln" will get the Wikipedia article on Abraham Lincoln). To always query Wikipedia and fall back on AI chat, set both AI_ENABLED = TRUE and ALWAYS_WIKI = TRUE BOT_ID The Pandorabot ID to use. Note, this is the ID of the bot at pandorabots.com, not the UUID of any Second Life object or avatar. To create your own custom Pandorabot, program the responses in AIML at http://www.pandorabots.com/ and set this to your custom Pandorabot ID. Alternately, a custom Pandorabot can be created to your specification by contacting Missy Restless at missyrestless@gmail.com BOT_NAME Name of corresponding Bot ID. This is the name of the preprogrammed bot personality at pandorabot.com and not the name by which the happy cloak will identify itself. WIKIPEDIA_ENABLED If TRUE, chat including one of the WIKIPEDIA_TRIGGERS will cause the Happy Cloak to query Wikipedia for an appropriate response. ALPHA_ENABLED If TRUE queries beginning with one of the ALPHA_TRIGGERS below will trigger factual responses from Wolfram Alpha. ALPHA_APP_ID The Wolfram Alpha application ID to use. Register at http://products.wolframalpha.com/api/ to receive your AppID EMAIL_ENABLED If TRUE you can use the Happy Cloak to send email. See the EMAIL_TRIGGERS below. EMAIL_TIMEOUT Number of seconds a user has to compose email. VERBAL_SHUTOFF_ENABLED

If TRUE the Happy Cloak will shutoff when hearing one of these phrases. See SHUTOFF_TRIGGERS below. Touch the Happy Cloak to wake it up. OWNER_LISTEN_ONLY If set to TRUE only the owner of the Happy Cloak can talk to and hear the Happy Cloak RESTRICTED_ACCESS This can be used to restrict the ability to shutdown and configure the Happy Cloak to owner only (set to 1), group only (set to 2), or all residents (set to 0). Setting RESTRICTED_ACCESS = 0 allows all residents to shutdown and restart the Happy Cloak as well as access a limited dialog menu appropriate for guests. LANG_CODE Set the language code to use for Wikipedia queries. By default the Happy Cloak will query the English Wikipedia. To configure your Happy Cloak to query one of the nonEnglish Wikipedias, set LANG_CODE to the appropriate language code. See http://meta.wikimedia.org/wiki/List_of_Wikipedias for a list of all Wikipedias and their corresponding language codes. Non-English query misses are followed by an English Wikipedia query. LANG_NAME The name by which the LANG_CODE selected language will be referred. LANG_CODES The list of language codes for Wikipedia. This list determines not only which language codes are used but the order in which the chat is searched for a trigger phrase (last in list to first in list). You can order this list by reverse "importance" of languages in your region. Note, if you modify the order of this list then you must also modify the LANG_NAMES setting below. You can also substitute a valid language code for one or more of these but then you must also modify the corresponding LANG_NAMES entry and ??_TRIGGERS list of trigger phrases in that language. For example, to replace Italian with Swedish you would change "it" in LANG_CODES to "sv", change "Italiano" in LANG_NAMES to "Svenska", and add the Swedish trigger phrases to IT_TRIGGERS. LANG_NAMES The list of names corresponding to the list of LANG_CODES. UNWIKIABLE_PHRASES Don't attempt to pass these to Wikipedia, get the response from pandorabots.com AUTO_DETECT Set this to TRUE in order to auto detect the language and query that language Wikipedia if present. Falls back to English if none found or FALSE. EN_TRIGGERS NL_TRIGGERS ES_TRIGGERS PT_TRIGGERS PL_TRIGGERS IT_TRIGGERS DE_TRIGGERS FR_TRIGGERS JA_TRIGGERS RU_TRIGGERS These are the various language Wikipedia trigger phrases. These phrases trigger a Wikipedia query if WIKIPEDIA_ENABLED is TRUE. If you have set LANG_CODE above to something other than English (en) you may wish to set the Wikipedia trigger phrases

to that language as well. Note that the Japanese and Russian lists of Wikipedia trigger phrases JA_TRIGGERS and RU_TRIGGERS are empty by default. If you have Multi-byte input support you can enter the Japanese or Russian trigger phrases. NO_ENDING_NEEDED Whether the Wikipedia triggers need a ? or other ending character in order to match and trigger a Wikipedia query. Default is TRUE, no ending character is necessary. ALPHA_TRIGGERS If ALPHA_ENABLED is TRUE these phrases indicate the resident wishes to query Wolfram Alpha for a factual answer. The default Wolfram Alpha triggers are wolfram alpha, wolfram , and alpha . For example, to ask Wolfram Alpha for the cube root of 387 you could say wolfram what is the cube root of 387. EMAIL_TRIGGERS If EMAIL_ENABLED is TRUE these phrases indicate the resident wishes to send email. SHUTOFF_TRIGGERS If SHUTOFF_ENABLED is TRUE these phrases will shut the Happy Cloak off until touched. By default the Happy Cloak will stop responding when it hears either be quiet or shut up (case-insensitive) in local chat. NOTE: You should only need to change the following settings if you modify the link set. You're on your own if you have done this. These settings are provided to allow builders to easily reconfigure which prims get texture changes, grow, and shrink. CLOAK_PRIMS The link numbers of the cloak prim - the prims to change textures on. TENTACLE_PRIMS The link numbers of the two tentacles - the prims to grow and shrink on texture changes.

FURTHER INFORMATION
This manual, the Truth & Beauty Lab Smart Dance Pole Manual, Truth & Beauty Lab Smart Tip Jar Manual, Pandorabot METAbolt Add-On Manual, Pandorabot METAbolt Diagram, Pandorabots Owner Manual, and Pandorabots User Guide are available in PDF format at http://www.scribd.com/missyrestless Visit the Pandorabot blog at http://pandorabot.blogspot.com where you can find many How-To tutorials on Pandorabot use, configuration, and deployment at http://pandorabot.blogspot.com/p/how-to.html View and interact with the Truth & Beauty Lab demonstration METAbolt integrated Pandorabot at http://slurl.com/secondlife/Gualdo/210/226/42/ . Follow me on Twitter at http://twitter.com/missyrestless Like Pandorabots on Facebook at http://on.fb.me/t3ItL3 Be my friend on Plurk at http://www.plurk.com/MissyR Have fun and email missyrestless@gmail.com with any questions, comments, suggestions, requests for custom configurations or AIML programming. View other Truth & Beauty Lab creations in the Second Life Marketplace at https://marketplace.secondlife.com/stores/44210

You might also like