Editing MG/Dedicated Server

Starting MegaGlest 3.6.0 it is possible to host a dedicated headless game server. This means you can now install MegaGlest on a dedicated or virtual private server hosted in a data center, or a virtual server on your computer. This can be quite useful since data centers usually provide way better network connectivity at affordable pricing than ISPs can provide (and users can afford) in residential areas, meaning less people will drop out of games, and there will be less latency ('better ping'). Moreover, dedicated servers can run 24/7 so servers can be available for hosting games at any time.

== Requirements ==
To host your own headless server, you will need a dedicated or virtual private server which roughly meets the minimum requirements the [https://github.com/MegaGlest/megaglest-source/blob/develop/docs/README.txt MegaGlest README] lists. You should actually be okay with 512 MB unallocated RAM (remaing free memory after the system has fully started up), though. A multi-core system is strongly recommended, and if these are virtual cores (VPS) then this system should not be running any other services. Graphics or audio cards are not needed. You do need a low latency Internet connection, though. Bandwith is not usually a problem (it might be if you operate under strict bandwidth restrictions and your MegaGlest server offers mods for download).

==Hosting==

Unless you own / rent a dedicated server where you can setup a VPS for MegaGlest, the cheapest way to host is probably to go with a Virtual Private Server (VPS). There are unbelievably many VPS providers out there and we have little to no experience with them so we can't really make a recommendation at this point. Prices range from less than US $10 per month to amounts which would be better spent on a dedicated server. Please check websites such as [http://www.lowendbox.com/ lowendbox.com], [http://www.webhostingtalk.com webhostingtalk.com] and [http://webhostlist.de webhostlist.de] which compare and discuss various offers.

There are also few 'free' VPS offers. All we can say there is that Amazons [http://aws.amazon.com/free/ free-for-one-year VPS] and [http://www.host1free.com/free-vps/ Host1Free's VPS] do not provide sufficient resources to run a dedicated gameserver while ''some'' of the offers by [http://freevps.us/page-requirements.html FreeVPS.us] may work based on the resources they list. But we haven't actually tried this, since, of course, this offer is not entirely free but you need to dance the hula-hula. Generally, there are only few ''free'' offers on the Internet now, and those are usually by idealistic computer enthusiasts, almost never by companies - those always come with strings attached (which is completely understandable from their profit driven perspective). There are also donation based offers, or organisations operating without the target of/need to make profits (community service / hosting / colocation providers), which can be a good choice.

==Operating system==
Since we have to decide for one operating system, we go the easy (and good) way and use Debian GNU/Linux "Stable". These steps ''may'' also work on later Debian versions as well as on Ubuntu servers.

Install a minimal Debian GNU/Linux server. This can be done with a Debian ''Netinstall'' CD image as well as by many other ways. The details are considered out of the scope of this manual - see the Debian website and installation manual.

You should now have a working minimal Debian server. Start by working as the ''root'' user. Depending on how you will manage this server you may want to install some additional packages:

 apt-get install unattended-upgrades openssh-server less screen

If you installed an SSH server you can do the remaining installation remotely.

==MegaGlest installation==

The next steps are specific to the installation and configuration of MegaGlest on your dedicated server. If you already have a working multi-use(r) Debian server, this is the point to start following this tutorial.

Still working as ''root'', create a new restricted user ''megaglest'':

 adduser megaglest --disabled-password --gecos ""

Also as ''root'', install dependencies for MegaGlest (this list for sure may be outdated, but missing libs should be quite easy to find out e.g. thanks to error messages from start_megaglest script):

 apt-get install xz-utils p7zip-full libsdl2 libglu1 libsm6 libopenal1 libvorbisfile3 libglew1.5 libfontconfig1 libldap-2.4-2 libidn11 binutils

Now switch to the ''megaglest'' user, this is the last time you need to work as ''root'':

 su -l megaglest

Download [https://github.com/MegaGlest/megaglest-source/releases/ binary] and [https://github.com/MegaGlest/megaglest-data/releases/ data] archives for the latest stable MegaGlest release. If your server runs a 64 bit operating system (the ''arch'' command says ''x86_64'') then go for the 64 bit Linux binary and data archives, otherwise use the 32 bit ones. You can download these using ''wget'', here's an example on how to do it with MegaGlest 3.12.0 for a 64 bit server:

 wget https://github.com/MegaGlest/megaglest-source/releases/download/3.12.0/megaglest-binary-linux-x86_64-3.12.0.tar.xz
 wget https://github.com/MegaGlest/megaglest-data/releases/download/3.12.0/megaglest-standalone-data-3.12.0.tar.xz

Unpack, add a convenient symlink, delete the GUI binaries you do not need on a server and create the configuration directory:

 tar -xJf megaglest-standalone-data-3.12.0.tar.xz
 ln -s megaglest-3.12.0 megaglest-server
 cd megaglest-server
 tar -xJf megaglest-binary-linux-x86_64-3.12.0.tar.xz
 rm megaglest_g3dviewer start_megaglest_g3dviewer megaglest_editor start_megaglest_mapeditor
 mkdir -p ~/.megaglest

Do a test run:

 megaglest@gameserver:~/megaglest-server$ ./start_megaglest --version
 megaglest v3.12.0
 Compiled using: GNUC: 40403 [64bit] on: Jan 18 2014 17:44:55 platform: Linux-X64 endianness: little
 GIT: [Rev: 4628.11ac54a] - using STREFLOP [SSE] - [no-denormals]
 megaglest@gameserver:~/megaglest-server$

If MegaGlest fails to start here, please check the [http://faq.megaglest.org FAQ] .

==MegaGlest configuration==

You may now want to set a server name, this is currently done via the ''NetPlayerName'' option in [[MG/INI|glestuser.ini]]:

 mkdir -p ~/.megaglest
 
 echo 'NetPlayerName=MyTestServer' > ~/.megaglest/glestuser.ini
Obviously you should replace <code>MyTestServer</code> by something which nicely and uniquely describes this server (or its owner). Watch out, there is a low character limit in place.

You are now ready to go. However, for advanced configuration, many more options which may matter for a game server are available. Here is an optional example for a more complex <code>~/.megaglest/glestuser.ini</code> file:
 ### For more information on these options, please consult
 ### [[MG/INI|http://wiki.megaglest.org/INI]]
 
 ### Network settings
 NetPlayerName=Edit_glestuser.ini
 #PortList=61357,61367,61377,61387,61397
 #PortServer=61357
 #FTPServerPort=61358
 #EnableFTPServer=1
 #EnableFTPServerInternetTechtreeXfer=1
 #EnableFTPServerInternetTilesetXfer=1
 #EnableFTPXfer=1
 #Masterserver=[[MG/INI|http://master.megaglest.org/]]
 
 ### Logging
 #LogPath=$HOME/.megaglest/
 #DebugLogFile=debug.log
 #DebugMode=true
 #DebugNetwork=true
 #DebugPerformance=true
 #DebugWorldSynch=true
 #AiLog=true
 #ThreadedLogging=true
 
 ### Audio
 ### Disable all sound processing
 FactorySound=None
 
 ### File archives
 #FileArchiveExtractCommand=7z
 #FileArchiveExtractCommandParameters=x -o{outputpath} {archivename}
 #FileArchiveExtractCommandSuccessResult=0
 #FileArchiveExtension=.7z 

<span style="font-size:13px;">These and all other glestuser.ini options are</span><span style="font-size:13px;"> </span>[[MG/INI|documented on this wiki]]<span style="font-size:13px;">. Note that they may change between releases, so when you upgrade your server to the latest version, be sure to read the [http://changelog.megaglest.org changelog] and review the INI document.</span>

==Firewall configuration==

Now you need to ensure that people can actually connect to your server from the Internet so that it will get listed [http://master.megaglest.org on the master server]. For this to work, Internet originated traffic must be able to reach the game server on several ports, and the game server needs to be able to connect to the masterserver, too.
===Inbound connectivity===
*'''''TCP port 61357: game protocol port'''''<span style="line-height:21px;"> </span><span style="line-height:21px;">(</span>''PortServer''<span style="line-height:21px;"> option in </span>[[MG/INI|glestuser.ini]]<span style="line-height:21px;"> to change)</span>
*'''''TCP ports 61358 to 61366: FTP ports'''''<span style="line-height:21px;"> (set the </span>''FTPServerPort''<span style="line-height:21px;"> option in </span>[[MG/INI|glestuser.ini]]<span style="line-height:21px;"> (defaults to 61358) to the low FTP port to change). FTP support is optional but recommended since it allows clients to download mods they are lacking from your server. The low FTP port is the FTP control port, the rest are FTP data ports.</span>

If you are one of the few who do asymmetric port forwarding (the ports your MegaGlest game server binds to / listens on differ from the ports players need to connect to on your port forwarding device's WAN interface) then you can also set the ''ExternalPort'' option in [[MG/INI|glestuser.ini]] (which defaults to the value ''PortServer'' is set to).
===Outbound connectivity===

In case you also regulate outbound traffic (most servers/networks do not), be sure that the following will be accessible from your MegaGlest server:

*'''''master.megaglest.org, TCP port 80'''''

*'''''mods.megaglest.org, TCP port 80'''''

Note that the IP addresses these hostnames resolve to can change without notification (but they should do so rarely).
==Testing==

You should now be able to start a server and it should automatically publish to the [[MG/Master_Server|master server]] (this can take up to two minutes).

To run a headless server and register with the masterserver run:

'''./start_megaglest --headless-server-mode=exit'''

(for full options run megaglest --help to see all parameters)

Currently available game servers are listed at [http://play.mg Play.MG] , so your server should show up there with its IP address and the server/player name you have set. If publishing to the master server does not seem to work try running the server with ''--verbose'' option as discussed in the [http://faq.megaglest.org FAQ]. 

Once publishing succeeded, start MegaGlest on your desktop computer, connect to your new game server and play a test game, ideally with a another human network player who will help you test because there is a two network player minimum to start a game (contact us on hints how to work around this limit if needed). The first user connecting to a headless server controls it. If this user disconnects, the next user who connected already (or will connect) takes control.

A good test setup which stresses your server is an eight player game on the ''Eight Rivers'' map, with the ''Desert'' tileset, where all non-human slots are set to ''CPU Mega'' and every one of them is on a separate team. All human players can have their faction set to ''observer'' (set ''allow observers'' in ''advanced options'' first) so you don't actually have to play this game but can just watch.

Play this game for a while, pressing '?' (question mark) to activate ''debug view''. It will list the total number of units in this game. Once this reaches 500 and more check your servers' load (using standard Linux/unix utilities like ''top'', ''ps'', ''free'', ''iotop'' etc.) to see how it handles this game and to get an idea how games will feel for players on your server. Note that this setup is close to maxing things out, so things may get a bit slow here and there, but the game should not fail.

As soon as all network players disconnect from your new gameserver, the gameserver should exit, so you should see your shells' prompt again. If this does not happen, you can type ''quit'' into the terminal window which presents your gameservers secure shell, and press Enter. If the game still does not quit then, try Ctrl-C or run this in a separate shell on the server:
 kill -9 `pidof megaglest`

==Game server automation==
If you want to run the game server regularly, you can introduce some level of automation. You may want to make it start up automatically on boot. And, while we are not aware of any, to rule out side effects which may drain on system resources, you should have the game quit and restart after every played game. After all, restarting the game is very quick and does not hurt.
===Why not initd?===
The common Unix way of managing daemons is sysv-initd and its various derived approaches such as upstart and systemd, which are often not compatible. So if you wanted to write an initd-like script for MegaGlest, you would have to do it for every initd-like mechanisms which is in use these days.

You should also keep in mind that initd's concept is that you start a daemon process (storing its single process ID as a reference) and keep it running until you manually stop it through initd (effectively killing the process by its stored process ID). That's quite different to a daemon restarting itself regularly, getting a new process ID assigned each time it restarts, as should be the case for a MegaGlest game server. Howwever, this could still be done with an intermediary control / process monitoring layer, basically like a master process spawnings and killing its child processes, representing itself to initd-like daemon as a sincle process with a static process ID,

Finally, managing an initd-controlled process requires root access (which you may not have at any given time if you are not the sole user of thie server).

As a result of these thoughts, no initd-like scripts are provided for MegaGlest at this time. We would appreciate contributions under compatible license terms if you are willing to maintain it, though.

For now, there are other options, as discussed below.
===Using Crond===

The easiest and most simple way to manage your headless server is to use the wrapper script  start_megaglest_gameserver which ships with MegaGlest. This script starts MegaGlest as a headless server and makes it quit after each played game.

The only thing missing then is a machanism to start this script automatically during boot of the server. This can be achieved by a crontab. To install it, working as the user which runs the gamserver, use

 crontab -e
to spawn the crontab editor, then add this:
 @reboot $HOME/megaglest-server/start_megaglest_gameserver >/dev/null
You may also want to set the MAIL variable on top of this file to ensure you receive email notifications in case of an error.

With this script in place, server logs are created at <tt>~/.megaglest/server.log</tt> and ''can'' grow massively. You may want to rotate and/or compress them (or not create them in the first place).

After the next reboot, the gameserver should start up automatically.
===Using restartd===
[https://github.com/ajraymond/restartd restartd] is a simple job control system which does not interfere with your distributions' initd-like mechanism, but adds to it. So far it is mostly used on (and packaged for) Debian GNU/Linux but it is by no means limited to it.
[[Category:MG]]

==Status reporting==
For scripting the server and making information on it available, such as on a website, you may want to be able to query the current state of the server at any given time. Starting with v3.7.0 you can query a headless server on TCP port 61355 (that's by default, use <code>z</code> in <code>--use-ports=x,y,z</code> when starting the server to listen on a custom port) on localhost (127.0.0.1) only. To do so, either start a second MegaGlest instance using <code>--headless-server-status</code> (and optionally <code>--use-ports</code>, too) or just use a simple TCP client such as netcat (nc), telnet, sox, or even your web browser to connect to this port.

The output you will get will look something like this:
 =========================================
 Headless Server Current Game information:
 =========================================
 Network connection for index: 0
 ------------------------------
 Connected: 0
 Handshake received: 0
 Network connection for index: 1
 ------------------------------
 Connected: 1
 Handshake received: 1
 Connected at: 2012-10-17 01:04:36
 Connection duration: 0 hours 0 minutes 29 seconds.
 Player Index: 1
 IP Address: 123.123.123.123
 Player name: tomreyn
 Language: english
 Game Version: v3.7.0-dev-GNUC: 40603 [64bit]-Rev: 3724
 Session id: 676319
 Socket id: 7
 Total Slot Count: 2
 =========================================
The reason this information is not available to the outside world by default is because it could stress the server (the server needs to handle these requests live at the same time a monstrous game may be going) but also to protect the players' privacy (it gives away IP addresses, language preference and system architecture of all connected players). This behaviour may change in the future. You, as a server admin, could already make it (or a subset of it) availabe now by either firewall rules (such as by forwarding inboound traffic on <external-ip>:61355 to 127.0.0.1:61355) or by means of a web server, which either proxies requests to 127.0.0.1:61355 (apache + mod_proxy) or provides access to a simple CGI script which wraps the output of <span style="font-family:monospace;">--headless-server-status</span> and adds HTTP headers to it.
==Questions and feedback==
If you have any questions, please discuss them at [http://forums.megaglest.org/ forums.megaglest.org]. Please report both your positive and negative experiences there, too.

Running a game server, it is relatively easy to gather information about problems in MegaGlest. If you run into any bugs, please report them at [http://bugs.megaglest.org/ bugs.megaglest.org].

==See also==
*[[MegaGlest]]
*[[Multiplayer]]
[[Category:MG]]
[[Category:Multiplayer]]
@@ Line 31: / Line 31: @@
 Also as ''root'', install dependencies for MegaGlest (this list for sure may be outdated, but missing libs should be quite easy to find out e.g. thanks to error messages from start_megaglest script):
-  apt-get install xz-utils p7zip-full libsdl2-2.0-0 libglu1 libsm6 libopenal1 libvorbisfile3 libglew1.5 libfontconfig1 libldap-2.4-2 libidn11 binutils
+  apt-get install xz-utils p7zip-full libsdl2 libglu1 libsm6 libopenal1 libvorbisfile3 libglew1.5 libfontconfig1 libldap-2.4-2 libidn11 binutils
-On older Debian derivates you would need to use package ''libsdl2'' instead of ''libsdl2-2.0-0''.
 Now switch to the ''megaglest'' user, this is the last time you need to work as ''root'':
@@ Line 39: / Line 37: @@
   su -l megaglest
-Download [https://github.com/MegaGlest/megaglest-source/releases/ binary] and [https://github.com/MegaGlest/megaglest-data/releases/ data] archives for the latest stable MegaGlest release. If your server runs a 64 bit operating system (the ''arch'' command says ''x86_64'') then go for the 64 bit Linux binary and data archives, otherwise use the 32 bit ones. You can download these using ''wget'', here's an example on how to do it with MegaGlest 3.13.0 for a 64 bit server:
+Download [https://github.com/MegaGlest/megaglest-source/releases/ binary] and [https://github.com/MegaGlest/megaglest-data/releases/ data] archives for the latest stable MegaGlest release. If your server runs a 64 bit operating system (the ''arch'' command says ''x86_64'') then go for the 64 bit Linux binary and data archives, otherwise use the 32 bit ones. You can download these using ''wget'', here's an example on how to do it with MegaGlest 3.12.0 for a 64 bit server:
-  wget https://github.com/MegaGlest/megaglest-source/releases/download/3.13.0/megaglest-binary-linux-x86_64-3.13.0.tar.xz
+  wget https://github.com/MegaGlest/megaglest-source/releases/download/3.12.0/megaglest-binary-linux-x86_64-3.12.0.tar.xz
-  wget https://github.com/MegaGlest/megaglest-data/releases/download/3.13.0/megaglest-standalone-data-3.13.0.tar.xz
+  wget https://github.com/MegaGlest/megaglest-data/releases/download/3.12.0/megaglest-standalone-data-3.12.0.tar.xz
-Create a directory, add a convenient symbolic link, unpack both archives and delete some files you do not need on a headless server (only!) as follows:
+Unpack, add a convenient symlink, delete the GUI binaries you do not need on a server and create the configuration directory:
-  mkdir megaglest-3.13.0
+  tar -xJf megaglest-standalone-data-3.12.0.tar.xz
-  ln -s megaglest-3.13.0 megaglest-server
+  ln -s megaglest-3.12.0 megaglest-server
   cd megaglest-server
- # Expanding game data can take a while, it is well compressed
+  tar -xJf megaglest-binary-linux-x86_64-3.12.0.tar.xz
- tar -xJf ../megaglest-standalone-data-3.13.0.tar.xz
+  rm megaglest_g3dviewer start_megaglest_g3dviewer megaglest_editor start_megaglest_mapeditor
-  tar -xJf ../megaglest-binary-linux-x86_64-3.13.0.tar.xz
+  mkdir -p ~/.megaglest
-  rm megaglest_g3dviewer start_megaglest_g3dviewer megaglest_editor start_megaglest_mapeditor *.desktop *.ico
-If everything went well, it should look roughly like this:
-  megaglest@gameserver:~/megaglest-server$ ls -lF
- total 120904
- drwxr-xr-x  2 megaglest megaglest      4096 Mar  8 21:41 blender/
- -rw-r--r--  1 megaglest megaglest        29 Mar  8 21:41 build-time.log
- drwxr-xr-x  4 megaglest megaglest      4096 Mar  8 21:43 data/
- drwxr-xr-x  3 megaglest megaglest      4096 Mar  8 21:43 docs/
- -rw-r--r--  1 megaglest megaglest      3666 Mar  8 21:41 glest.ini
- -rw-r--r--  1 megaglest megaglest      1135 Mar  8 21:41 glestkeys.ini
- -rw-r--r--  1 megaglest megaglest      5333 Mar  8 21:41 ldd-megaglest.log
- drwxr-xr-x  3 megaglest megaglest      4096 Mar 12 14:31 lib/
- drwxr-xr-x  2 megaglest megaglest      4096 Mar  8 21:43 maps/
- -rwxr-xr-x  1 megaglest megaglest 123665044 Mar  8 21:41 megaglest*
- -rw-r--r--  1 megaglest megaglest      4150 Mar  8 21:41 megaglest.bmp
- -rwxr-xr-x  1 megaglest megaglest      1775 Mar  8 21:41 megaglest-mini-update.sh*
- -rw-r--r--  1 megaglest megaglest      4581 Mar  8 21:41 megaglest.png
- -rw-r--r--  1 megaglest megaglest     17785 Mar  8 21:41 megaglest.xpm
- drwxr-xr-x 25 megaglest megaglest      4096 Mar  8 21:43 scenarios/
- -rw-r--r--  1 megaglest megaglest       145 Mar  8 21:41 servers.ini
- -rwxr-xr-x  1 megaglest megaglest     20252 Mar  8 21:41 start_megaglest*
- -rwxr-xr-x  1 megaglest megaglest     15548 Mar  8 21:41 start_megaglest_gameserver*
- drwxr-xr-x  4 megaglest megaglest      4096 Mar  8 21:43 techs/
- drwxr-xr-x 21 megaglest megaglest      4096 Mar  8 21:43 tilesets/
- drwxr-xr-x  5 megaglest megaglest      4096 Mar  8 21:43 tutorials/
 Do a test run:
   megaglest@gameserver:~/megaglest-server$ ./start_megaglest --version
-  megaglest v3.13.0
+  megaglest v3.12.0
-  Compiled using: GNUC: 40804 [64bit] platform: Linux-X64 endianness: little
+  Compiled using: GNUC: 40403 [64bit] on: Jan 18 2014 17:44:55 platform: Linux-X64 endianness: little
-  GIT: [Rev: 5607.967257e] - using STREFLOP [SSE] - [no-denormals]
+  GIT: [Rev: 4628.11ac54a] - using STREFLOP [SSE] - [no-denormals]
+ megaglest@gameserver:~/megaglest-server$
 If MegaGlest fails to start here, please check the [http://faq.megaglest.org FAQ] .
@@ Line 100: / Line 72: @@
 You are now ready to go. However, for advanced configuration, many more options which may matter for a game server are available. Here is an optional example for a more complex <code>~/.megaglest/glestuser.ini</code> file:
   ### For more information on these options, please consult
-  ### [[MG/INI|https://wiki.megaglest.org/INI]]
+  ### [[MG/INI|http://wiki.megaglest.org/INI]]
   ### Network settings
@@ Line 111: / Line 83: @@
   #EnableFTPServerInternetTilesetXfer=1
   #EnableFTPXfer=1
-  #Masterserver=[[MG/INI|https://master.megaglest.org/]]
+  #Masterserver=[[MG/INI|http://master.megaglest.org/]]
   ### Logging
@@ Line 158: / Line 130: @@
 To run a headless server and register with the masterserver run:
- ./start_megaglest --headless-server-mode=exit
+'''./start_megaglest --headless-server-mode=exit'''
-(run ''megaglest --help'' to see all available options)
+(for full options run megaglest --help to see all parameters)
 Currently available game servers are listed at [http://play.mg Play.MG] , so your server should show up there with its IP address and the server/player name you have set. If publishing to the master server does not seem to work try running the server with ''--verbose'' option as discussed in the [http://faq.megaglest.org FAQ].
@@ Line 240: / Line 212: @@
 [[Category:MG]]
 [[Category:Multiplayer]]
-[[Category:HOW-TOs]]