The Settings tab
Your server's settings sit in clear fields, and we write them into R5/ServerDescription.json for you in the right format, so you never need to open the file.
Change what you like, then choose:
- Apply: the values are saved and take effect at the next start.
- Apply and restart: the values are saved and we restart your server right away, so they take effect now.
Every field in this tab needs a restart. Windrose writes to its settings file while it runs, so we change the file only while the server is stopped: if you save while it's running, we keep the change and write it into the file before the next start.
The fields
- Server name: your server's name, which helps tell it apart from servers with similar codes. 64 characters at most.
- Password: optional. If you set one, Windrose asks every player for it when they join. Leave it empty and anyone with the invite code can join.
- Max players: 1 to 10. The Windrose developers recommend groups of up to 4 players, and say 10 or more is technically possible but boss fights aren't balanced for it. Every extra player needs more RAM, and the numbers are in the performance guide.
- Region: the connection service region players use to find your server by its invite code: EU (Europe and North America), SEA, CIS, or automatic. Every player has to pick the same region in the game, and the details are in the connect guide.
- Invite code: type a code of your own in place of the current one, 6 to 32 English letters and digits. Capital and small letters in it are different, and after the restart only the new code works.
Send the new code or the new password to your friends after the restart, because they won't find your server with the old code.
Settings in other tabs
- Direct connection: in the Connect tab. If you save it while the server is running, we restart it right away to open or close its port.
- Regenerate code: also in the Connect tab. It applies at once while the server is stopped, and after a restart while it runs.
- World preset and its multipliers: in the World tab, and they apply at the next start. The details are in the worlds guide.
The file itself
Every setting that matters is in the panel. If you open R5/ServerDescription.json from the Files tab, keep these in mind:
- Don't change
PersistentServerId. It's the ID that ties your server and its invite code to the connection service. - We write
IsPasswordProtected,UseDirectConnection,DirectConnectionServerPort,DirectConnectionProxyAddress,AutoLoadLatestBackupIfHasBrokenandCanLaunchMultipleServerInstancesfrom the panel at every start, so any change you make to them by hand is replaced. - Edit the file only while the server is stopped, because Windrose can write over it while it runs.
Did this guide help you?
Improve this guide
Guides are open source. Found a fix or an addition? Open a pull request on github.com/serverkgg/windrose