Documentation

Support

Vivox Unity SDK

Vivox Unity SDK

Usernames

Understand the naming criteria and format required for Vivox usernames.
Read time 1 minuteLast updated 2 months ago
When you create a username, the following criteria apply:
  • Maximum of 127 bytes
  • Start and end with a period '.'
  • Use only the following characters:

  • Alphanumerics

    0-9, A-Z, a-z

    0x30-0x39, 0x41-0x5A, 0x61-0x7A

    Exclamation mark' ! '0x21
    Open parenthesis' ( '0x28
    Close parenthesis' ) '0x29
    Plus' + '0x2B
    Minus' - '0x2D
    Period' . '0x2E
    Equals' = '0x3D
    Underscore' _ '0x5F
    Tilde' ~ '0x7E
    Percent' % '0x7F
    Note
    You can only use the percent sign for URL encoding. Follow the percent sign by two uppercase hex characters.
The recommended best practice is to URL-encode the username by using only uppercase hex digit characters. Lowercase characters are allowed in the username, but not when used as the hex digit characters. For example, if your issuer name is "crux", then a valid username is 
.crux.0verl0rd
.
Note
For the Vivox Unity SDK and the Vivox Unreal SDK, the naming displayed in this example only applies during access token generation. When you construct an AccountId, you are expected to use only the 
"0verl0rd"
part of the username and not 
".crux.0verl0rd."
for the name argument. The AccountId function 
ToString()
returns a full user URI that is suitable for token generation, which includes the dots, issuer, and other URI components.
If you do not want to use a unique account name per player, or if you do not want to expose the username to the network, then use one of the following options:
  • A hash of the unique username.
  • A universally unique identifier (UUID).
Usernames • Vivox Unity SDK • Unity Docs