Table of Contents

Frequently Asked Questions (FAQ)

Here is a set of re-ocurring questions for the Corrade bot.

Does Corrade require hosting?

Yes. Corrade is software. You will need some form of hosting, whether it is your computer or rented space. Roughly, instead of wasting money on rented space, we recommend you look into SBCs such as the raspberrypi which are computers the size of a TV remote. You can hook up the RaspberryPi to your network, leave it on, and run a bunch of Corrades on it unattended, rather than leaving your PC on all the time.

What can I do with Corrade

Corrade just exposes all viewer functionality such that it is accessible to LSL. You can certainly use Corrade for land rentals. In fact, Corrade is currently being used for some "games" in Second Life, such as virtual fishing and hunt games. Given Corrade's feature set, you can be quite creative using the API provided by Corrade.

Some ready-made scripts are provided (called templates) that vary from notes to fully functional scripts. These are meant as examples for scripters but they mostly can be seen as individual ready-to-run projects.

Is Corrade free?

Yes. Corrade is entirely free and licensed under a custom license.

Will Corrade Always Be Free

Corrde will always be free!

If Corrade is free, am I the product?

Maybe. Corrade does not collect any data on its users for monetization purposes. However, if you wish to contribute, there are many ways to do so - ranging from advertisement and up to writing and sharing your scripts with the rest of the user-base.

Is Corrade OpenSource?

No. The closest approximation for Corrade would be "freeware".

However, all the starting templates provided and any scripts written for scripters are OpenSource. Furthermore, all scripts written by Wizardry and Steamworks intended for Corrade can be used under a relaxed license. For more details please check the Corrade license. You are also free to monetize Corrade services, bundle Corrade as part of a larger project or use Corrade as you see fit provided you give attribution for Corrade to Wizardry and Steamworks.

On what platforms does Corrade run?

Corrade runs natively on Windows and Unix-like platforms. The latter include Linux distributions and several kinds of hardware platforms (x86, ARM etc…).

How do I start programming and working with Corrade?

The first thing to do is download Corrade and configure it to log-in to Second Life. The quick set-up guide should help you to achieve that. After your bot is in-world, you can use the provided example scripts to get the hang of how LSL interacts with Corrade. Provided is also the command tutorial that gives several examples of what you can do with Corrade.

How does Corrade manage access control?

Corrade manages access control per group rather than per avatar. In other words, once you specify that some group, with some password is able to trigger commands on Corrade in the configuration file, then Corrade will allow any scripts that authenticate with the same password to manipulate a group. Corrade does not care to whom the LSL script belongs to. You can, for example, create an inviter script in Second Life, set the appropriate permissions, and then sell the script as a black box, thus allowing buyers to manipulate a group without knowing the authentication details nor seeing the script.

Why does Corrade use Groups instead of Avatars for Access and Permissions

Groups in Second Life are the lowest common denominator for permissions. Whilst grid Gods are usually able to issue grid-related operations, estate managers have a limited list of estate settings, avatars do not have any permissions to anything other than their own assets. Most actions in Second Life, even sharing land with someone, streaming music through a device, allowing avatars to rez objects from inventory and even very trivial operations such as creating a landmark are restricted by group-managed land. Most avatar operations, except from moving around or teleporting (n.b. teleporting is also restricted by teleport routing, that, in turn is restricted by land permissions, that, in turn, is restricted by some group permission) are sooner or later restricted by land which, in turn, is restricted by some group's ACL.

In order to ensure that commands are executed successfully, all commands have to query the grid for permission - this is because in the absence of a graphical display, trial and error (as it is with most viewers) will not be able to report back on whether a command executed successfully or not. Most of the checks performed by Corrade, in the end, end up querying group permissions.

Why doesn't Corrade restart itself and why do I have to use a restarter?

It would be redundant to have Corrade restart itself because there are tools out there that are able to sense a lot of operating system conditions such as network status, CPU load, traffic and so on, and then restart a daemon based on those conditions.

No daemon restarts itself - examples include web-servers, mail servers and so on that, once crashed, will remain crashed until the operating system or the user restarts them. Even on Windows, services are usually run via a wrapper that restarts the service in case it has crashed.

It is important to use a restarter, because your system may go down or the grid that Corrade is connected to may become unresponsive. By running Corrade as daemon, you will be able to set it in the background and the operating system will make sure to restart Corrade.

I have downloaded the bot, configured Corrade but I get a login error when I run it.

The usual error returned when the password has not been accepted by Corrade is:

login failed : key

You may have forgotten to prepend $1$ to the password hash that you generated. This is what an MD5 password hash looks like:

$1$59bcc3ad6775562f845953cf01624225

The $1$ at the beginning marks the hash as an MD5 hash whilst the rest (59bcc3ad6775562f845953cf01624225) is the actual MD5 hash that you may have obtained when hashing your password.

If you are on an Unix system you can generate an unsalted MD5 password hash locally after which you have to prepend $1$ to the result. Otherwise, you can use a good client-side online MD5 unsalted password hasher.

If the password is hashed correctly, note that Second Life seems to discard passwords longer than 16 characters and will return the same error login failed : key. If your password is indeed longer than 16 character, you can try a shorter password instead.

What does "presence" mean?

In certain circumstances, you may get the error:

login failed : presence

on start-up. This means that Corrade attempted to connect to an account to which a client (viewer, or bot) was already connected to.

The error may happen if you kill Corrade very fast (for example, on Linux, by using the kill with SIGKILL) such that Corrade does not first disconnect from Second Life properly before Corrade is started again. In such situations, it will issue the error above and then connect again.

Note that if you do this many times, you may see the error:

login failed : ban

which, aside from the obvious, means that the account has been temporarily throttled. Usually, you can wait a few minutes before starting Corrade again and the error will ago away on its own.

Does Corrade work on OpenSim?

Other than group operations, Corrade follows the current Linden protocols and is always tested in Second Life. If a Corrade feature works in Second Life but does not work on OpenSim then it is an OpenSim bug or the feature is exclusive to Second Life (ie: web-centric Second Life services).

Corrade implements a few workarounds for OpenSim but given how superficial OpenSim's implementation of Linden protocols is, there is no guarantee that any command will work at all.

Help! I am sending an URL through Corrade that contains spaces and Corrade breaks it!

This happens for SLURLs like secondlife://Some%20Simulator/32/13/34 when Corrade transforms %20 into space such that the buggy official viewer does not recognise it as a link anymore.

Send the link as: secondlife://Some%2520Simulator/32/13/34 and it will work (%2520 translates to %20).

I am trying to add a group to Corrade's configuration file with some special characters.

For an XML entity, some characters are special and must be replaced with their escaped counterparts. Here is a table of characters and what they must be replaced by:

Character Escape
" "
' '
< &lt;
> &gt;
& &amp;

So, for example, for a group named Wizardry & Steamworks, the group name must be entered in the Corrade configuration file as:

Wizardry &amp; Steamworks

When I send commands from LSL for a hidden group, I always get access denied or group not found.

Instead of passing the group name to the group parameter, pass the group UUID. The reason of the error message is that Corrade cannot find the group due to the group being hidden and thereby not listed in the directory services.

How do I invite an avatar to a role directly?

You can do that directly with the invite command and by specifying a role (either by name or UUID). You will need:

  • Corrade group permission in Corrade's configuration file for the group you wish to invite to.
  • In-world group permissions for the bot's role to invite members.
  • In-world group permissions for the bot's role to assign group members to any role.

If you want to be on the safe side, the following role settings that Corrade is part of in your group should be exhaustive:

  • Membership→Invite People to this Group
  • Roles→Assign Members to Any Role
  • Roles→Assign Members to Assigner's Roles

After that, you can send the command as:

        llInstantMessage(CORRADE, 
            wasKeyValueEncode(
                [
                    "command", "invite",
                    "group", GROUP,
                    "password", PASSWORD,
                    "firstname", "Bo",
                    "lastname", "Derreck",
                    "role", wasURLUnescape("Shits & Giggles"),
                    "callback", wasURLUnescape(URL)
                ]
            )
        );

Remember to always use a callback to check the result of sending the command to Corrade - Corrade goes out of its way to extensively provide you with error messages that will help elucidate the situation in case a command fails to work as expected.

Corrade and Upstream Proxies

Second Life uses both UDP and TCP - more recently, a lot of services have been moved through CAPS. It seems that some proxies interfere with CAPS and that Corrade is unable to retrieve the result. For example, trying to access SL through Tor is a funny experience.

Here is a list of common symptoms when you have an upstream proxy that does not play well with SL:

  • The inventory does not seem to load entirely; the inventory finally loads but sending inventory-related commands that refer to an item you have double-checked exists returns an error message indicating that the item does not exist.
  • Corrade does not seem to know in which groups it is.
  • Some notifications such as group messages fail intermitently.

all these symptoms indicate that you are pushing Corrade's packets through an upstream proxy. If you have a complex set-up, first try to disable all proxies - you know what to do. Since Corrade acts as a console application, on Unix systems, there usually is no proxy set for the command-line.

In order to disable all proxies, up to Windows 7, you can open Internet Explorer→Settings→Connections (Tab)→Lan Settings… and untick all the boxes:

Under Windows 10 you can find the setting in Network & Internet:

My bot has trouble rezzing (or rezzes as a cloud)

There are two known possibilities for Corrade to rez as a cloud:

  • Corrade is wearing more than one attachment per attachment slot; multiple attachments per slot have been introduced with Emerald back in the day and the feature has been Lindenized over time, unfortunately to this date Corrade does not support wearing more than one attachment per slot and will appear as a cloud when logging in.
    • it is possible to wear more than one attachment per slot but in that case the outfit has to be re-applied every time the bot logs in,

  • Corrade is not wearing at least one of: skin, eyes, hair or shape; for an avatar to render in SecondLife, at least one of each body part must be worn. Viewers tend to outright prohibit the user from removing a body part without a substitute but Corrade allows it.

Autopilot with Altitude

Second Life contains a long-standing bug that makes an agent behave arbitrarily in case an altitude is specified to the autopilot command. In case you want to make the bot fly to a location instead of walk, consider using the flyto command which is much more versatile.

Or both could be combined:

  • Use walkto to move on surfaces / ground.
  • Use flyto to make Corrade fly to a destination.

Why are some wearables are not reported by Corrade?

Due to (a) bug(s) in libopenmetaverse, when wearing certain wearables (a skirt, for example), the wearables will not show on the bot. This is a bug that has been reported several times, fixed and then reported again.

This makes the wear commands of Corrade have inconsistent behaviour. Once these bugs have been addressed in libopenmetaverse, the commands will work as expected.

My bot falls off vehicles when crossing regions

Unfortunately, this issue is present in Radegast, Metabolt and all the other viewers. We are unsure what is causing this since Corrade does not take any special action on crossing regions on vehicles. It is most likely a bug in libopenmetaverse and has been previously reported multiple times in third party viewers. We are still looking to solve this one but there is little we can do so far.

Do I need to upgrade?

The Corrade version cycle consists in pushing frequent updates in response to tickets for fixes and enhancements. All Corrade software releases are incremental, in that ulterior versions are deemed better than previous releases. Furthermore, the download website will provide a changelog for both release and continuous builds such that you can check whether any included updates are of interest to you.

What firewall ports are required by Corrade?

Aside from the servers that Corrade implements and that you configure yourself, Corrade uses the same ports to communicate with SecondLife servers as any other viewer. For more information on the requited SecondLife ports, please see the Using Second Life with a Firewall knowledgebase.

Do I have to restart Corrade after making a configuration change?

No. Corrade will reload the configuration once it senses that the configuration file has been altered; this includes committing a configuration via Nucleus.

Does Corrade transmit any private data to Wizardry and Steamworks or third-parties?

No. Wizardry and Steamworks does not receive any private data.

Does N°9 Peanut Work with Corrade?

No. And. . .

Since some time (cca. 2019) OpenCollar has split into two branches: the old opencollar and the new opencollar at opencollar.at due to some misunderstanding between the developers, summarily JT reports:

"Before I logged back in after crashing, I did a little checking on the OC thing and OC is still open source; however, there has been a divide in the developers and now there is a fork. Most of the work over the last 6 years was done by Wendy's team and they continue to develop the "fork" while the original founders of the OC movement have kicked Wendy and crew outta the "official" OC group and have released V7, which seems was a rollback to 6.7 with some mods. Wendy et alia maintain the same line of development everyone has known as OC and all the code is available on github https://github.com/OpenCollarTeam/OpenCollar. From what I read here https://www.opencollar.at/updates.html, I'd guess the OC's up to 4.0 would be a safe bet and probably anything updated by Wendy's group N°9 Peanut would probably work...now, where did I put 3.997?" - JT

Unfortunately, Peanut N°9 makes some vital changes to the way inventory items are handled and changes the way the RLV API works which would mean two side-by-side implementations.

Ultimately, the Corrade API is sufficient for creating an RLV bridge and, over time, RLV will be removed from Corrade and perhaps a template provided in exchange with the following notes:

  • RLV was designed, as per the nomenclature, to impose restrictions on the avatar and the the RLV API contains very few commands such that implementing most of the RLV API would be meaningless with Corrade.
  • The Corrade API supersedes the RLV API by far.

Why Not Just Use Some Cool Format?

Corrade is developed primarily with LSL scripting in mind where the stack, heap and even program code are coalesced together in $64KiB$ of memory. Empirically, after more than 1000 lines of written LSL, undefined behaviour starts to surface and the application is best redesigned.

Key-value pairs and comma separated values is the only minimal format that can be used that benefits from the least amount of syntactic sugar. Otherwise, if developing out of world, Corrade can be switched to a different language (JSON, for example).

One has to keep in mind that only $2KiB$ of data may be received by an LSL script in a single HTTP request such that the more meaning that can be packed in a message the better.

Expression JSON WAS Syntactic Sugar
"A is C" { "A": "C" } A=C 7 vs. 1
"A is a list" { "A": [ 1, 2, 3 ] } A=1,2,3 9 vs. 3
"A is a list of p by q" { "A": [ "p": 1, "q": 3 ] } A=p,1,q,3 14 vs. 4

Google protobufs is really just JSON but with garbled data - a bit like Wizardry and Steamworks likes to create very long command names for Corrade :-) XML is heavier than both…

How do I Run Multiple Bots?

For each bot a separate install folder can be created and then each bot can be run as a separate instance: one bot per install folder. Corrade does not mess with operating system parameters such as the registry such that Corrade can be considered a portable application.

Is it Not More Efficient to Run Multiple Bots on a Single Binary?

No. At best, some cached items might be shared amongst the various instances but overall it would not pay off for he extra complication of keeping the internals of each bot to spill over each other.

Getting Accurate Avatar Positions Within a Simulator

Currently there is no way for a viewer to retrieve accurate positions of avatars within a simulator. Traditionally, simulators have been scanned for avatars and primitives using region scanners such as the region scanner created by Wizardry and Steamworks. However, depending on the nature of the application, there are several variants that might achieve similar results:

  • the getregiontop command returns a partial list of colliders and scripted objects,
  • the mapfriend command and the tracker notification counterpart will provide accurate position of friends that have granted the "find me on the map" permission to Corrade,
  • thethe getavatarsdata command with a large enough range will find avatars but it will report relative positions for avatars sitting down.
  • the llGetAgentList LSL built-in function will retrieve a list of avatars that can then be further queried for positions using llGetObjectDetails,
  • the getavatarpositions command returns the position of avatars but is capped at about $1024m$ in altitude,
  • the getmapavatarpositions Corrade command will return clusters of avatars on remote regions but their positions will not be accurate

Are temporary attachments supported?

Unfortunately, temporary attachments attached via the LSL command llAttachToAvatarTemp are not supported due to the underlying mechanisms requiring attachments to have an inventory UUID and temporary attachments are not registered within the agent inventory.

The trivial workaround is to simply give the item to Corrade and then wear the item with the attach command like any regular object after which a detach command will remove it successfully.

An additional yet simple workaround is to use the changeappearance command to reset the outfit and get rid of the temporary attachment. This works because changing the outfit works via a different mechanism to replace all the items on the avatar regardless whether they are temporary or not.

Index


secondlife/scripted_agents/corrade/faq.txt · Last modified: 2021/10/29 06:11 by office

Access website using Tor Access website using i2p Wizardry and Steamworks PGP Key


For the copyright, license, warranty and privacy terms for the usage of this website please see the license, privacy, copyright and the plagiarism pages.