Documentation

Support

Vivox Unreal SDK

Vivox Unreal SDK

Usernames

Understand the naming criteria and format required for Vivox usernames.
Read time 1 minuteLast updated 2 days 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
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
.
You 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. 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).