GroupBots: Difference between revisions

From CasperTech Wiki
Jump to navigation Jump to search
 
(98 intermediate revisions by 6 users not shown)
Line 2: Line 2:
   |__TOC__
   |__TOC__
   |}
   |}
 
[[File:German_flag.gif]] [[GroupBots/DE | Schaue hier in Deutsch!]]
= '''<span style="color:#00528c">Group Bots</span>''' =
:# Log in to the [https://let.casperdns.com/ CasperLet website]
:# Click the "Group Bots" icon
:# You will be presented with a "Robot Army" page.  
:# This page has sections for [[SmartBots]], PikkuBots, [[METAbolt]], and the now-discontinued CasperBot.
:# Enter the appropriate information in for the bot system you are currently using
:# Hit save


If the renter accidentally ignores/declines the group invite, just have them click the rental unit and choose "GRP INVITE" from the popup menu. The rental units will '''only''' invite people who are current renters.
= '''<span style="color:#00528c">What will bots do?</span>''' =
A properly set up bot is capable of handling both invites and ejects for groups - either on rentals (for CasperLet) or product purchase (for CasperVend; both inworld and Marketplace) and if you choose to use a "personal bot" from SmartBots, the bot is also capable of handling bot-based delivery, ideal for products that are no-copy. (Inventory drops from scripted gadgets simply vanish, never to be seen again, if accidentally declined. If an item is sent from an avatar, it at least goes to the trashcan first when it's accidentally declined.)


==== Limitations ====
Bots are also able to send IM notifications from CasperLet - this means less chance of your renters missing the scripted message in local chat.  
A bot (any bot) '''cannot''' remove a tenant from the group '''IF''' they have been '''manually''' given any role other than the one they were originally invited to. The bot has no (scripted) way of knowing what additional role(s) they were granted, so there is no (scripted) way for the bot to know that it needs to remove them from the extra role(s).


==== Suggestions ====
A bot can also be configured to clear a parcel when a tenant is evicted from a rental box and ejected from your rental group. Use this feature with caution, however - if your bot clears your entire sim, that's on you!
If the land you're renting has individual parcels for each renter, be aware most people will want to be able to change their parcel media (for radio streams, etc.) Including permission to do that in the role you invite renters to will save you some time later.


= '''<span style="color:#00528c">Terminology</span>''' =
=== Terminology ===
----
: '''Bot:''' A unattended avatar account, used for automatic programmed activities or responses
: '''Bot:''' A unattended avatar account, used for automatic programmed activities or responses
: '''Self-Hosted:''' You need to host the bot yourself, on your own computer. If you don't normally have a computer on 24/7 *anyway*, then self-hosting is probably not for you.
: '''Hosted Service:''' You pay a third party to host the bot for you. Generally, you pay every week, and they are responsible for making sure everything is running.
: '''Self-Hosted:''' You need to host the bot yourself, on your own computer. If you don't keep a computer on 24/7 already, then self-hosting is probably not for you.


= '''<span style="color:#00528c">SmartBots</span>''' =
= '''<span style="color:#00528c">Landlords, Bots, and Permissions</span>''' =
Remember that your bot '''WILL NOT''' send a group invitation if the customer is '''already''' in the group.
 
=== Bot Roles ===
----
If you are a landlord, whichever bot you decide to use needs to be have all three of the following types of roles:
:* Everyone (the default role)
:* Your rezzing role for renters
:* Bot-specific role (this is just for the bot, not shared with others, and '''NOT''' an owner!)
 
=== Bot Permissions ===
----
Role permissions for the bot-specific role should have only these:
 
:* Invite People To This Group
:* Eject members belonging to the 'Everyone' role from this group
:* Assign members to assigner's roles
:* Remove members from roles
 
= '''<span style="color:#00528c">Hosted Service</span>''' =
 
== '''<span style="color:#00528c">SmartBots</span>''' ==
SmartBots is a third party bot hosting service that also allows you the option to have your own bot account hosted by them (so you don't have to run your computer 24/7 for your bot).  
SmartBots is a third party bot hosting service that also allows you the option to have your own bot account hosted by them (so you don't have to run your computer 24/7 for your bot).  


See the [[SmartBots | SmartBots]] page for more details.
=== SmartBots Information ===
----
:* SmartBots has a weekly fee. This may be paid at the terminal at the SmartBots store.
:* For information on pricing, see the '''[http://www.mysmartbots.com/docs/Prices SmartBots price list]'''.
:* The two types of SmartBot bots that can be used with CasperTech products are the '''group inviter''' bot and the '''personal bot'''.
:* Inviter bot will handle group invites and ejects '''ONLY'''
:* Personal bot will handle sending IM notifications '''in addition to''' the group invites.
 
=== SmartBots Instructions ===
----
:* For details on setting up your SmartBots bot, see the '''[[SmartBots | SmartBots]]''' page.
 
=== Sit, Rover, Sit! ===
----
To get your bot to sit on an object (pose stand, chair, etc.) follow the instructions on the '''[http://www.smartbots2life.com/docs/Sit_Second_Life_bot_on_selected_object SmartBots site]'''. These instructions are originally set up for SmartBots, but '''might''' work for other bots as well.
 
You will need the UUID of the object you want your bot to sit on. In Firestorm, you will see the object's UUID if you right-click then select "Edit". If you're using any other viewer, you can simply copy this script into a script file in your object, and once the script saves, it will tell you the UUID of the object in local chat (just open up your chat buffer and look for yellow text):
 
  default{
  state_entry(){
    llOwnerSay("This object's UUID is: " + (string)llGetKey());
    }
  }
 
If you re-rez your object, it will get a '''new''' UUID, so you will need to use this script again to make sure your bot is up to date.
 
= '''<span style="color:#00528c">Self-Hosted</span>''' =
In order for self-hosted bots to be used, they must be running 24/7 on a machine that YOU control.
 
== '''<span style="color:#00528c">Corrade Bot - Advanced Users Only</span>''' ==
{{Warning|Be sure to download the latest Progressive build of Corrade to ensure your Corrade instance works with CasperTech.}}
:* Corrade is for '''advanced''' users. You'll need some level of expertise with your operating system, with text editors, networking, etc. Or, be willing to RTFM and learn on the fly while you get your Corrade instance working.
:* Corrade is free to '''[http://grimore.org/secondlife/scripted_agents/corrade#download_binaries download]''' and use
:* Full documentation is '''[http://grimore.org/secondlife/scripted_agents/corrade at Grimore.org]'''
:* If you need technical assistance with Corrade you can find it '''[secondlife:///app/group/e269893f-a570-0087-930e-6ba2a0b77f9c/about here on the SL grid]'''.
 
=== Minimum System Requirements ===
----
:* Unix: Linux or BSD + Mono 3.2.8
:* Windows: .NET framework 4.5
:* x86 or ARM dual-core CPU
:* 250MB RAM
:* Always-on internet connection
:* An editor that loads and saves files encoded in UTF8
 
=== Corrade Instructions ===
----
See the '''[[CorradeBot | Corrade Bot]]''' page for details. Windows set-up instructions are courtesy of Aphrodite Atlas and may not always be up to date; use them at your own risk.


= '''<span style="color:#00528c">PikkuBots</span>''' =
== '''<span style="color:#00528c">ThoysBot</span>''' ==
PikkuBots is a bot system that allows you to download and self-host one or more bots, or they can host the bot for you. Pikku has 49 commands available for the "lite" version, and over 500 commands available for the "premium" version, whether or not you self-host or have them host a bot for you. Be aware that while PikkuBot is very powerful in features, it is potentially very complicated to get fully set up. If you get "lost" easily, consider METAbolt (if you want to self-host) or SmartBots (if you want to have someone else host the bot) instead.
:* Thoys Bot may be purchased at the '''[http://maps.secondlife.com/secondlife/WESTLAND/107/142/22 Westland sim/region]'''
:* The cost is L$ 2,000 up front
:* There are '''no''' monthly fees.
:* Documentation may be found on '''[http://slbot.thoys.nl/?page=manual the website]''' (and there's also a '''[http://slbot.thoys.nl/manual/bot-man/text.html text version]''')


==== System Requirements ====
=== Minimum System Requirements ===
----
:* Windows XP SP2, Win2000, Vista or Windows 7
:* .NET framework 3.5 or higher
:* Always-on internet connection


:* Microsoft .Net 3.5 SP1 - [http://www.microsoft.com/en-us/download/details.aspx?id=22 Download]
==== Available for ====
:* '''Windows:''' XP 32bit / 64bit, Vista 32bit, Home Server 32bit, 2003 Server 32bit / 64bit (others may work but are NOT tested)
----
:* '''Apple:''' Mac OS X 10.5 or later
: Windows: Default
:* '''Linux:''' Linux with Mono-Beta
: Linux: Must have Mono installed
: Mac: Only with a Windows or Linux emulator


==== Installation ====
=== Instructions ===
:* Download and install .Net if it's not already
----
:* Get PikkuBot Installer - [http://www.pikkubot.de/dokuwiki/doku.php?id=download Download]
See the '''[[ThoysBot | ThoysBot page]]''' for details. Setup instructions courtesy of Casper Warden.
:* Double-click on the installer.exe
:* Let the install complete


==== PikkuBot Info & Instructions ====
= '''<span style="color:#00528c">Deprecated</span>''' =
:* See how to [http://www.pikkubot.de/dokuwiki/doku.php?id=howtos:how_do_you_prepare_a_bot_account_-_sl_account_settings prepare a bot account for PikkuBots]
{{Critical|'''These bots are no longer developed and/or maintained. As of June 2016, they currently still work, but any existing - or new - bugs will not be fixed.'''}}
:* While there is a free trial week, you will need to be aware of [http://www.pikkubot.de/dokuwiki/doku.php?id=registration PikkuBot pricing]
:* View the [http://www.pikkubot.de/dokuwiki/doku.php?id=faq FAQ about PikkuBots]
:* View the [http://www.pikkubot.de/dokuwiki/doku.php?id=wiki PikkuBot documentation hub]
:* See the PikkuBot [http://www.pikkubot.de/dokuwiki/doku.php?id=installation:hint_regarding_vista warning with Windows Vista]
:* Troubleshoot [http://www.pikkubot.de/dokuwiki/doku.php?id=installation:error_messages_at_start error messages]


= '''<span style="color:#00528c">METAbolt</span>''' =
== '''<span style="color:#00528c">METAbolt</span>''' ==
METAbolt is a free text-based viewer for Second Life. METAbolt is popular for self-hosted bots because it needs minimal setup, and takes minimal system resources on the computer it is running on (so multiple instances can be running simultaneously).  
METAbolt is a free text-based viewer for Second Life. METAbolt is popular for self-hosted bots because it needs minimal setup, and takes minimal system resources on the computer it is running on (so multiple instances can be running simultaneously).  


==== System Requirements ====
=== Minimum System Requirements ===
:* Microsoft .Net 3.5 SP1 - [http://www.microsoft.com/en-us/download/details.aspx?id=22 Download]
----
:* Microsoft .Net 3.5 SP1 - '''[http://www.microsoft.com/en-us/download/details.aspx?id=22 Download]'''
:* '''Windows:''' XP/SP2, Vista, Windows Server 2003, Windows 7, Windows Server 2008
:* '''Windows:''' XP/SP2, Vista, Windows Server 2003, Windows 7, Windows Server 2008
:* Always-on internet connection


==== METAbolt Installation ====
=== METAbolt Installation ===
----
:* Download and install .Net if it's not already
:* Download and install .Net if it's not already
:* Download METAbolt - [http://www.metabolt.net/downloadbinary.aspx Download]
:* Get METAbolt - '''[https://bitbucket.org/METAbolt/metabolt.bitbucket.org/overview Download]'''
:* Open the .zip file and double-click on "setup.exe"  
:* Open the .zip file and double-click on "setup.exe"  
:* Let the install complete  
:* Let the install complete


==== METAbolt Instructions ====
=== METAbolt Instructions ===
:* See the [[METAbolt]] page for details on setting up your bot!
----
:* See the '''[[METAbolt]]''' page for details on setting up your bots.


= '''<span style="color:#00528c">CasperBot (Discontinued - No Support)</span>''' =
== '''<span style="color:#00528c">PikkuBot</span>''' ==
This is a discontinued product, so there is no warranty and no support.


CasperBot is a no-frills self-hosted bot that allows you to add group invite functionality to CasperVend or CasperLet. This is strictly a self-hosted bot.  
PikkuBots is a bot system that allows you to download and self-host one or more bots, or they can host the bot for you. Pikku has 49 commands available for the "lite" version, and over 500 commands available for the "premium" version, whether or not you self-host or have them host a bot for you. Be aware that while PikkuBot is very powerful in features, it is potentially very complicated to get fully set up. If you get "lost" easily, consider METAbolt (if you want to self-host) or SmartBots (if you want to have someone else host the bot) instead.  


==== System Requirements ====
=== Minimum System Requirements ===
:* Windows: Microsoft .Net 3.5 - [http://www.microsoft.com/en-us/download/details.aspx?id=22 Download]
----
:* '''Linux:''' Linux with Mono
:* Microsoft .Net 3.5 SP1 - '''[http://www.microsoft.com/en-us/download/details.aspx?id=22 Download]'''
:* '''Windows:'''
:* '''Windows:''' XP 32bit / 64bit, Vista 32bit, Home Server 32bit, 2003 Server 32bit / 64bit (others may work but are NOT tested)
<span style="color:#F00;">'''''Casper, What windows versions are supported?'''''</span>
:* '''Apple:''' Mac OS X 10.5 or later
:* '''Linux:''' Linux with Mono-Beta
:* Always-on Internet connection, for self-hosting


==== Capabilities ====  
=== PikkuBot Installation ===
:* Minimal feature set for small memory footprint
----
:* Invite users to your group
:* Download and install .Net if it's not already
:* Ejects users from your group
:* Get PikkuBot Installer - '''[http://www.pikkubot.de/dokuwiki/doku.php?id=download Download]'''
:* Checks to make sure user isn't already in group before inviting
:* Double-click on the installer.exe
:* Let the install complete


==== Instructions ====
=== PikkuBot Info ===
:# On Windows, install .Net 3.5. On Linux, install Mono.
----
:# Run the CasperBot application
:* See how to '''[http://www.pikkubot.de/dokuwiki/doku.php?id=howtos:how_do_you_prepare_a_bot_account_-_sl_account_settings prepare a bot account for PikkuBots]'''
:# At the command line, type in "login ''firstname lastname password''" and hit enter. (firstname lastname password are for your bot Second Life account: first name, the last name (or "resident" if your bot account has one of the newer one-word names) and the bot's SL password.  
:* For information on PikkuBot hosting rates, see the '''[http://www.pikkubot.de/dokuwiki/doku.php?id=registration PikkuBot price list]''' page.  
:# Wait until it finishes logging in (you'll see a bunch of scrolling text, this is normal)
:* View the '''[http://www.pikkubot.de/dokuwiki/doku.php?id=faq FAQ about PikkuBots]'''
:# Type "setmaster firstname lastname" giving the first and last name of YOUR avatar that owns the copy of CasperVend and/or CasperLet.  
:* View the '''[http://www.pikkubot.de/dokuwiki/doku.php?id=wiki PikkuBot documentation hub]'''
:# You need to find your avatar key and group key.
:* See the PikkuBot '''[http://www.pikkubot.de/dokuwiki/doku.php?id=installation:hint_regarding_vista warning with Windows Vista]'''
:# Login to CasperVend and/or CasperLet and provide your group key and avatar keys when asked (in CasperVend, it's on the Edit Product or New Product pages. In CasperLet, there's a button on your title bar called "Group Bots")
:* Troubleshoot '''[http://www.pikkubot.de/dokuwiki/doku.php?id=installation:error_messages_at_start error messages]'''
<span style="color:#F00;">'''''Casper, What else goes here for steps?'''''</span>


= '''<span style="color:#00528c">FAQ / Troubleshooting</span>''' =
=== Adding PikkuBot to CasperLet ===
----
:* See the config section on the '''[[METAbolt#Adding_MetaBolt_.28and_PikkuBot.29_to_CasperLet | Metabolt]]''' page for details on adding Pikkubot (they use the same configuration screen.)


: '''Q. Are bot-based group invites to the land holding group available upon renting?'''
=== PikkuBot bug ===
:: '''A.''' CasperLet has full integration with Pikkubots, [[SmartBots]] and [[METAbolt]]. Simply add your bot codes on the website and you're good to go.  
----
:* Your PikkuBot can '''NOT''' be on the same sim as '''ANY''' of your vendors, OR any neighbouring regions right next door to a region with your vendors, or group invites will not work. If you move your bot to another region, you may need to wait up to 2 minutes before invites will start working.


: '''Q. I have a rental box with settings to auto-evict tenants after ___ time. The box is overdue, but the tentant was not evicted. Help!'''
This is due to Pikkubot not understanding messages delivered with llRegionSayTo.
:: '''A1.''' This was a bug fixed in recent updates (version 1.20+) - You'll have to:
:::# Update your version if you're using an older one
:::# Disable the auto-evict for ALL rental units, and then save
:::# Then re-enable the auto-evict for ALL rental units, and then save
:: This will get them to properly auto-evict again.
:: '''A2.''' There is a LSL limitation that will prevent evictions if a tenant is added MANUALLY to any group role other than the role to which they were originally invited. For example, METAbolt invites renters to the "everyone" role, then landlord upgrades a tenant to a role with more privileges. Then when the tenant leaves and the rental unit evicts, the bot will send the usual evict notice and otherwise attempt to eject, but the eject will FAIL.
:: '''The fix:''' Either (a) give the "everyone" as many privileges as any upgraded tenant is likely to need, or (b) eject them manually when the rental ends.

Latest revision as of 18:31, 27 May 2024

Schaue hier in Deutsch!

What will bots do?

A properly set up bot is capable of handling both invites and ejects for groups - either on rentals (for CasperLet) or product purchase (for CasperVend; both inworld and Marketplace) and if you choose to use a "personal bot" from SmartBots, the bot is also capable of handling bot-based delivery, ideal for products that are no-copy. (Inventory drops from scripted gadgets simply vanish, never to be seen again, if accidentally declined. If an item is sent from an avatar, it at least goes to the trashcan first when it's accidentally declined.)

Bots are also able to send IM notifications from CasperLet - this means less chance of your renters missing the scripted message in local chat.

A bot can also be configured to clear a parcel when a tenant is evicted from a rental box and ejected from your rental group. Use this feature with caution, however - if your bot clears your entire sim, that's on you!

Terminology


Bot: A unattended avatar account, used for automatic programmed activities or responses
Hosted Service: You pay a third party to host the bot for you. Generally, you pay every week, and they are responsible for making sure everything is running.
Self-Hosted: You need to host the bot yourself, on your own computer. If you don't keep a computer on 24/7 already, then self-hosting is probably not for you.

Landlords, Bots, and Permissions

Remember that your bot WILL NOT send a group invitation if the customer is already in the group.

Bot Roles


If you are a landlord, whichever bot you decide to use needs to be have all three of the following types of roles:

  • Everyone (the default role)
  • Your rezzing role for renters
  • Bot-specific role (this is just for the bot, not shared with others, and NOT an owner!)

Bot Permissions


Role permissions for the bot-specific role should have only these:

  • Invite People To This Group
  • Eject members belonging to the 'Everyone' role from this group
  • Assign members to assigner's roles
  • Remove members from roles

Hosted Service

SmartBots

SmartBots is a third party bot hosting service that also allows you the option to have your own bot account hosted by them (so you don't have to run your computer 24/7 for your bot).

SmartBots Information


  • SmartBots has a weekly fee. This may be paid at the terminal at the SmartBots store.
  • For information on pricing, see the SmartBots price list.
  • The two types of SmartBot bots that can be used with CasperTech products are the group inviter bot and the personal bot.
  • Inviter bot will handle group invites and ejects ONLY
  • Personal bot will handle sending IM notifications in addition to the group invites.

SmartBots Instructions


  • For details on setting up your SmartBots bot, see the SmartBots page.

Sit, Rover, Sit!


To get your bot to sit on an object (pose stand, chair, etc.) follow the instructions on the SmartBots site. These instructions are originally set up for SmartBots, but might work for other bots as well.

You will need the UUID of the object you want your bot to sit on. In Firestorm, you will see the object's UUID if you right-click then select "Edit". If you're using any other viewer, you can simply copy this script into a script file in your object, and once the script saves, it will tell you the UUID of the object in local chat (just open up your chat buffer and look for yellow text):

 default{
 state_entry(){
   llOwnerSay("This object's UUID is: " + (string)llGetKey());
   }
 }

If you re-rez your object, it will get a new UUID, so you will need to use this script again to make sure your bot is up to date.

Self-Hosted

In order for self-hosted bots to be used, they must be running 24/7 on a machine that YOU control.

Corrade Bot - Advanced Users Only

Be sure to download the latest Progressive build of Corrade to ensure your Corrade instance works with CasperTech.
  • Corrade is for advanced users. You'll need some level of expertise with your operating system, with text editors, networking, etc. Or, be willing to RTFM and learn on the fly while you get your Corrade instance working.
  • Corrade is free to download and use
  • Full documentation is at Grimore.org
  • If you need technical assistance with Corrade you can find it here on the SL grid.

Minimum System Requirements


  • Unix: Linux or BSD + Mono 3.2.8
  • Windows: .NET framework 4.5
  • x86 or ARM dual-core CPU
  • 250MB RAM
  • Always-on internet connection
  • An editor that loads and saves files encoded in UTF8

Corrade Instructions


See the Corrade Bot page for details. Windows set-up instructions are courtesy of Aphrodite Atlas and may not always be up to date; use them at your own risk.

ThoysBot

Minimum System Requirements


  • Windows XP SP2, Win2000, Vista or Windows 7
  • .NET framework 3.5 or higher
  • Always-on internet connection

Available for


Windows: Default
Linux: Must have Mono installed
Mac: Only with a Windows or Linux emulator

Instructions


See the ThoysBot page for details. Setup instructions courtesy of Casper Warden.

Deprecated

These bots are no longer developed and/or maintained. As of June 2016, they currently still work, but any existing - or new - bugs will not be fixed.

METAbolt

METAbolt is a free text-based viewer for Second Life. METAbolt is popular for self-hosted bots because it needs minimal setup, and takes minimal system resources on the computer it is running on (so multiple instances can be running simultaneously).

Minimum System Requirements


  • Microsoft .Net 3.5 SP1 - Download
  • Windows: XP/SP2, Vista, Windows Server 2003, Windows 7, Windows Server 2008
  • Always-on internet connection

METAbolt Installation


  • Download and install .Net if it's not already
  • Get METAbolt - Download
  • Open the .zip file and double-click on "setup.exe"
  • Let the install complete

METAbolt Instructions


  • See the METAbolt page for details on setting up your bots.

PikkuBot

PikkuBots is a bot system that allows you to download and self-host one or more bots, or they can host the bot for you. Pikku has 49 commands available for the "lite" version, and over 500 commands available for the "premium" version, whether or not you self-host or have them host a bot for you. Be aware that while PikkuBot is very powerful in features, it is potentially very complicated to get fully set up. If you get "lost" easily, consider METAbolt (if you want to self-host) or SmartBots (if you want to have someone else host the bot) instead.

Minimum System Requirements


  • Microsoft .Net 3.5 SP1 - Download
  • Windows: XP 32bit / 64bit, Vista 32bit, Home Server 32bit, 2003 Server 32bit / 64bit (others may work but are NOT tested)
  • Apple: Mac OS X 10.5 or later
  • Linux: Linux with Mono-Beta
  • Always-on Internet connection, for self-hosting

PikkuBot Installation


  • Download and install .Net if it's not already
  • Get PikkuBot Installer - Download
  • Double-click on the installer.exe
  • Let the install complete

PikkuBot Info


Adding PikkuBot to CasperLet


  • See the config section on the Metabolt page for details on adding Pikkubot (they use the same configuration screen.)

PikkuBot bug


  • Your PikkuBot can NOT be on the same sim as ANY of your vendors, OR any neighbouring regions right next door to a region with your vendors, or group invites will not work. If you move your bot to another region, you may need to wait up to 2 minutes before invites will start working.

This is due to Pikkubot not understanding messages delivered with llRegionSayTo.