Custom Session IDs: Difference between revisions

From Resonite Wiki
No edit summary
No edit summary
Line 17: Line 17:
== Setting a Custom Session Id ==
== Setting a Custom Session Id ==


=== In the Headless Server Software configuration ==
=== In the Headless Server Software configuration ===
Within the [[Headless Server Software/Configuration_File]] <code>autoStartWorlds</code> configuration.
{{Note|Remember to not include S- in this configuration file.|warning}}
Within the [[Headless Server Software/Configuration_File]] <code>startWorlds</code> configuration. For example:
<code>
"startWorlds":[
{
  ... other properties ...
  "customSessionId":"U-ProbablePrime:CheeseLand"
  ... other properties ...
}]
</code>

Revision as of 05:34, 28 September 2024

Custom Session Ids are a custom format for regular Session IDs, that can be easier to remember and work with.

Format

Custom Session Ids, have 3 Components.

S-<User Id or Group Id>:<custom text>

  • The S- this is automatically added when setting a custom session id, but must be supplied when using a custom session id.
  • A user id or group ID
    • E.g. U-ProbablePrime for a User ID
    • E.g. G-Cheese for a Group ID
  • The custom text portion can be anything you'd like, but there are some restrictions.
    • Only Alphanumeric Characters, Dash(-) and Underscore(_) can be used.

Combining everything together a full custom session Id example would be: S-U-ProbablePrime:CheeseLand.

Setting a Custom Session Id

In the Headless Server Software configuration

Remember to not include S- in this configuration file.

Within the Headless Server Software/Configuration_File startWorlds configuration. For example: "startWorlds":[ {

 ... other properties ...
 "customSessionId":"U-ProbablePrime:CheeseLand"
 ... other properties ...

}]