Dedicated Server Setup: Difference between revisions

From Empires Wiki
Jump to navigation Jump to search
VisualWikitext
m (→‎Dedicated Server - SteamCMD: fix outdated district map name in the start command :D)
 
(82 intermediate revisions by 13 users not shown)
Line 1: Line 1:
{{Sitenav|Dedicated Server Setup}}
{{ServerResources}}


== Dedicated Server (Windows) ==
Dedicated servers are like the listen servers (which can be created by pressing the "create server" button on the main menu), but they don't require a copy of the game to be running. This is less resource intensive as the server doesn't need to spend any time rendering graphics.
=== Downloading ===
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://empiresmod.com/download.php Empires Download Page].


If you want to use [http://www.mani-admin-plugin.com/ Mani Admin Plugin], make sure you download it before going any further.
== Installation ==
There are two supported ways of installing a dedicated server. On Windows and Linux, you can install the server using the SteamCMD utility. On Debian-based distributions of linux, you can also install the server through APT, this will set it up as a service and with tmux.


=== Installing ===
=== Dedicated Server - 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 "hl2mp" -dir C:\HL2DS 


* If that doesnt work or your stuck or having trouble getting hl2mp then you can go [http://www.srcds.com/db/engine.php?subaction=showfull&id=1097362093&archive= HERE] for a more indepth tutorial on how to get it.
The Empires Dedicated Server can be installed using the [https://developer.valvesoftware.com/wiki/SteamCMD SteamCMD] utility. The server has an appid of 460040, and must be downloaded while logged in as an anonymous user.


{{Tip|Make sure you replace C:\HL2DS with your install path if it's different.}}
To install the server on Windows:
*[https://developer.valvesoftware.com/wiki/SteamCMD#Downloading_SteamCMD Install SteamCMD].
*Open a command line window with elevated / local administrator privileges
*Browse to the location where SteamCMD was installed, and enter this command:
<pre>
steamcmd.exe +login anonymous +app_update 460040 validate +quit
</pre>
*This same command can also be used to update Empires Dedicated Server.
 
Once the server has been downloaded, you can launch the server by navigating to the installed location of SRCDS.exe and running the following console command:
<pre>
srcds.exe -game "empires" -console -toconsole -secure +map con_district402 +maxplayers 64
</pre>
 
To allow players to connect to your server from outside your local network, you may need to port-forward the following ports:
* UDP 27005
* TCP and UDP 27015
 
=== Dedicated Server - APT ===
This method will install the server as a service, with tmux. (with tmux you run the server in a separate terminal window, so you can switch between the dedicated server and linux environment) <br>
<br>
Video tutorial: https://www.youtube.com/watch?v=RVvJTphiG24 <br>
<br>
Installing a dedicated server is supported on [https://www.debian.org/CD/netinst/ 32 bit Debian 10]. <br>
If you have a 64 bit install you might need to execute the following as root: <br>
 
dpkg --add-architecture i386
apt update
apt install lib32gcc1
 
Execute the following in a root shell to add the key and repository:
mkdir -p /etc/apt/keyrings/
wget -qO- https://deb1.ws.maxmaton.nl/debian/signing.pub | gpg --dearmor | sudo tee /etc/apt/keyrings/maxmaton.gpg >/dev/null
echo 'deb [signed-by=/etc/apt/keyrings/maxmaton.gpg] http://deb.maxmaton.nl/debian buster main non-free' | sudo tee /etc/apt/sources.list.d/maxmaton.list
 
After that you can continue with:
apt update
apt install empires-server
''When it shows the license agreement, you have to press TAB to put your cursor to OK button.'' <br>
'''Your server is now up and running.''' <br>
<br>
You might also need to manually port forward the following ports:
* UDP 27005
* TCP and UDP 27015
 
If you also want the community provided maps, you can install the empires-server-maps-extra package :  <br>
''Warning!'' <br>
''Takes a long time to install.'' <br>
''This pack is no longer maintained, and has outdated versions of maps.''  <br>
apt install empires-server-maps-extra
 
==== Opening the server console ====
To open the server console, execute the following command:
 
su - empires -c "tmux attach"
 
To get out of the server console, dont do CTRL + C or you will kill the server <br>
You can do CTRL + B and then CTRL + D to detach and get out of server console <br>
You can do CTRL + B and then page up and page down to scroll higher in console, then ESC to get out of the CTRL + B mode (tmux basics, you can google them) <br>
 
You can also start or stop the empires-server service
service empires-server stop
service empires-server start
 
Typing quit in server console will automatically restart the server. <br>
When server crashes it will restart automatically. (unless it freezes) <br>
 
Server folder is located in '''/var/lib/empires'''
 
Start parameters can be edited in '''/etc/empires-server.conf'''
 
More detailed/full start parameters are inside the service '''/usr/bin/empires-server'''
 
== Configuration ==
 
=== Cvars ===
 
Most configuration can be done through the use of [Server Cvars]. There are several ways commands can be set to run automatically:
 
* Include the command in the call to SRCDS. This is how the <code>maxplayers</code> cvar is set in the example above. This will run the command as soon as possible.
* Include the command in the <code>/cfg/autoexe.cfg</code> file. This will run the command once on server start-up, before any maps have loaded.
* Include the command in the <code>/cfg/server.cfg</code> file. This will run the command every time any map loads.
* Include the command in a <code>/cfg/maps/[mapname].cfg</code> file. If there is a <code>.cfg</code> file in this directory with the same name as a map, the commands in it will be run every time that map loads. Use this for map-specific configuration changes, such as adjusting the resource multiplier or ticket count.
 
The following configuration options are the ones you will most likely need to change:
 
{| class="wikitable"
|+ Common Configuration
!  Command !! Description
|-
| hostname || The name of your server, as it appears in the server browser.
|-
| rcon_password || A password that can be used to send server commands remotely.
{{Warning|Set this to a secure password, and do not share it freely. Anyone with this password can execute admin commands on your server.}}
|-
| sv_password || If this is set, players will be required to enter this password before joining the server.
|-
| sv_downloadurl || The URL of a [[FastDL]] server.
|-
| sv_region || A number representing the region your server is located in. A list of valid regions [[https://developer.valvesoftware.com/wiki/Sv_region can be found here]].
|-
| sv_contact || An email address players can use to contact the server owner.
|-
| sv_setsteamaccount || Link the server to a Steam account using an authentication token.
{{Fixme|Why/under what circumstances should this be done?}}
|-
| maxplayers || The maximum number of players allowed to join the server. This can only be set as part of the command that launches SRCDS.
|}
=== FastDL Setup ===
 
The [https://developer.valvesoftware.com/wiki/FastDL FastDL system] allows server owners to specify a URL from which custom content will be downloaded. This speeds up the process of players downloading custom content when joining a server, so setting this system up is highly recommended.
 
{{Fixme|We need instructions here on how to set up a FastDL server.}}


This will download all files necessary to host a Half-Life 2 Deathmatch server (and Empires). And remember to "Go get yourself a cup of coffee." as valve said, this will take some time
== Server Extensions ==
There are several plugins available for use in Empires. Two extension systems are available (and can run in parallel):


* Install the Empires Dedicated Server files to "C:\HL2DS\empires" (use your own install path).
* [http://www.sourcemod.net/ 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:
* Create a shortcut of '''srcds.exe''' and place it where you want then go to properties of the shortcut. Add the following to the end of the shortcut target:  
** [http://raegquit.com/beerdude26/empires-plugins/rg_ungrief.smx Ungrief Command Vehicle] - Teleports the specified command vehicle to where you are looking. Usage: !ungrief <nf | be | imp>
-game empires +maxplayers 14 -port 27015 -console +map emp_canyon -autoupdate
** [http://www.sourcebans.net/ SourceBans] - A free global administration and banning system for Source engine based servers.
It sould look like this;
** [http://kigenac.com/viewtopic.php?f=4&t=231 Kigen's Anti-Cheat] (Requires Sockets 3.0.1 plugin) - An extensive anti-cheating plugin.
srcds.exe -game empires +maxplayers 14 -port 27015 -console +map emp_canyon -autoupdate
** For more plugins, look at the [[Sourcemod Plugins]] page.
{{Tip|You can adjust your port and maxplayers via the shortcut or the ''server.cfg'' file.}}
* [http://www.sourceop.com/wiki/Installing SourceOp] is less popular, but is required to run an anti-DoS plugin:
** [http://www.sourceop.com/modules.php?name=Downloads&d_op=viewdownload&cid=9 DoS Attack Fixer] - Protects against A2C_PRINT and other spam.


=== Configuration ===
Both systems themselves run on [http://www.sourcemm.net/ MetaMod], allowing them to run in parallel.
Next, edit your mapcycle.txt and server.cfg files to your liking.  
{{Warning|When editing your server.cfg remember to change your '''rcon_password''' and '''hostname''' directives!}}
rcon_password "pass"  //Your rcon password
hostname "Servername" //The name of your server


These are the most important settings to change, there are more in the cfg so test around what is best for you.
== 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".  


=== Starting ===
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".
You should now be able to double-click your server shortcut, which will start up your dedicated server.


== Dedicated Server (Linux) ==
This way, server.cfg will then run myserver.cfg and override any server.cfg settings.
=== Downloading ===
First of all you need the [http://storefront.steampowered.com/download/hldsupdatetool.bin HLDS Update Tool]. This is what we use to update/download the server. You will also need Empires Dedicated Server from the [http://empiresmod.com/download.php Empires Download Page].


=== Installing SDS ===
Loading various server "modes" can then be done by calling them in the server console:
Now we have to extract the HLDS-Update-Tool.
* Go to the homedir of the user who is designated to run the HL2-Server and create a subdir.
hl2usr@hl2srv ~ # mkdir hl2
* Copy the HLDS-Update-Tool into your new subdir and chmod it to make it executable:
hl2usr@hl2srv ~/hl2 # chmod +x hldsupdatetool.bin
* Run the binary:
hl2usr@hl2srv ~/hl2 # ./hldsupdatetool.bin
* If you get a warning about not finding "compress", go grab the "[ncompress]" package on Redhat/Fedora:
hl2usr@hl2srv ~/hl2 # yum install ncompress
* Now that you have finished extracting the Update-Tool you can use it to download all required files:
hl2usr@hl2srv ~/hl2 # ./steam -command update -game "hl2mp" -dir .
Get yourself a cup of tea, coffee, soda, etc., and have a rest. Depending on your connection speed this can take some time


=== Installing Empires ===
<pre>
Next, we have to extract the previously downloaded Empires-Server.
rcon exec tankwars.cfg
* Copy the zip-file (something like empires_v1xxx_server.zip) to the folder where the HLDS-Update-Tool resides (''~/hl2'' in this example) and extract it:
</pre>
hl2usr@hl2srv ~/hl2 # unzip empires_v1xxx_server.zip
This command created a subdir ''empires'' and extracted all needed files into it.


=== Configuration ===
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.
Before you can start your new Dedicated Server the servers config files have to be altered to satisfy your needs.
 
* cd to the ''"empires"'' subdir
As an example of custom configuration you might want to use, the following line will disable the ability to join spectators at the start of the round:
* Edit the file ''mapcycle.txt'' with your prefered text editor and add/remove the maps you like/don't like in your mapcycle
* cd to the config dir of your Empires installation (''~/hl2/empires/cfg'' in this example)
* Edit the ''server.cfg'' to your liking
{{Warning|When editing your server.cfg remember to change your '''rcon_password''' and '''hostname''' directives!}}
rcon_password "pass"  //Your rcon password
hostname "Servername" //The name of your server


=== Starting ===
Now your server should be ready for startup
* cd to your Dedicated-Servers basedir (''~/hl2'' in this example)
* Start the Server:
hl2usr@hl2srv ~/hl2 # ./srcds_run -game empires +maxplayers 14 -port 27015 -console +map emp_canyon -autoupdate
{{Tip|Use a terminal multiplexer like [http://www.gnu.org/software/screen/ Screen] to be able to detach the HL2-Server Console and disconnect from your servers shell without terminating the HL2-Daemon}}
* You can create a Bash-File in your Dedicated-Servers basedir to easily start your Empires-Server in a virtual Screen-Terminal:
{{ Box File|empires.sh|
<pre>
<pre>
#! /bin/bash
emp_allowspectators 0; wait 30000; emp_allowspectators 1
screen -A -d -m -S empires -t empires ./srcds_run -game empires +maxplayers 14 -port 27015 -console +map emp_canyon -autoupdate
</pre>
</pre>
}}
 
* Now make the Bash-File executable and run it:
It should be put at the end of the .cfg file so as to not delay any subsequent commands. The wait command delays all further commands by the amount specified in 1/100ths of a second.
hl2usr@hl2srv ~/hl2 # chmod +x empires.sh
 
hl2usr@hl2srv ~/hl2 # ./empires.sh
== Running a beta server ==
The Dedicated-Server now runs in the background. You can attach to the Screen-Terminal by typing:
Running a beta server is just like a normal server, with the desired steam branch mentioned when downloading the server package.
hl2usr@hl2srv ~/hl2 # screen -r empires
 
<pre>
steamcmd.exe +login anonymous +app_update 460040 -beta beta validate +quit
</pre>
 
See this link for more info on automating server creation, and on switching to specific steam branches.
https://developer.valvesoftware.com/wiki/SteamCMD#Automating_SteamCMD


== Related Links ==
== Related Links ==
* [http://server.counter-strike.net/server.php?cmd=cmdall General HL2 Directives/Commands]
* [http://server.counter-strike.net/server.php?cmd=cmdall General HL2 Directives/Commands]
* [http://www.mani-admin-plugin.com/ Mani Admin Plugin]
* [http://www.sourcemod.net/ SourceMod]
* [https://pastebin.com/SXsp0r2F How to create an Empires Server on Windows from A to Z.]

Latest revision as of 05:12, 13 March 2024

Empires Server Resources
Dedicated Server Setup | Cvars | Optimization | Sourcemod Plugins



Dedicated servers are like the listen servers (which can be created by pressing the "create server" button on the main menu), but they don't require a copy of the game to be running. This is less resource intensive as the server doesn't need to spend any time rendering graphics.

Installation

There are two supported ways of installing a dedicated server. On Windows and Linux, you can install the server using the SteamCMD utility. On Debian-based distributions of linux, you can also install the server through APT, this will set it up as a service and with tmux.

Dedicated Server - SteamCMD

The Empires Dedicated Server can be installed using the SteamCMD utility. The server has an appid of 460040, and must be downloaded while logged in as an anonymous user.

To install the server on Windows:

  • Install SteamCMD.
  • Open a command line window with elevated / local administrator privileges
  • Browse to the location where SteamCMD was installed, and enter this command:
steamcmd.exe +login anonymous +app_update 460040 validate +quit
  • This same command can also be used to update Empires Dedicated Server.

Once the server has been downloaded, you can launch the server by navigating to the installed location of SRCDS.exe and running the following console command: 

srcds.exe -game "empires" -console -toconsole -secure +map con_district402 +maxplayers 64

To allow players to connect to your server from outside your local network, you may need to port-forward the following ports:

  • UDP 27005
  • TCP and UDP 27015

Dedicated Server - APT

This method will install the server as a service, with tmux. (with tmux you run the server in a separate terminal window, so you can switch between the dedicated server and linux environment)

Video tutorial: https://www.youtube.com/watch?v=RVvJTphiG24

Installing a dedicated server is supported on 32 bit Debian 10.
If you have a 64 bit install you might need to execute the following as root: 

dpkg --add-architecture i386
apt update
apt install lib32gcc1

Execute the following in a root shell to add the key and repository: 

mkdir -p /etc/apt/keyrings/
wget -qO- https://deb1.ws.maxmaton.nl/debian/signing.pub | gpg --dearmor | sudo tee /etc/apt/keyrings/maxmaton.gpg >/dev/null
echo 'deb [signed-by=/etc/apt/keyrings/maxmaton.gpg] http://deb.maxmaton.nl/debian buster main non-free' | sudo tee /etc/apt/sources.list.d/maxmaton.list

After that you can continue with: 

apt update
apt install empires-server

When it shows the license agreement, you have to press TAB to put your cursor to OK button.
Your server is now up and running.

You might also need to manually port forward the following ports:

  • UDP 27005
  • TCP and UDP 27015

If you also want the community provided maps, you can install the empires-server-maps-extra package :
Warning!
Takes a long time to install.
This pack is no longer maintained, and has outdated versions of maps. 

apt install empires-server-maps-extra

Opening the server console

To open the server console, execute the following command: 

su - empires -c "tmux attach"

To get out of the server console, dont do CTRL + C or you will kill the server
You can do CTRL + B and then CTRL + D to detach and get out of server console
You can do CTRL + B and then page up and page down to scroll higher in console, then ESC to get out of the CTRL + B mode (tmux basics, you can google them)

You can also start or stop the empires-server service 

service empires-server stop
service empires-server start

Typing quit in server console will automatically restart the server.
When server crashes it will restart automatically. (unless it freezes)

Server folder is located in /var/lib/empires

Start parameters can be edited in /etc/empires-server.conf

More detailed/full start parameters are inside the service /usr/bin/empires-server

Configuration

Cvars

Most configuration can be done through the use of [Server Cvars]. There are several ways commands can be set to run automatically:

  • Include the command in the call to SRCDS. This is how the maxplayers cvar is set in the example above. This will run the command as soon as possible.
  • Include the command in the /cfg/autoexe.cfg file. This will run the command once on server start-up, before any maps have loaded.
  • Include the command in the /cfg/server.cfg file. This will run the command every time any map loads.
  • Include the command in a /cfg/maps/[mapname].cfg file. If there is a .cfg file in this directory with the same name as a map, the commands in it will be run every time that map loads. Use this for map-specific configuration changes, such as adjusting the resource multiplier or ticket count.

The following configuration options are the ones you will most likely need to change:

Common Configuration
Command Description
hostname The name of your server, as it appears in the server browser.
rcon_password A password that can be used to send server commands remotely.
Warning  Warning: Set this to a secure password, and do not share it freely. Anyone with this password can execute admin commands on your server.
sv_password If this is set, players will be required to enter this password before joining the server.
sv_downloadurl The URL of a FastDL server.
sv_region A number representing the region your server is located in. A list of valid regions [can be found here].
sv_contact An email address players can use to contact the server owner.
sv_setsteamaccount Link the server to a Steam account using an authentication token.
~Fixme
Why/under what circumstances should this be done?
maxplayers The maximum number of players allowed to join the server. This can only be set as part of the command that launches SRCDS.

FastDL Setup

The FastDL system allows server owners to specify a URL from which custom content will be downloaded. This speeds up the process of players downloading custom content when joining a server, so setting this system up is highly recommended.


~Fixme
We need instructions here on how to set up a FastDL server.

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.
    • For more plugins, look at the Sourcemod Plugins page.
  • 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.

As an example of custom configuration you might want to use, the following line will disable the ability to join spectators at the start of the round: 

emp_allowspectators 0; wait 30000; emp_allowspectators 1

It should be put at the end of the .cfg file so as to not delay any subsequent commands. The wait command delays all further commands by the amount specified in 1/100ths of a second.

Running a beta server

Running a beta server is just like a normal server, with the desired steam branch mentioned when downloading the server package. 

steamcmd.exe +login anonymous +app_update 460040 -beta beta validate +quit

See this link for more info on automating server creation, and on switching to specific steam branches. https://developer.valvesoftware.com/wiki/SteamCMD#Automating_SteamCMD

Related Links

Retrieved from "https://wiki.empiresmod.com/index.php?title=Dedicated_Server_Setup&oldid=10977"