CORRADE SETUP FOR GROUP NOTICE/IM SCHEDULER
Corrade is a multipurpose program, free to download, that provides anyone with the ability to set up and run their own scripted agent (i.e., Second Life bot) directly from their own Windows or Linux-based PC. It’s capable of receiving commands from an LSL script that tell it to perform various functions, such as send notices, teleport, or even restart a sim. It can take a bit of time to set up a script to issue the proper commands, but there are script templates available for free on the SL marketplace to help you get started.
For this project, I have already done the work of creating a scripted object that uses Corrade to send group notices and IM’s. The rest of this document will focus on how to set up your bot in a way that will let it work with the scripted object. After that, I’ll explain how to set up the scripted object so that it can interact with your bot.
1. Set up your bot avatar
Before getting started, you’ll need to create an avatar to use as your bot. You do this the same way you would create any other avatar: By going to http://Secondlife.com and clicking “Join Now”, then filling out the appropriate information, choosing a username, choosing male or female, choosing an appearance, etc. Alternatively, you can repurpose an avatar account that you previously created.
After setting up the avatar, you’ll need to log into the account with your viewer and join any groups you want it to belong to. You’ll want to be sure and assign it the correct roles for each group — specifically, to give it the ability to send notices and join chat for each group.
For tracking purposes, it is helpful for you, and anyone else controlling the bot, to become friends with the bot. Then, on the bot’s side, check the box to allow you to map its position.
Second Life also asks you to identify this account as a scripted agent. To do this, log your bot account into the http://Secondlife.com website, click on the “Account” link on the left-hand navigation bar, then click on “Scripted Agent Status”. On the right, click the “Change” link and select “Scripted Agent.” IMPORTANT: Second Life imposes limits on notices for scripted agents, so if you plan on sending large volumes of notices, do NOT do this step.
2. Choose a group to use for controlling the bot
As a security measure, all Corrade commands require you to specify a valid Second Life group along with a password you have assigned to that group. This ensures that untrusted scripts or avatars cannot send commands to Corrade unless they know the password you’ve assigned. This password is ONLY used for Corrade commands and nothing else.
BEFORE setting up Corrade, you must pick ONE of your groups (if possible, one in which the bot is an officer or owner, otherwise whichever group you use most), then come up with a random password to use with it. The password you choose should be 8 characters or less and can be any combination of letters and numbers.
Also, you will need to look up the group’s key, because you will need to use it later when setting up the Kool-Tech Group Notice and IM Scheduler. Keys (also called UUIDs) are always in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX. Third-party viewers such as Firestorm or Singularity will display the group’s key at the top of the group information (profile) screen. If you are using the Second Life viewer and don’t have an easy way to look up group keys, I’ve provided an object called “Group Key Finder” which you can rez, set it to the group you want to check the key for, then click to get the key.
3. Download and Set Up Corrade
The latest version of Corrade for Windows can be downloaded by going to: https://corrade.grimore.org/download/corrade/win-x64/.
(If you are using Linux or Mac, or are on a 32-bit version of Windows, go to https://corrade.grimore.org/download/corrade/ and navigate through the proper path for you.)
Scroll down to the bottom of the page and click on the last zip file, which will be the most recent version. (Should be called LATEST.ZIP)
Unzip the file to a folder named Corrade. If possible, put the folder on a drive other than your system drive (for Windows, something besides C:).
Go inside the folder and run the application named corrade. (There are a couple of files with the name “corrade”, but the application will be the smallest one.)
When you run it, you will see a command window with scrolling messages. Just minimize this window for now.
Open up a web browser, and go to this address: http://127.0.0.1:54377
This will bring up the Corrade Nucleus signon page. NOTE: This is a LOCAL webpage, served by the Corrade application running on your PC.
In the codeword field, type nucleus and press Enter to sign in.
On the next web page, click on the word Configure.
On the next web page, type in the codeword nucleus once again, and you will then receive a pop-up message saying “Welcome to Corrade! Please use the configurator to configure Corrade for the first time.” Close the pop-up by clicking the Close button.
Enter the name of the bot. In the Firstname field, put in the username you used when you created the bot. In the Lastname field, put either Resident or the actual last name (if you’re using a legacy account or a recent account that you’ve paid to have a last name assigned). Then, enter the SL password for the bot.
Click the Groups tab (at the top left, next to Login).
Enter the name of the group you chose in step 2 above, along with the password you gave it.
Go down to “Permissions”, and you will see several columns of checkboxes to the right of it. Check the following boxes: interact, inventory, notifications, directory, grooming, land, system, group, movement, talk. (Make sure you’re NOT looking at the boxes across from Notifications)
Now go down to “Notifications”, and look at the checkboxes to the right of it. Check the following boxes: group, local, alert, notice, dialog, inventory, objectim, sit, control, invite, message, permission, teleport. (Not all of these are used by the message schedule. Some are used by the restart evader, and others may be useful for future apps.)
Click the Add button at the bottom to complete group setup.
Close the Corrade application that is running.
This should be all you need to set up Corrade for use with the Group Notice & IM Scheduler.
NOTE: Some antivirus software may give warnings about some of the Corrade files. If you used the grimore.org link provided above to download the files, then these are false positives. If this happens to you, simply add the Corrade folder as an exception for your antivirus software.
4. INSTALL CORRADE AS A SERVICE ON WINDOWS (recommended):
This step is optional, but is highly recommended. It will automatically keep Corrade running as long as your PC is running.
If you DON’T do this step, then you’ll have to manually run corrade.exe anytime you want your bot to be active.
- Go to the Corrade\contrib\windows folder.
- Edit the file install-corrade-service.bat
- Under the “Configuration” header, find the line that reads:
set “_serviceName=Corrade Resident”
- Change “Corrade Resident” to the name of your bot
- Save the file install-corrade-service.bat
Run the batch file install-corrade-service.bat to install the service.
IF YOU ARE ON LINUX OR MAC: You will find a similar folder under Corrade\contrib for your OS. Follow the instructions given there to setup Corrade to run in the background on your system.
5. Test Corrade Setup in Second Life
Go to Second Life, and make sure that your bot is logged in. If you followed step 4 above, then it should already be running in the background. If you did not install Corrade as a background service, then you’ll need to start the Corrade application manually from within the Corrade folder.
- Find the object “Corrade – Tester”, and rez it onto your land, or anywhere that you are able to rez and where scripts are enabled for you.
- From the folder “1. Kool-Tech Corrade Setup pack“, open the notecard “! Config“.
- Between the quotes to the right of “corrade =“, copy and paste the avatar key (UUID) of your bot.
- Between the quotes to the right of “group =“, copy and paste the group key (UUID) of the group you have chosen to use for issuing commands (from step 2 above).
- Between the quotes to the right of “password =“, copy and paste the password you came up with for the above group.
- Between the quotes to the right of “home =“, enter the NAME of the Second Life region that will be the MAIN region where you will be holding events. This will be useful when you are setting up group IM’s, as you will see later.
- To the right of “xgrp =“, enter either a Y or N, depending on whether you need the ability to send cross-group notices. Cross-group notices will have the phrase “(x-grp)” added to the front of the subject line when needed, but this counts against the 63-character limit. If you choose N, then you will be able to use the entire 63 characters for your message.
- Save the notecard.
IMPORTANT: make sure that you press the Enter key at the end of each notecard line!
If you entered the bot’s key correctly in the notecard, then within a few seconds you will receive a message saying “Click the object to test“. If not, correct the notecard. And again, make sure that your bot is online.
Click the object and wait. If your group key and password matches the Corrade configuration, then you’ll get the message “SUCCESS!!” and you’ll know that your setup is correct. Otherwise, you’ll get an “ERROR IN CONFIGURATION” message, and you will need to double-check the information in the notecard against what you entered for the Corrade configuration back in step 3.
Once you get a SUCCESS message, be sure to copy the “! config” notecard to a safe place in your inventory, so that you can use it with the scheduling tool. Then, move on to the next step.
6. Create an inventory drop whitelist
Notice attachments (either landmarks, notecards, objects or textures) must be in the bot’s Second Life inventory before they can be used in a group notice. While you can always preload the bot with the ones you will typically need, there will certainly be times when you will need to add one on the fly (for example, a new venue location).
The easiest way to do this is for you to simply drag and drop an inventory item from your inventory to the bot. However, you don’t want random people to be able to give inventory items to your bot.
To give you control over who is able to send items to your bot, simply rez the a object called “Corrade Whitelist-Accept Inventory Offers“, then drop in the”! config” notecard you created in step 5. After a few seconds, it should tell you that it is waiting for inventory.
Initially, you will be the only one who can send items to the bot. If you want others to be able to do this, add their Second Life names (NOT display names) to the description field of the whitelist object, with commas separating the names. Then click the object and choose RESET.
7. Managing your Corrade Installation
After setting up Corrade and making sure it is working (step 6), it’s very important to make a copy of the entire folder so you can restore it in case of emergency. Ideally, put the copy onto a different drive, whether internal or external (e.g. a USB).
It is also helpful stay in touch with other Corrade users, and with the Corrade staff, to help address problems that may come up. Here are some links to help you with this:
- Corrade Bot Supporters: Corrade Bot Supporters Group in SL
- Submitting bug reports: https://bugs.grimore.org
- Downloading newer versions: https://corrade.grimore.org/download/corrade/
If you want or need to update to a newer version of Corrade, all you need to do is backup your Corrade folder, then simply download the zip file and unzip it into your current Corrade folder, letting it replace any files with the same name. Your configuration will not be affected by this.
If you are interested in reading more about Corrade and other ways you can use it, go to: https://grimore.org/secondlife/scripted_agents/corrade. A list of available commands are at: https://grimore.org/secondlife/scripted_agents/corrade/api. None of this is needed to run the scheduler, it is only there if you are interested in learning how you might use Corrade for other purposes.
8. Set Up the Scheduling Tool in Second Life:
Now that you have Corrade up and running, go to the document Setup for Automated Group Notice and IM Scheduler to continue the setup process.