Differences

This shows you the differences between two versions of the page.

@@ Line 1: / Line 1: @@
+<WRAP info box>
+====== Corrade ======
+//en-verb//|corrades|corrading|corraded
+  - (//obsolete//) To gnaw into; to wear away; to fret; to consume.
+  - (//geology//) To erode, as the bed of a stream.
+  - **(//obsolete//) To scrape together or rake together; to accumulate laboriously.**
+</WRAP>
+====== 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// in various programming languages are provided in the Corrade store (for free) that 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. At the current time, Corrade is a mature project, with almost two decades of experience and history in SecondLife and OpenSim, with a large number of issues solved, bugs fixed and nearly all of the SecondLife API being implemented and offered through the API. Corrade releases are now infrequent due to the coverage being almost complete, with a few missing parts that require upstream changes that we do not wish to challenge. After so much time, we are proud to say that Corrade sets the standard in what regards interfacing with virtual worlds being one of the first precursors to many developments and being used by many creators to automate various tasks.
+====== Requirements ======
+  * Corrade can run on the following platforms and architectures:
+    * Linux - [[https://dotnet.microsoft.com/en-us/download/dotnet|the stable version "Standard Term Support" of .NET]] has to be installed
+      * Linux 64bit,
+      * Linux ARM 64bit or AARCH64,
+        * ARMv7 or more required (please check your hardware),
+        * Raspberry Pi first generation (v1) are not compatible since they have ARMv6 which is not supported. The following will not work: Raspberry Pi v1, v2, Zero v1, most of which are now outdated,
+    * Windows 10 and up
+    * MacOS (macOS 10.12 Sierra and up)
+  * 100-350 MB RAM with all options turned on.
+  * For the network, Linden Lab recommends cable and not wireless.
+  * Corrade uses the [[https://community.secondlife.com/knowledgebase/english/using-second-life-with-a-firewall-r599|exact same firewall ports as any other viewer in Second Life]].
+    * Any Corrade feature that requires an additional port such as the interfacing servers will have to be forwarded to the machine that Corrade runs on.
+====== Download ======
+The latest Corrade is available at:
+  * {{https://ci.grimore.org/buildStatus/icon?job=Corrade&.png?direct}} [[https://corrade.grimore.org/download/corrade|Corrade]]
+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'').
+====== Setup ======
+Corrade can be downloaded from our releases page by selecting the correct platform and architecture or, alternatively, by using containerization like Docker and pulling our official image (note that at the time of writing, containerization is the canonical way of running Corrade).
+In case Docker is used with the official image that we provide, then no extra setup is required and Corrade can be ran under Docker.
+In case Corrade is downloaded and unpacked without Docker, then the executable binary should start and run Corrade in Windows. On Linux machines the latest **.NET runtime** is required to run Corrade (note that the SDK is not needed, just the runtime) and Microsoft provides [[https://dotnet.microsoft.com/en-us/download/dotnet|Linux distribution-compliant packages]] for most Linux distributions.
+Regardless how Corrade is installed, upon starting Corrade, Corrade will mention that no configuration has been found and that the Nucleus web-server has been launched in order to perform an initial configuration.
+Nucleus listens on all addresses so if Corrade is installed on the local machine then the Nucleus interface will be available at following URL:
+  * ''<nowiki>http://127.0.0.1:54377/</nowiki>''
+If Corrade is running on a different machine, then the Nucleus web interface can be accessed through the network by pointing the browser to ''<nowiki>http://TARGET_MACHINE:54377/</nowiki>'' where ''TARGET_MACHINE'' is the hostname or IP address of the machine on which Corrade has been launched.
+Upon accessing the Nucleus web interface, log-in using the default password ''nucleus'' (this can be changed later by copying ''NucleusConfiguration.xml.default''' to ''NucleusConfiguration.xml'' and then changing the password) and a configuration form should now load up.
+==== Minimal Configuration ====
+As a reference, the minimal fields required to get the bot connected to the SecondLife grid are the following:
+  * ''Login'' -> ''Firstname'', ''Lastname'' and ''Password'' - these are the credentials of an existing account in SecondLife that the bot will use to connect to the grid,
+  * ''Groups'' -> ''Group name'' and ''Password'' - the group corresponding to the group name //must// exist in SecondLife and the password can be any made up string; the default ''[Wizardry and Steamworks]:Support'' group can be edited or removed
+Once the configuration is complete, click the ''Commit configuration'' and wait for the bot to connect to the grid.
+In case the bot is unable to connect, the error logs can be inspected using the Nucleus web-interface by browsing to the ''Logs'' section in order to determine the cause. One trick, is to shut down the bot and delete the ''CorradeConfiguration.xml'' file manually and then restart the bot in order to go through the initial configuration phase again and hopefully set up the bot correctly. In case all else fails, [[/secondlife/scripted_agents/corrade#contact_and_support|you can file a ticket]] and we'd be glad to assist provided that the request does not involve setting up auxiliaries such as Linux or Docker for which help is better sought on their corresponding forums or support pages.
+===== Docker =====
+Docker is now the canonical way to run Corrade and it should be the preferred method regardless of the operating system because it adds an extra compartimentalization layer as well as being a "ready-to-run" solution that does not require the user to setup anything.
+Docker is easy to use, will just ask for an image and then Docker itself will manage process starting and restarting which has been a challenge for users in the past, in particular on Windows.
+  * https://hub.docker.com/r/wizardrysteamworks/corrade
+The Dockerfile can be found amongst the [[/assets/docker/build/corrade|docker build pages]] along with a matching [[/assets/docker/compose/corrade|compose file]].
+====== Documentation & Tutorials ======
+You can find basic tutorials on how to interact with Corrade on the [[http://grimore.org/secondlife/scripted_agents/corrade/tutorials|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.
+  * [[secondlife:scripted_agents:corrade:api|Corrade application programming interface (API)]]
+===== Template Store =====
+You can find scripting templates (that also function as test harnesses) in Corrade's store on the Second Life marketplace:
+  * [[https://marketplace.secondlife.com/stores/165275|Corrade Template Store]]
+they are demonstration scripts that could provide you with a starting base for programming with Corrade.
+===== Scripting =====
+  * For tips and tricks on programming with Corrade, please see [[secondlife/scripted_agents/corrade/scripting considerations|the scripting considerations page]]
+===== Security =====
+  * Various attack vectors on Corrade and how to mitigate them are presented on [[secondlife/scripted_agents/corrade/security_considerations|the Corrade security page]].
+===== Performance =====
+  * For performance improvements please see the [[secondlife/scripted_agents/corrade/performance considerations|Corrade performance page]].
+====== Frequently asked Questions (FAQ) ======
+  * Please see the [[secondlife/scripted_agents/corrade/faq|frequently asked questions page]].
+====== Contact and Support ======
+If you need help with Corrade (installing, setting up, general questions), we can be contacted by using [[wiki:contact|the contact page]].
+===== Submitting Bugs or Requesting Features =====
+If you would like to request a feature or report a bug, please use:
+  * [[http://bugs.grimore.org|The Corrade bug reporting system]].
+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 how to set up various Linux distributions, or in-world commercial items to which we may not even have access to or would require purchases on behalf of Wizardry and Steamworks.
+====== License and Terms ======
+[[/licenses/was-pc-od|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 license (WAS PC & OD), including its restrictions, limitations as well as benefits, 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 previously licensed to Wizardry and Steamworks.
+====== Logos and Vanity Items ======
+  * [[secondlife/scripted_agents/corrade/logos|Logos and Vanity Items]]
+====== Index ======
+{{indexmenu>secondlife:scripted_agents:corrade}}