Skip to main content

Need a powerful server for your projects?

Discover our offers

Configuring the server (ServerDescription.json)

The main settings of a Windrose server live in the ServerDescription.json file: server name, password, maximum player count, invite code and the world to load. Gameplay settings (difficulty, multipliers) are stored per world: see World settings and difficulty.

Editing the file safely​

Stop the server before editing

Always stop the server from the panel Console before editing ServerDescription.json. The server rewrites this file on shutdown: any change made while it is running is overwritten as soon as it stops.

  1. Log in to your Game Panel: game.yorkhost.fr
  2. Select your server and stop it
  3. Open the Files tab and edit ServerDescription.json (at the server root or in the R5/ folder, depending on the version)
  4. Only change the values you need, keeping valid JSON syntax
  5. Save, then start the server

Depending on the server version, the settings are either at the top level of the file or grouped inside a ServerDescription_Persistent object. Edit the keys where they are, without moving any block. Simplified example:

{
  "ServerDescription_Persistent": {
    "PersistentServerId": "…",
    "InviteCode": "Crew42abc",
    "IsPasswordProtected": true,
    "Password": "SecretPassword",
    "ServerName": "The Black Flag",
    "WorldIslandId": "…",
    "MaxPlayerCount": 8,
    "UserSelectedRegion": ""
  }
}
Keep a copy and check the syntax

Download a copy of ServerDescription.json before any change. A trailing comma or a missing quote makes the JSON invalid and prevents the server from starting. If in doubt, check the file with an online JSON validator.

Startup tab parameters​

Some values may also be exposed in the panel's Startup tab. If a change to the file seems to be ignored, check whether the same setting is defined there.

Identity and access​

KeyPurpose
ServerNameServer name, to tell it apart from others
IsPasswordProtectedtrue to require a password, false otherwise
PasswordPassword players must enter
MaxPlayerCountMaximum number of players connected at once
InviteCodeInvite code shared with players
UserSelectedRegionMatchmaking region (EU, SEA, CIS); empty = automatic selection

Password​

The password is only applied when IsPasswordProtected is true. Both fields must be consistent:

"IsPasswordProtected": true,
"Password": "SecretPassword",

To remove the password, set IsPasswordProtected back to false and clear Password.

Player count​

MaxPlayerCount accepts a value from 1 to 8: the official dedicated server is currently limited to 8 players, and this limit may change during Early Access. More players means more RAM usage: keep it consistent with your plan (see Choosing a plan).

Invite code​

The code is generated automatically on first startup. You can replace it with a code that is easier to remember:

  • at least 6 characters
  • digits and letters only (0-9, a-z, A-Z), no spaces or special characters
  • case-sensitive: Crew42abc and crew42abc are two different codes

After changing the code, give the new one to your players: the old one no longer works.

Region​

UserSelectedRegion sets the region used to match players with the server. Left empty, it is selected automatically. Since our servers are hosted in France, EU is the sensible value if you want to set it.

Settings you should not change​

Some keys are managed by the server or by YorkHost. Do not change them:

KeyWhy
PersistentServerIdUnique server identifier, generated automatically. Changing it can make your saves inaccessible
WorldIslandIdWorld loaded on startup. Only change it to import or switch worlds
UseDirectConnection, DirectConnectionServerPort, DirectConnectionProxyAddress, P2pProxyAddressServer network settings
CanLaunchMultipleServerInstancesProtection against running several instances on the same data
Leave the network settings alone

The server must use the port assigned by the panel (the game's default port, 7777, is for reference only). Changing the network settings by hand can make the server unreachable. If you need direct IP connection, contact support. See Are all ports open?.

Administration and commands​

At the moment, Windrose has no built-in admin system or server commands: the server console is for reading logs, not for typing game commands. Management is done through the configuration files and the panel:

NeedSolution
Restrict access to the serverPassword (IsPasswordProtected + Password) or a new invite code
Change the difficultyWorld settings
Back up the worldBackups tab, see Backups
Restart regularlySchedules tab, see automatic restart
Give a friend access to the panelPanel sub-users

Community tools add admin commands, but they are not official and may stop working with any Early Access update.

Mods​

We install the official dedicated server, without mods. You still get full file access (file manager and SFTP) if you want to try a server-compatible mod:

  • always take a backup before installing a mod
  • follow the mod author's instructions and make sure it is meant for the dedicated server
  • expect a game update to break compatibility
Do not replace the server files

Do not overwrite the server executables and files with files copied from your game installation. If a mod asks you to replace binaries, contact support first.

See also​