Custom Session IDs

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:

... other properties ...
"startWorlds":[
{
  ... other properties ...
  "customSessionId":"U-ProbablePrime:CheeseLand"
  ... other properties ...
}]

Using a Custom Session Id

You can use a custom session id, anywhere that expects a session Id, examples include:

• ProtoFlux
  • The ProtoFlux:Open World node.
  • The ProtoFlux:Focus World node.
• The Component:WorldLink component
• As a uri for a autoJoinSessions item within the Startup Config File