Difference between revisions of "Dedicated Server Setup"

From Empires Wiki
Jump to navigation Jump to search
(Replaced information with A-z-K's tutorial)
Line 2: Line 2:


== Dedicated Server (Windows) ==
== Dedicated Server (Windows) ==
=== Downloading ===
There are two ways of installing an Empires dedicated server:
{{Warning|Empires is now downloadable through steamcmd instead. hldsupdatetool is no longer the correct method.}}
{{See|[http://forums.empiresmod.com/showthread.php?t=17103 Forum thread with the new way to download empires server.]
==== Server Files ====
* First of all you need the [http://steampowered.com/download/hldsupdatetool.exe HLDS Update Tool]. This is what we use to update/download the server.
*You will also need Empires Dedicated Server from the [http://www.empiresmod.com/drupal/node/14 Download Page].


=== Installing ===
*Using [https://developer.valvesoftware.com/wiki/SteamCMD SteamCMD].
* First we need to download the SDS (Source Dedicated Server). To download we open up '''hldsupdatetool.exe''' and download the tool to an arbitrary location on your machine, for example:
C:\HL2DS
* When you have finished installing the update tool open the install folder in a command prompt and type:
hldsupdatetool.exe -command update -game "orangebox" -dir C:\HL2DS 


* If that doesn't work, are stuck or are having trouble getting orangebox, then you can go [http://www.srcds.com/db/engine.php?subaction=showfull&id=1097362093&archive= HERE] for a more in-depth tutorial on how to install it.
*Using [http://didrole.com/UpdateTool/ Didrol's update tool]. For the rest of this setup tutorial, we will assume we use this tool.


{{Tip|Make sure you replace C:\HL2DS with your install path if it's different.}}
{{Note|If updating multiple instances, you will need to apply this for each one. That means running the tool against more than one directory: "C:\****\Empires Main Server"; "C:\****\Empires Test Server"; or wherever your instances are. Open notepad andcopy and paste so there are no typo's.}}


This will download all files necessary to host an orange box server (and Empires). And remember to "Go get yourself a cup of coffee." as Valve said; this will take some time!
=== Download Tool ===


* Install the Empires Dedicated Server files to "C:\HL2DS\orangebox\empires" (use your own install path).
You can download the tool [http://didrole.com/UpdateTool/UpdateTool-0.3.rar here].


{{Warning|If you are planning on adding server extensions to your game server, the Empires folder '''has to be lowercase'''. That is, "C:\HL2DS\orangebox\Empires" is '''incorrect''', "C:\HL2DS\orangebox\empires" is '''correct'''.}}
*After downloading, extract the RAR.


* Create a shortcut of '''srcds.exe''' and place it where you want. Then go to the properties of the shortcut. Add the following to the end of the shortcut target:
=== Downloading Empires ===
-game empires +maxplayers 14 -port 27015 -console +map emp_canyon -autoupdate
It should look like this:
srcds.exe -game empires +maxplayers 14 -port 27015 -console +map emp_canyon -autoupdate
{{Tip|You can adjust your port and maxplayers via the shortcut or the ''server.cfg'' file.}}


{{Tip|More command-line options are available at the [https://developer.valvesoftware.com/wiki/Command_Line_Options#Source_Dedicated_Server Valve Developer Community Wiki].}}
*Open a command line window and browse to the location of the update tool.
*Update syntax example:
<pre>
updatetool.exe -command update / install -game 17740
-dir "C:\Folder Path to Empires\" -username SteamUsername -password SteamPassword -verify_all
</pre>


=== Configuration ===
*-command update - Tells the tool you are updating an existing server.
Next, edit your mapcycle.txt and server.cfg files to your liking.  
*-command install - Tells the server you are installing a new server.
{{Warning|When editing your server.cfg remember to change your '''rcon_password''' and '''hostname''' directives!}}
*-game 17740 - Tells the server the Steam AppID. In the case of Empires you need to use "17740".
rcon_password "pass"  //Your rcon password
*-dir - This is the installation path to the Empires Server files. It is probably worth noting that for the author of this tutorial, it was "C:\*****\Empires\orangebox" .
hostname "Servername" //The name of your server
{{Warning|It is very important that you use a full local file path & wrap it with quotation marks to help it parse any spaces. Use an existing path in conjuction with "-command update" or a new path in conjunction with "-command install".}}
*-username SteamUsername - Where Username is the Steam account you will use to connect to Steam and download the files. It is a good idea to have a separate account set up for this.
*-password SteamPassword - Self explanatory.
*-verify_all - This will verify all the files once they have been installed. Highly recommended.


These are the most important settings to change, there are more in the cfg so test around what is best for you.
{{Warning|If you have not verified the Steam account you are using to update / install your server, an e-mail will be sent with a Steam verification code to the registered primary e-mail account. In this case, you will need to run the same command again but include the verification code by adding this switch:}}
 
<pre>
=== Starting ===
-steam_guard_code 5char
You should now be able to double-click your server shortcut, which will start up your dedicated server.
</pre>
Where "5char" is replaced by the verification code Steam will e-mail.


Original author: A-z-K
== Dedicated Server (Linux) ==
== Dedicated Server (Linux) ==
Linux server is unfortunately unsupported. Valve's version of the Source 2007 engine for Linux is too slow to handle any decent amount of players, and becomes unstable very, very quickly.
Linux server is unfortunately unsupported. Valve's version of the Source 2007 engine for Linux is too slow to handle any decent amount of players, and becomes unstable very, very quickly.

Revision as of 17:03, 10 January 2013

Home > Dedicated Server Setup

Dedicated Server (Windows)

There are two ways of installing an Empires dedicated server:

Note Note: If updating multiple instances, you will need to apply this for each one. That means running the tool against more than one directory: "C:\****\Empires Main Server"; "C:\****\Empires Test Server"; or wherever your instances are. Open notepad andcopy and paste so there are no typo's.

Download Tool

You can download the tool here.

  • After downloading, extract the RAR.

Downloading Empires

  • Open a command line window and browse to the location of the update tool.
  • Update syntax example:
updatetool.exe -command update / install -game 17740 
-dir "C:\Folder Path to Empires\" -username SteamUsername -password SteamPassword -verify_all 
  • -command update - Tells the tool you are updating an existing server.
  • -command install - Tells the server you are installing a new server.
  • -game 17740 - Tells the server the Steam AppID. In the case of Empires you need to use "17740".
  • -dir - This is the installation path to the Empires Server files. It is probably worth noting that for the author of this tutorial, it was "C:\*****\Empires\orangebox" .
Warning  Warning: It is very important that you use a full local file path & wrap it with quotation marks to help it parse any spaces. Use an existing path in conjuction with "-command update" or a new path in conjunction with "-command install".
  • -username SteamUsername - Where Username is the Steam account you will use to connect to Steam and download the files. It is a good idea to have a separate account set up for this.
  • -password SteamPassword - Self explanatory.
  • -verify_all - This will verify all the files once they have been installed. Highly recommended.
Warning  Warning: If you have not verified the Steam account you are using to update / install your server, an e-mail will be sent with a Steam verification code to the registered primary e-mail account. In this case, you will need to run the same command again but include the verification code by adding this switch:
-steam_guard_code 5char

Where "5char" is replaced by the verification code Steam will e-mail.

Original author: A-z-K

Dedicated Server (Linux)

Linux server is unfortunately unsupported. Valve's version of the Source 2007 engine for Linux is too slow to handle any decent amount of players, and becomes unstable very, very quickly.

Server Extensions

There are several plugins available for use in Empires. Two extension systems are available (and can run in parallel):

  • SourceMod is the most common system, and is used for the majority of plugins. Handy SourceMod plugins that have been confirmed to work on Empires servers are:
    • Ungrief Command Vehicle - Teleports the specified command vehicle to where you are looking. Usage: !ungrief <nf | be | imp>
    • SourceBans - A free global administration and banning system for Source engine based servers.
    • Kigen's Anti-Cheat (Requires Sockets 3.0.1 plugin) - An extensive anti-cheating plugin.
  • SourceOp is less popular, but is required to run an anti-DoS plugin:

Both systems themselves run on MetaMod, allowing them to run in parallel.

Tips and Tricks

Customize server.cfg settings

As the server.cfg (amongst others) can be overwritten during upgrade and you may wish to have your server run in different "modes" such as password protected clan match/practice, increased resource rates for "tank wars", etc, it is best to treat your server.cfg as "read-only".

Any default settings you wish to use can be placed in a separate file such as "myserver.cfg". At the end of server.cfg, you can then add the line "exec myserver.cfg".

This way, server.cfg will then run myserver.cfg and override any server.cfg settings.

Loading various server "modes" can then be done by calling them in the server console:

rcon exec tankwars.cfg

If you want a mode to be automatically loaded after map change / server restart, you can add another line to server.cfg below the "exec myserver.cfg" entry.

Related Links