* TUTORIAL * ROK Dedicated Server Setup & Configuration

This is a detailed easy to follow step by step guide on how to set up and configure your reign of kings dedicated server

Introduction & Requirements

*******************************************************************************************************

INTRODUCTION

*******************************************************************************************************

This is an unofficial guide on how to set up a dedicated server brought to you by the zeus-community.net
This tutorial is based on my findings when setting up a Win Server 2012 installation on a dedicated server situated at a datacentre
This tutorial is based on a minimal experience level, so please excuse some of the obvious instructions

If tyour also interested on playing on an organised mature server, then please search the server lobby for "ZEUS". Most likely it will be passworded, white list coming soon. You can gain access by coming onto teamspeak and requesting it

I will only give the details once I have heard you speak whioch will help me verify your maturity and also may ask you a simple question from our rulebook.
This is purely a step to allow us to filter out players who we feel are unsuitable for type of gameplay we wish to pursue
!!!!!! No microphone, no access sorry !!!!!!!!!

ROK SERVER: ZEUS RP Admins No KOS 24/7
Search "Zeus"
TEAMSPEAK: teamspeak.zeus-community.net
RULES: http://steamcommunity.com/sharedfiles/filedetails/?id=411977948

Updated to include Alpha 6 Release

*******************************************************************************************************

Contents

*******************************************************************************************************

1. What you need
   
2. How to install
   
3. Port Forwarding
   
4. Location of files
   
5. How to configure
   
6. Running 2 or more servers
   
7. Useful Links
   
8. Commands & Permissions Listings
   
9. Useful Tools
   
10. Trouble Shooting & Help
    
11. ​Known Issues

*******************************************************************************************************

What you need

*******************************************************************************************************


1 x installed copy of Reign of Kings on your client (Your playing copy)
1 x FTP client
1 x Quad core server with a 64bit windows o/s
2+ GB for the installation folder (Which includes the configuration files)
>100MB for the ingame save folder (Doesnt use much at all)

NB>> You do not need steam running on your server.
As yet there is no ROKserver.exe and therefore no steamcmd params
ROK is based of the Unity engine
Cheat engine can be run by the clients so you'll have to figure out your own methods on how to administer against its useage. I'm sure the ROK devs will code some form of protection in

*******************************************************************************************************

How to Install

*******************************************************************************************************

1) Zip up and upload your full client install found in your \Steam\SteamApps\common\ directory
2) Upload to your dedicated server and unpack into your desired installation directory
3) Create a desktop shortcut by right clicking on the ROK.exe file and select Send to - Desktop - Create shortcut
4) Select the Desktop shortcut - properties and edit the target line by adding the following command line arguments
-batchmode -nographics -silent-crashes
from something like the following

"D:\Games\Reign Of Kings\ROK.exe"

to

"D:\Games\Reign Of Kings\ROK.exe" -batchmode -nographics -silent-crashes

5) Now you can launch the server (Double click on the desktop shortcut) which will automatically create your configuration files
6) Check the server has loaded and is running by either selecting

• Task manager (Right Click on the blue taskbar at the bottom for the menu)
  
• Resource Monitor

You are looking for a process called ROK.exe using something like 1,680KB or more ram (At time of writing this post)
8) Once you have confirmed the process is running, then end the process

Congratulations You have successfully installed the dedicated server and proved it is running
Now we need to open the inbound ports and configure it

*******************************************************************************************************

Port Forwarding

*******************************************************************************************************

Add an incoming rule to your firewall to allow UDP port 7530

If your working on a home server, then you will need to consult
http://portforward.com/
for instructions on how to configure your router for port forwarding

*******************************************************************************************************

Configuration

*******************************************************************************************************

How to Configure

1) At this point you are only interested in one file, the
ServerSettings.cfg (See Example files section below)
You will need to set

• A password (At least until you are finished preparing the server)
  
• A serverName
  The length of string that can be used for the serverName is limited to something like 55 characters and includes any HTML hex codes
  
  2) Restart your ROK.exe
  3) Wait a minute then in the Server browser select "Search" and enter your serverName into the search field
  4) If your server hasnt shown up, then select "Refresh" (Reselecting search won't do anything)
  5) After a couple of refreshes, if your server still isnt listed, you have more than likely made a syntax error in your serversettings.cfg (It is not very robust)
  4) When you find your server listing "SINGLE CLICK" on it (Hover the mouse around the area that states "Connect", the password entry box is difficult to see due to the background colours used)
  5) Once you have found the entry box add your password then connect
  6) Create your character
  move away from the spawn point, then log out
  7) Shut down the server via task manager in the backend
  8) Open up your permissions.cfg and edit it so it looks something like the "Edited" version of the permissions.cfg listed in the Example files section below
  
  
  The Edited example file will set you up with 2 new user groups as well as the Default & Admin groups
  
  • SuperAdmin (Full Permissions)
    
  • Admin (Full permissions (Can be edited later)
    
  • TrustedMember (Kick permission)
  Add the names of the players you want as in the example file. You will find the actual names of the players, with their correct syntax for easier copying and pasting in the "Users.cfg"
  
  NB>> IMPORTANT
  Other tutorials show the PlayersName encapsulated with '', eg 'Terox'. I found this breaks the config and prevents the server from loading
  
  *******************************************************************************************************

Running 2 or more servers

******************************************************************************************************************
It is possible to run more than one server on the same box.

To do this you need to

1. Have multiple installations of Reign of Kings (Copies of your initial install but in different directories)
   
2. Each instance must have a different port configured in the serversettings.cfg
   (Make sure your firewall rules reflect this)
   
3. Each instrance must run a different world slot, eg slot 0, slot 9, slot 33 etc

(I actually run 2 servers on different boxes, a dev server for custom world event development and a production server, so I haven't actually tested this on 1 box, this is based on information given to me)

If this information is not accurate, could you please let me know in the comments box below


Standin was unable to get 2 servers running on 1 box, has anyone got asolution ?

*******************************************************************************************************************

Location of Files

*******************************************************************************************************

Client

Installation folder: *:\Steam\SteamApps\common\Reign Of Kings\

Server

• Config folder
  wherever you installed your ROK server

• Save Folder
  (If running under administrator account)
  c:\Users\Administrator\AppData\LocalLow\CodeHatch\Reign Of Kings\
  
  If running ROK.exe as a service (Under user system)
  c:\Windows\System32\config\systemprofile\AppData\LocalLow\CodeHatch\Reign Of Kings\

Example Directory Listings

SAVE folder

• Heatmaps\
  
• Slot0\

Configuration Folder

• Permissions.cfg.BAK
  
• DeathMessages.cfg
  
• Permissions.cfg
  
• ServerSettings.cfg
  
• Users.cfg

*******************************************************************************************************

Backing up server files

*******************************************************************************************************

--------------------

Introduction

--------------------

It should be very obvious why you need to back up your server files regularly

• The game is unstable and the server crashes regularly every few hours or so
  
• Kids take great pleasure in their destructive nature using cheat engine
  
• Your members hate losing hours of work when issues arise

--------------------

Folders that need to be backed up

--------------------

• Your saved folder
  
• Your config folder

The locations of these folders are stated in the File location section of this guide
To this end I have written a simple batch file that you can run on your server to simplify this for you

--------------------

Backing up your server files

--------------------

Instructions

1. Create a copy of this in notepad
   
2. Edit it so that the
   
   • _log=
     
   • _ERRORlog=
     
   • BackupPath=
     
   • SavedFolder=
     
   • ConfigFolder=
3. Save it as ROKServer_Backup.cmd
   
4. Create a desktop shortcut for it

Either run it manually (Double click on it) as and when you need too or automate it.
I use Firedeamon for automation and call the batch code within a service
I personally have 3 backup plans using 3 instances of this batch command saving to 3 different folders

• once per hour
  
• once every 4 hours
  
• once per day

There is no perceived performance loss during save which takes maybe 20 to 30 seconds at the most so there would be no issue in saving at a higher rate every 30 mins etc if you feel the need for that

This batch file will fully backup a live server without killing any processes
I have included the config folder as part of the backed up files due to the hack that rewrites it
The session.lock file isnt required and is ignored by the batch code so it wont hang. This is a temporary file used by the process and you cant actually grab a copy of it even using Hobocopy


ROKServer_Backup.cmd

echo off
SETLOCAL ENABLEDELAYEDEXPANSION
 
set _log="d:\ROK\Logs\Backup.log"
set _ERRORlog="d:\ROK\Logs\Error.log"
SET BackupPath=d:\ROK\Backup\Hourly\
SET SavedFolder="C:\Windows\System32\config\systemprofile\AppData\LocalLow\CodeHatch\Reign Of Kings"
SET ConfigFolder="d:\ROK\Reign Of Kings\Configuration"
 
 
echo.>>%_log%
echo.>>%_log%
echo.=================== >>%_log%
echo HOURLY BACKUP >>%_log%
echo.%Date% -- %Time% >>%_log%
echo 1) STARTED - Backing up ROK >>%_log%
echo 1) STARTED - Backing up ROK
 
:: Copy the Saved file folder to the backup folders
echo           a) Copying the saved folder to backup >>%_log%
echo           a) Copying the saved folder to backup
robocopy %SavedFolder% %BackupPath%Save\ /MIR /xf *.lock
echo           a) Completed >>%_log% 
 
:: Copy the config folder
 
echo           b) Copying the ConfigFolder to backup >>%_log%
echo           b) Copying the Config Folder to backup
robocopy %ConfigFolder% %BackupPath%Config\ /MIR
echo           b) Completed >>%_log% 
 
 
:: THE FOLLOWING SECTION IS NOT REQUIRED AND COMMENTED OUT
:: ________________________________________________________
:: now we copy the 1 file that is locked by the rok.exe process
::
:: echo           b) Copying the session.lock file to backup >>%_log%
:: echo           b) Copying the session.lock file to backup
::pause
::
:: %_hobocopy% %SAVEDFOLDER%  %BackupPath% session.lock
::
:: echo           b) Completed >>%_log%
::________________________________________________________
 

 
IF %ERRORLEVEL% GTR 1 (
echo.>>%_log%
echo.>>%_log%
echo.=================== >>%_log%
echo.%Date% -- %Time% >>%_log%
         echo %ERROR% >>%_ERRORlog%
         echo ERROR
pause
)
 
echo 1) ENDED - Backing up ROK >>%_log%

*******************************************************************************************************

Command & Permissions List (PART 1)

*******************************************************************************************************

ALL COMMANDS Up to and Including ALPHA 10

(PART 1)

These commands are executed by typing // COMMAND into your chat boxes
The result before pressing enter then reverts to a single forward slash
Example

/Shutdown

Access to the commands are defined by the permissions class for each Group class

COMMAND	OPTIONS	PERMISSION	COMMENTS
/ban username	(days), (reason)	codehatch.admin.ban	Bans a player with options for a number of days and with a reason
/banlist	(username)	codehatch.admin.ban	lists all users that have been banned or alternatively search the userlist for (username)
/bettergui	none	rok.ui.switchlayout	No effect, last tested on Alpha 10
/build (sphere or cube) (radius) (material ID)	none	codehatch.blocks.build	Example /build cube 4 0 will delete any blocks within a 4 block cube infront of you
/buildreport (userName)		unknown	dumps a text file to the server
/butcher radius	(“silent”)	rok.objects.butcher
/clearInv	(userName)	rok.items.clear rok.items.clear.others	clears the inventory of all items
/config		codehatch.admin.server.edit	Modifies the server config or displays the entire config
/config get (key)
/config set (key) (value)
/fly	(userName)	rok.admin.fly	@Alpha 10, doesnt work when giving it to others, use instead /permission user USERNAME add rok.admin.fly
/give (amoun) (item)	(userName)		Gives (quantity) of (ItemID) to (Username)
/giveall		rok.tems.giveall
/godmode	(username)	rok.admin.godmode	Disabled in Alpha 8,9 & 10
/guild (message)		rok.chat.guild	sends a message to your Guild Example: /guild Hi everyone!
/heal	(userName)	rok.health.heal rok.health.heal.others	heals user/username to full health
/help	(command)		lists info on all commands or just the command specified
/hydrate	(username)	rok.health.hydrate rok.health.hydrate.others	Quenches thirst
/instantbuild		codehatch.blocks.debug	disables the build block animation
/itemlist	(search string)	rok.items.give	Lists all items that can be used with /give [search string] can be used to filter the list
/kick (username)		codehatch.admin.kick
/killall (radius)	(“silent”)	rok.objects.butcher	kills all monsters, critters within the radius
/killbyblueprint (type) (radius)	(“silent”)
/killbytype (type) (radius)	(“silent”)
/list		rok.help.list	Outputs a list of all online players in to the chatbox
/logout			disconnects from the server, if this is the serverhost, shuts the server down. In Alpha 10, seems to log you out to some xtent, but then you lose user inputbut doesnt fully
/me	(message string)	rok.chat.me	Example: /me This is a test!
/nosecurity		rok.objects.security	Toggles security On or Off(Door locks, chests etc)
/notice	(message string)	codehatch.server.notice	displays a message in chat from the server
/nourish	(username)	rok.health.nourish rok.health.nourish.others	Satisfies hunger
/objectDebug		rok.admin.debug	Toggles object debugging on and off
/pageDebug		rok.admin.debug	Toggles paging debug mode
/permissions reload
/permissions users
/permissions user (username) (add or remove)
/permissions user (username) nameformat (format)			Edits the name format by writing directly to the permissions.cfg.
/permissions user (username) removegroup (groupname)			Removes the player from their defined Usergroup as stated in the permissions.cfg by writing directly to that cfg
/permissions user (username) addgroup (groupname)			Adds the player to a defined group in the permissions.cfg by writing directly to that cfg and has immediate effect
/permissions user (username) chatformat (format)
/permissions user (username) setprimary (groupname)			Disabled in Alpha's 8,9,10
/permissions group (groupname) add (permission)
/permissions group (groupname) remove (permission)
/popup (message string)		rok.ui.question	Shows a popup message to all players
/question (message string)			Supposed to shows a popup question to all players with a yes or no option to answer. Not every player sees it (Alpha 10)

Command & Permissions List (PART 2)

COMMAND	OPTIONS	PERMISSION	COMMENTS
/registry list			lists players from userlist.cfg
/registry remove (Username)			removes a player from userlist.cfg
/registry clear			clears userlist.cfg
/registry reload
/registry rename (Username) (newname)
/report (username)			Dumps a report to the server
/say (username) (message string)		rok.chat.say	Forces a (userName) to say a (message)
/serverFPS			Toggles server fps being displayed in chat(For all players)
/shownametags			Makes everyones nametag permanently visible. (Local effect on the client running the command)
/shutdown		codehatch.admin.shutdown	Saves then stops the server
/stophunger	(username)	rok.health.stop.hunger rok.health.stop.hunger.others	Disabled in Alpha's 8,9,10. Stops hunger occuring
/stopthirst	(username)	rok.health.stop.thirst rok.health.stop.thirst.others	Disabled in Alpha's 8,9,10. Stops dehydration occuring
/suicide		rok.health.suicide	allows players to kill themselves
/time (pause or unpause)		rok.environment.time	Stops or starts time advancing
/time (forward or reverse)	(timespeed) 1,2,0.5 etc	rok.environment.time	Rolls time forwards or backwards
/time reset		rok.environment.time	reverts to default time setting
/time set (noon, night, dawn, dusk, (hour))		rok.environment.time
/tp	(x,y coords) (username)	rok.teleport, rok.teleport.coord, rok.teleport.user, rok.teleport.origin	Example: /tp -160 -475
/tp -			teleports to somewhere in the hayfields
/tp (Username)
/tp (Username) (x,y coords)
/tp (Username) (to Username)
/unban	(username / index)	codehatch.admin.ban	unbans the desired player either by username or by ID referenced with /banlist
/videofly		rok.admin.videofly	This works but is partially broken, in that it requires a game restart to break out of the camera effect
/weather pause		rok.environment.weather
/weather reset		rok.environment.weather
/weather overcast	(clear, low, medium, heavy, cloudy)	rok.environment.weather
/whitelist		-codehatch.admin.whitelist
/whitelist enable
/whitelist disable
/whitelist getbyname (username)
/whitelist get (ID number)
/whitelist addbyname (Username)	(add a note)
/whitelist removebyname (Username)	(add a note)
/whitelist remove (ID number)

*******************************************************************************************************

Useful Tools

*******************************************************************************************************

Firedeamon

This tool is my tool of choice for giving users remote access to start and stop services, run batch files etc without giving backend access to the server. It is not free, but there is a fairly decent discount available for non profit making organisations providing you agree to run a banner on your website.

It has an auto restart option, scheduling and much more.
For those of you that are familiar with this tool, I am currently using it to auto restart the server when the admin runs the /shutdown
This does not seem to be causing any save issues

I am using the following settings

• Program - Parameters: -batchmode -nographics -silent-crashes
  
• Program - StartupMode: Automatic

I do intend running some form of scheduled shutdown once a day for backing up the save files, which will include a call on a batch file, which when written, I will post here unless someone wants to do that for me



-------------------------------------------------------------------------------------------------------------------
AFAIK There are no custom launcher apps available yet
Any other useful Admin tools please let me know so I can list them here

*******************************************************************************************************

Example files

*******************************************************************************************************

Contents

*******************************************************************************************************

Based on Alpha 6 release

• DeathMessages.cfg
  
• Permissions.cfg
  
• ServerSettings.cfg
  
• Users.cfg

----------------------------------------------------------------------

ServerSettings.cfg

----------------------------------------------------------------------

----DEFAULT----

# -- Server --
isPrivate = 'False' # Hides from the lobby if true.
serverName = 'Reign Of Kings'
maxPlayers = '32'
portNumber = '7350'
password = ''
restartTime = '0' # 0 seconds to disable.
# -- World --
worldSlot = '1' # -1 creates a new world.
allowSaving = 'True'
# -- Game --
gameMode = 'Survival' # Survival, Creative

----EDITED----

# -- Server -- (Example of how to comment a line out) 
isPrivate = 'False' # True Hides from the Server selection lobby.
serverName = '[FF00FF] MY ROK SERVER ' # (Note colour tag missing the '#')
maxPlayers = '30'
portNumber = '7350'
password = 'MYPASSWORD' # Leave as '' if no password
restartTime = '0' # 0 seconds to disable. 
worldSlot = '0' # -1 creates a new world.
allowSaving = 'True'
gameMode = 'Survival' # Survival, Creative

----------------------------------------------------------------------

Permissions.cfg

----------------------------------------------------------------------

----DEFAULT----

guest { # Unregistered users will use these permissions.
nameFormat = '%name%'
chatFormat = '%name% : %message%'
guildFormat = '[00CC00][%guild%] %chatFormat%[-]'
}
groups {
default {
default = 'True'
permissions {
- 'rok.chat.me'
- 'rok.chat.guild'
- 'rok.health.suicide'
- 'rok.help.list'
}
}
admin {
permissions {
- '*'
}
}
}
users {
}

----- EDITED -----

guest { # Unregistered users will use these permissions.
nameFormat = '%name%'
chatFormat = '%name% : %message%'
guildFormat = '[00CC00][%guild%] %chatFormat%[-]'
}
groups {
default {
default = 'True'
permissions {
- 'rok.chat.me'
- 'rok.chat.guild'
- 'rok.help.list'
}
}
superadmin {
nameFormat = '* ADMIN * %name%'
permissions {
- '*'
}
}
admin {
nameFormat = '* ADMIN * %name%'
permissions {
- '*'
}
}
trusted {
nameFormat = '%name%'
permissions {
- 'rok.chat.me'
- 'rok.chat.guild'
- 'rok.help.list'
- 'codehatch.admin.kick'
}
}
}
users {
Terox { 
groups {
- 'superadmin'
}
}
PLayersName1 { 
groups {
- 'admin'
}
}
PLayersName2 {
groups {
- 'admin'
}
}
PlayerName3 {
groups {
- 'trusted'
}
}
}

*******************************************************************************************************

Troubleshooting

*******************************************************************************************************

In General

Typically the only known issue I have been suffered when setting up the server was configuration issues.
The config files are a swine, slightest syntax error and the server will not load fully. So I would suggest spending the time with a passworded server getting them right before you open your doors to the general public. I found it very time consuming

Known Issues

1. Using Hex colour coding for chat messages configuration for any custom user groups seems to break the config

*******************************************************************************************************

Changelog

*******************************************************************************************************

V1

Created 21/3/2015

*******************************************************************************************************

V2

Created 25/3/2015

Added "Backing up server files" section

*******************************************************************************************************

V3

Created 30/3/2015

Updates to reflect changes implemented for the Alpha 8 build
Updated: Server admin commands to reflect whitelist additions implemented on the Alpha 8 build
Added: "Running 2 or more servers" section

*******************************************************************************************************

V4

Created 10/4/2015

• Removed Permissions section
  
• Removed commands section
  
• Reworked Permissions and commands, moving both into the same section and formatted as a table

*******************************************************************************************************

[Wet Fart]

@Terox I can take over ur guide

[DryreL | Artwork Designer]

@Terox, admin is don't work, please help

[livezzaj]

where is the right place?
im trying to figure this out

[Terox]

Why dont you read the comments, you would then realise this community hasnt been active FOR YEARS therefore your at thew wrong place

[livezzaj]

pleasne anserme someon its driveing me crazy

[livezzaj]

is thee admin config still the same ? mine does not work and it looks like this ..
# guest { # Unregistered users will use these permissions.
# nameFormat = \'%name%\'
# chatFormat = \'%name% : %message%\'
# guildFormat = \'[00CC00][%guild%] %chatFormat%[-]\'
# permissions {
# - \'rok.fairplay\'
# }
# }
groups {
default {
default = 'True'
inherits = 'guest'
permissions {
- 'rok.fairplay'
}
nameFormat = '%name%'
chatFormat = '%name% : %message%'
guildFormat = '[21C447][%guild%] %name% : %message%[-]'
localChatFormat = '[Local] %name% : %message%'
whisperSendFormat = '[C4257A]%name% >> %message%[-]'
whisperReceiveFormat = '[D12681]%name% << %message%[-]'
}
admin {
permissions {
- '*'
}
inherits = ''
}
}
users {
Halford {
groups {
- 'admin'
}
}
}
macros {
}

[DryreL | Artwork Designer]

Where is admin setup?

[MoXiSt]

my friends cant join to me

[Terox]

We ran one server on a machine in Scandinavia, I no longer have access to that machine, nor do i have ROK installed, so I cannot check. Maybe the guy who owns the server doesnt realise its running?
It's offline as far as I am concerned and have no intentions of getting involved with ROK server administration again, sorry. My outing in this area was an exercise in how to set up an RP server, evaluating rule sets etc. It was a worthy exercise and I learnt a lot from it, but took up too much time for continued effort.

[The Stranger]

Server appears in the list if you search for it; localhost can join, has a ping from 0.
Any tips?