Table of Contents
About
This is the documentation for all the configuration keys to be found in the progressive release of Corrade.
Complete List of Configuration Keys
| key | value | default | description |
|---|---|---|---|
|
|
A vector. |
none |
An optional point vector to log-in at. |
|
|
A collection of parameters for the built-in Corrade WebSockets server. |
a collection of WebSockets server settings |
The WebSockets server parameters are contained within this key. |
|
|
A collection of parameters for the built-in Corrade TCP server. |
a collection of TCP server settings |
The TCP server parameters are contained within this key. |
|
|
A collection of parameters for the built-in Corrade UDP server. |
a collection of TCP server settings |
The UDP server parameters are contained within this key. |
|
|
A collection of servers that can be used to connect and interact with Corrade externally to the grid. |
a collection of servers |
This is a collection key that holds definitions for servers that are made available by Corrade. |
|
|
A collection of settings for some of the notifications that Corrade supports. |
a collection of notification settings |
Some parameters may be adjusted for some of the supported Corrade notifications. |
|
|
A collection of parameters for the built-in Corrade MQTT server (broker). |
a collection of MQTT server settings |
The MQTT server (broker) parameters are contained within this key. |
|
|
A collection of parameters for the built-in Corrade HTTP server. |
a collection of HTTP server settings |
The HTTP server parameters are contained within this key. |
|
|
A collection of groups managed by Corrade. |
a collection of groups |
This is a collection key that holds definitions for groups that are managed by Corrade. |
|
|
A definition of a group with multiple parameters. |
a collection of group settings |
A managed group's definition is contained as the value of this key. |
|
|
A list. |
a collection of behaviours |
A collection of RLV Behaviours to be ignored by Corrade. |
|
|
A string. |
|
The path to a certificate. |
|
|
Either WAS or JSON. |
|
The language that Corrade will understand and speak |
|
|
A string. |
|
The path to a certificate. |
|
|
A string. |
|
The certificate protocol to use. |
|
|
A string. |
|
The certificate protocol to use. |
|
|
A string. |
|
The path to a certificate. |
|
|
A string. |
|
A RLV behavior to be ignored by Corrade. |
|
|
A string. |
|
The case-sensitive last name of the account to be used to connect to the grid. |
|
|
A SHA1 hashed password string. |
|
In order to execute commands, the group needs a password to be set. This password can be the SHA1 hash of any alphanumeric string. It does not, and should not, be the password of the account on which Corrade logs on. |
|
|
A string. |
|
The name of the group. |
|
|
A string. |
|
The path to a certificate. |
|
|
A start location. |
|
A start location definition. |
|
|
A string. |
|
A region name. |
|
|
A string. |
|
An ISO 639-1 two-letter or ISO 639-3 language code used to advertise to in-world objects. |
|
|
A string. |
|
The case-sensitive first name of the account to be used to connect to the grid. |
|
|
A string. |
|
The password for the certificate, if any. |
|
|
A string. |
|
The password for the certificate, if any. |
|
|
A string. |
|
The password for the certificate, if any. |
|
|
A collection of permissions enabled for the managed group. |
|
This key holds a collection of permissions for the managed group. |
|
|
A string. |
|
An URL to listen on. |
|
|
A string. |
|
The login URL for the grid - by default, this is set to the Agni Second Life grid URL. |
|
|
An URL listening prefix. |
|
The URL prefix to start the server on. |
|
|
A collection of notifications enabled for the managed group. |
|
This key holds a collection of notifications for the managed group. |
|
|
An integer. |
|
The port to listen on. |
|
|
An integer. |
|
The port to listen on. |
|
|
An integer. |
|
The port to listen on. |
|
|
An integer. |
|
The port to listen on. |
|
|
An integer. |
|
The range in meters describing a sphere in which Corrade is able to sense assets such as objects, avatars, etc… This is effectively Corrade's "draw-distance" and has an impact on many commands that manipulate in-world assets. With a large enough |
|
|
An integer. |
|
A number of milliseconds to wait between polling resources. |
|
|
An integer. |
|
A number of milliseconds to wait between polling resources. |
|
|
An integer. |
|
A number of milliseconds to wait between polling resources. |
|
|
An integer. |
|
A number of milliseconds to wait between polling resources. |
|
|
An integer. |
|
A number of milliseconds to wait between polling resources. |
|
|
An integer. |
|
A number of milliseconds to wait between polling resources. |
|
|
|
|
Whether to automatically connect and maintain a connection to the grid. |
|
|
An integer. |
|
Whether to center the camera after a teleport or movement. |
|
|
|
|
Whether to cache group members by polling in-world services. This feature is necessary for the membership notification or else Corrade can't tell which member left or what member joined. However, the feature incurs a performance penalty because there is no official API to do this. |
|
|
An integer. |
|
Whether to log instant messages. |
|
|
|
|
Whether to publish the set language to objects. |
|
|
An IP address to listen on. |
|
The IP address for the MQTT server to listen on. |
|
|
An IP address to listen on. |
|
The IP address for the MQTT server to listen on. |
|
|
An IP address to listen on. |
|
The IP address for the UDP server to listen on. |
|
|
An IP address to listen on. |
|
The IP address for the UDP server to listen on. |
|
|
An integer. |
|
Whether to connect to surrounding simulators. This feature is required for region crossings but region crossings do not work reliably. Nevertheless, this feature allows scanning and seeing into neighboring regions at the cost of some resources. |
|
|
|
|
Whether to enable RLV or not. |
|
|
|
|
Whether to enable the HTTP server or not. |
|
|
|
|
Whether to compress the data or not during transmission. |
|
|
|
|
Whether to enable the MQTT server or not. |
|
|
|
|
Whether to compress the data or not during transmission. |
|
|
|
|
Whether to enable the TCP server or not. |
|
|
|
|
Whether to compress the data or not during transmission. |
|
|
|
|
Whether to enable the UDP server or not. |
|
|
|
|
Whether to compress the data or not during transmission. |
|
|
|
|
Whether to enable the WebSockets server or not. |
|
|
A string. |
|
An unsalted MD5 hash of the account's password to be used to connect to the grid. After generating an unsalted MD5 hash of the password, the string |
Index
For the contact, copyright, license, warranty and privacy terms for the usage of this website please see the contact, license, privacy, copyright.