Usernames
Understand the naming criteria and format required for Vivox usernames.
Read time 1 minuteLast updated 7 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:
-
Alphanumerics0-9, A-Z, a-z0x30-0x39, 0x41-0x5A, 0x61-0x7AExclamation mark' ! '0x21Open parenthesis' ( '0x28Close parenthesis' ) '0x29Plus' + '0x2BMinus' - '0x2DPeriod' . '0x2EEquals' = '0x3DUnderscore' _ '0x5FTilde' ~ '0x7EPercent' % '0x7FNoteYou 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.0verl0rdYou should also:
- Create a one-to-one mapping between an Account and a player.
- Use the same Account for the same player every time they play the game.
It’s recommended that you re-use player account names and create one-to-one mapping between and account and a player to facilitate the use of Vivox features such as cross-mute and blocking. It will also become a requirement for using future safety features designed for reducing toxicity and fostering more positive communities.
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 part of the username and not for the name argument. The AccountId function returns a full user URI that is suitable for token generation, which includes the dots, issuer, and other URI components.
"0verl0rd"".crux.0verl0rd."ToString()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).