-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathusage.txt
More file actions
58 lines (55 loc) · 3.41 KB
/
usage.txt
File metadata and controls
58 lines (55 loc) · 3.41 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
Usage: botctrl [-deih] [-a action] [-A avatar] [-l location] [-n name] [-k apikey] [-C channel] [-c corrade]
[-D data] [-F filter] [-M message] [-N name] [-O name] [-S subject] [-s secret] [-T text] [-u uuid] [-z num]
Where:
-a action specifies the API action (sit, teleport, login, ...)
-l location specifies a location for login and teleport actions
Default: Last location, teleport action requires a Slurl location
-n name specifies a Bot name, Default: Easy Islay
-k apikey specifies an API Key, use environment instead
-A avatar specifies an avatar UUID for use with giving money or objects
-C channel specifies the channel for a message [default: 0]
-c corrade specifies a Corrade bot name to act upon
-D data specifies a Corrade Manager class member
-F filter specifies a filter to match when listing attachments
-M message specifies the message body for a group notice/im
-N name specifies the name of the recipient of an IM or landmark/notecard
-O name specifies an attachment object name or outfit name
-S subject specifies the subject for a group notice
-s secret specifies a Bot secret, use environment instead
-T text specifies the notecard text or dialog button text for reply to menus
-u uuid specifies a UUID for use with actions that require one (e.g. sit)
-z num specifies a hover height adjustment size [default: -0.05]
can also be used to specify a payment amount
-d indicates dryrun mode - tell me what you would do without doing anything
-e displays a list of supported commands and examples then exits
-i retrieves Bot details
-h displays this usage message and exits
Environment:
Entries in ~/.botctrl can be LB_API_KEY, LB_SECRET, or entries
of the form LB_SECRET_BOT_NAME in order to support multiple bots
Entries can specify a Slurl alias. For example:
export SLURL_club='http://maps.secondlife.com/secondlife/Scylla/226/32/78'
A Slurl alias can be used with the -l command line argument, e.g. -l club
Entries can also specify a UUID alias. For example:
export UUID_Mover='xxxxxxxx-yyyy-zzzz-aaaa-bbbbbbbbbbbb'
A UUID alias can be used with the -u command line argument, e.g. -u Mover
Examples:
botctrl # Displays the status of the default Bot
botctrl -a login -l Home # Default Bot login to Home location
botctrl -a touch_prim -n 'Jane Doe' -u Mover # Jane Doe bot touch object with aliased UUID
botctrl -a stand -n Jane -c John # Jane bot sends the stand command to Corrade bot John
botctrl -a teleport -l club # Uses a 'club' location alias defined in .botctrl
Supported Actions
Supported actions for BotControl Configuration:
bot_alias, loc_alias, slurl_alias, uuid_alias, list_alias, alias
Supported actions common to both Corrade and LifeBots:
activate_group, attachments, avatar_picks, get_balance, get_outfit, get_outfits, give_inventory,
give_object, give_money, give_money_object, im, key2name, listinventory, login, logout,
name2key, notecard_create, rebake, say_chat_channel, send_group_im, send_notice,
set_hoverheight, sit, stand, status, takeoff, teleport, touch_prim, walkto, wear, wear_outfit
Supported actions for LifeBots only:
bot_location, reply_dialog, touch_attachment
Supported actions for Corrade only:
attach, conference, conference_detail, conference_list, createlandmark, currentsim, detach
fly, flyto, getattachmentspath, getavatarpickdata, getgroupmemberdata, get_hoverheight,
getmembersonline, getregiontop, getselfdata, inventory cwd, networkmanagerdata