Documentation

English

Deutsch

English

Deutsch

Appearance

How to Set the Invite Code on Your Windrose Server ​

The invite code is required by players to find your server in-game. You can set it either via the dashboard or via the ServerDescription.json file.

Note

The invite code must be at least 6 characters long and may only contain the characters 0-9, a-z and A-Z. It is case-sensitive. If you do not set a custom code, one will be generated automatically in ServerDescription.json on server startup.

Via the dashboard ​

  1. Open dashboard
    Open the dashboard of your server.

  2. Open settings
    Navigate to the Settings.

  3. Set invite code
    Enter the desired code in the Invite Code field and save the setting.

  4. Restart the server
    Restart your server for the change to take effect.

Via the config file ​

  1. Stop the server
    Stop your server via the dashboard.

  2. Connect via SFTP
    Connect to your server via SFTP.

  3. Open ServerDescription.json
    Open the file ServerDescription.json at:

    /R5/ServerDescription.json
    /R5/ServerDescription.json

  4. Change invite code
    Adjust the invite code value in the file.

  5. Start the server
    Save the file and start your server.

© 2016 - 2026 EmeraldHost