Corrade

en-verb|corrades|corrading|corraded

  1. (obsolete) To gnaw into; to wear away; to fret; to consume.
  2. (geology) To erode, as the bed of a stream.
  3. (obsolete) To scrape together or rake together; to accumulate laboriously.

About

Corrade is a multi-purpose, multi-platform scripted agent (bot) that runs under Windows or Unix natively, as a service or daemon whilst staying connected to a Linden-based grid (either Second Life or OpenSim) and controlled entirely by scripts. We like to think of Corrade as a bridge, that gives access to viewer-commands to LSL scripts. Corrade does not stop at providing viewer-commands to LSL scripts but reaches into the Internet of Things (IoT), Big Data and Artificial Intelligence (AI) by implementing the latest technologies and communication protocols. Corrade's target audience consists of programmers that will use Corrade as a building block and then create an end-product.

Scripting templates are provided in the Corrade store that are closer to an end-product yet they are meant to provide a starting point for programmers by illustrating some of the aspects of programming with Corrade. The templates can be changed or created differently (or better) by a programmer that interfaces with Corrade. If a specific targeted application is desired that requires a scripted agent, then chances are that a programmer would be able create one using Corrade.

Requirements

  • Corrade can run on the following platforms and architectures:
    • Linux 64bit,
    • Linux ARM 32bit,
    • MacOS 64bit,
    • Windows 64bit (Windows 7 onward)
  • .NET Core 3.1 runtime (but SDK will do too) installed for all platforms supported by Corrade.
  • 100-350 MB RAM with all options turned on.
  • DSL onward (Linden Lab recommends cable, not wireless).
  • Corrade uses the BROKEN-LINK:exact same firewall ports as any other view in Second LifeLINK-BROKEN. Additionally, any Corrade feature that requires an additional port will have to be forwarded to the machine that Corrade runs on.

Download

The latest Corrade is available at:

where higher version numbers, from left to right, represent the more recent versions (ie: a release with version number 11.0.1.2 would be newer than a release with version number 11.0.1.0).

The latest Corrade RVMs (Referential Virtual Machines) are avaiable at:

Setup Instructions

.NET Core has to be installed for the platform that Corrade runs on, packages for Linux distributions and binaries are available on the Microsoft .NET Core 3.1 website.

The Corrade binary can be executed from the extracted folder directly on all platforms with no further requirements. Upon executing the binary, Corrade will most likely mention that no configuration has been found and that a webserver named Nucleus has been launched in order to perform an initial configuration.

Redirect your browser at: http://127.0.0.1:54377/ on the machine running Corrade - or, access the Nucleus web interface through the network by pointing the browser to http://TARGET_MACHINE:54377/ where TARGET_MACHINE is the hostname or IP address of the machine on which Corrade has been launched.

Make sure that all ad-blockers are disabled and, upon accessing the Nucleus web interface, authenticate using the nucleus password. When the interface loads, click the Configurator panel and authenticate again with the nucleus password.

A configuration form should now load up and the minimal required fields to get the bot connected to the SecondLife grid are the following:

  • LoginFirstname, Lastname and Password - these are the credentials of an existing account in SecondLife that the bot will use to connect to the grid,
  • GroupsGroup name and Password - for best results, the group must exist in SecondLife and the password can be any made up string. Both the group name and the group password are used together as an authentication tuple in order to control Corrade via scripts. The "default" or "example" group [Wizardry and Steamworks]:Support can be edited or removed.

Once the configuration is complete, click the Commit configuration, authenticate again using the nucleus password and wait for the bot to connect to the grid. In case the bot is unable to connect, the errors logs can be consulted under Logs/Corrade.log in order to attempt and determine the cause.

In case all else fails, shut down the bot and remove the Configuration.xml file manually and then restart the bot in order to go through the initial configuration phase again. In order to make adjustments to the configuration, simply access the web interface again and use the Configurator tool to make any changes necessary - in most cases, Corrade does not need to be restarted after making configuration changes. In order to run multiple bots, Nucleus.xml.default can be renamed to Nucleus.xml and then edited in order to change the listening address and port for Nucleus - similarly, the nucleus password can be changed within the same file.

Since Corrade is designed to be a long-running process and given power or Internet outages, the contrib folder contains sub-folders for every supported platform with instructions on how to demonize Corrade.

Communications Overview

Flow

  • Corrade connects as a client to Second Life.
  • An LSL script is used from within Second Life to send commands to Corrade.
  • LSL: an LSL script can have a callback installed such that Corrade will connect via HTTP POST to the LSL script or a different web-server and print the outcome of the command.
  • Optionally, Corrade can send notifications to a different (or the same) URL.
  • HTTP: Corrade also bundles an integrated web-server to which you can submit commands from outside of SecondLife via PHP, perl, python, ruby, etc…
  • MQTT: Corrade also bundles an integrated MQTT server to which scripts can subscribe in order to receive notifications or publish commands to be executed.

Documentation & Tutorials

You can find basic tutorials on how to interact with Corrade on the tutorials page.

Application Programmer Interface

The application programming interface can be found on a separate page and describes all the commands that can be sent to Corrade along with examples.

Scripting

Security

Performance

Frequently asked Questions (FAQ)

Template Store

You can find scripting templates (that also function as test harnesses) in Corrade's store on the Second Life marketplace:

they are demonstration scripts that could provide you with a starting base for programming with Corrade.

HTTP Templates

Hosting Providers

A list of general purpose providers or geared towards usage with Corrade is mentioned in this section.

Docker

Docker is a free service for one private repository (root-jail), and up to USD7 per month for 5 private repositories (you can find more information on the Docker pricing page.

Self-Standing Servers

These hosting providers are known to work with Corrade:

  • Kimsufi has shared hosting and dedicated hosting and reports are that you can install your own OS onto the machine if you so wish. More information on installing Windows on Kimsufi servers can be found around on the Internet (such as BROKEN-LINK:creating you own templateLINK-BROKEN or BROKEN-LINK:using an already created templateLINK-BROKEN).
  • Digital Ocean has Unix servers (Ubuntu, FreeBSD, Fedora, Debian, CoreOS, CentOS) starting from USD5 per month. The servers are located in San Francisco and pretty close to Linden Lab's servers. Several customers are running Corrade on their servers and they seem to be stable.
  • OVH has shared hosting and dedicated hosting (Unix and Windows) with data-centres in Canada and Europe. The pricing starts at USD2.99 or 2.40 EUROs per month. You have to pay for the Windows license separately (you pay to OVH and they pay a Windows license subscription for you).

Contact and Support

If you need help with Corrade (installing, setting up, general questions), we can be contacted by using the contact page.

Submitting Bugs or Requesting Features

If you would like to request a feature or report a bug, please use:

To create a bug report, please make sure to provide a minimal, reproducible and complete example of the problem you are experiencing. This roughly includes creating a test scenario with the following points in mind:

  • include minimal code snippets, screenshots or a video that illustrates the problem without providing a large code listing that may have other problems that do not necessarily pertain to the software you are opening a bug for
  • all the required parts of your testing scenario are either provided or documented and thus complete, ie: "using the software this version, configured in this way, on this operating system, and running the following code, [… etc …] the software does this and it should be doing that instead"
  • make sure that your testing scenario will produce the issue you are filing a bug report for illustrates the issue every time you run the scenario thereby being reproducible - if it is possible to check from different environments, ie: Windows, Linux, from different network locations, etc then please do include the extra testing

Additionally, please be aware that we barely can provide any support for products that are not made by Wizardry and Steamworks - we cannot take upon ourselves the responsibility of other products and it would be wrong to do so; this includes various operating systems, such as Linux distributions, or "in-world brands" to which we may not even have access to or would require purchases on behalf of Wizardry and Steamworks.

In case you are having a problem with a product that transgresses Corrade, please try to reduce and then reproduce the problem: for instance, in case of in-world products that you wish to interact with Corrade, reduce the problem to a set of primitives that can be re-created easily; conversely, in case of trouble with an operating system or Linux distribution, please refer to the Corrade Referential Virtual Machines (RVMs) for a common point of reference.

Third-Party Software

License and Terms

Wizardry and Steamworks Project-Closed and Open-Derivatives License 1.0 (WAS PC & OD 1.0)

Wizardry and Steamworks allows the use, commercial use, private use, copy, redistribution and sublicensing the Software without prior consent from Wizardry and Steamworks provided that attribution is granted in a visible and reasonable manner to Wizardry and Steamworks, no reverse-engineering is permitted of any distributed binaries or binaries of work licensed to Wizardry and Steamworks connected to the Software, no warranties are provided with the Corrade software nor with any other works related to the Software and that no warranties shall be implied whether in an action of contract, tort or otherwise, arising from, out of or in connection with the Software or the use of other dealings in the Software.

Permission is hereby granted to extend the WAS PC & OD, including its restrictions and limitations, to any material licensed to Wizardry and Steamworks, when the intent is to re-use material published by Wizardry and Steamworks, for creations or derivate works, that interact with or include Corrade as a component of those creations or derivate works, regardless of any other license or terms (GNU GPL, MIT, BSD, etc.) that may apply to the material licensed to Wizardry and Steamworks.

Thanks

  • Tatiana Lapis @ FunGames Central for the many suggestions during Corrade's development - she runs a large business using Corrade.
  • AlphaVille Residential owners for using Corrade and offering suggestions and reports - they manage their rentals using Corrade.
  • BROKEN-LINK:Second Life ShelterLINK-BROKEN is one of the oldest newcomer friendly help and hangout region run by FireEyes Fauna and they currently use Corrade to process group invites, send event notices, manage land settings, etc…

and…

  • all the other people that submitted a bug report even once which allowed us to fix important bugs.

Translators

Many thanks to our translators!

  • German - Sidius Core
  • Spanish - Damian Zhaoying
  • French - Mat Nyoki, Jaime Poutine
  • Polish - Martynka Adamski

Historical Contributors

We would like to thank the following people (in no relevant order) for their extended testing of Corrade and patience with us:

along with the contributors on the Corrade bug reporting page.

Press

Logos and Vanity Items

Index


secondlife/scripted_agents/corrade.txt · Last modified: 2021/05/02 02:03 by office

Access website using Tor Access website using i2p


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