View source for Styctap/Installation

This tutorial is simply a re-make of the currently existing [tutorial] written by LOVER$BOY. This too is written by Vertrex but with a few differences here and there.

This tutorial only applies to Debian and Ubuntu based Linux :)

<code>${USER}</code> gets your current user stored in an environment variable. Feel free to replace this if necessary or use <code>$HOME</code> instead.

Open up your Terminal and let’s get started!

== Table of Contents ==

* [[# | 0 Introduction]]
* [[#requirements | 1 Requirements]]
* [[#installation | 2 Installation]]
** [[#downloading-source | 2.1 Downloading Source]]
** [[#configuring-files | 2.2 Configuring Files]]
** [[#installing-files | 2.3 Installing Files]]
** [[#create_server.sh | 2.4 create_server.sh]]
* [[#putting-together | 3 Putting Together]]
** [[#setting-up-servers | 3.1 Setting up Servers]]
** [[#command-files | 3.2 Command Files]]
* [[#setting-up-scripts | 4 Setting up Scripts]]
** [[#server-scripts | 4.1 Server Scripts]]
** [[#start-script | 4.2 Start Script]]
* [[#server-execution | 5 Server Execution]]
** [[#starting-server | 5.1 Starting Server]]
** [[#stopping-server | 5.2 Stopping Server]]
* [[#advanced | 6 Advanced Scripting]]
* [[#extras | 7 Extras]] (shouldn’t be neccessary)
** [[#install-z-thread | 7.1 Install Z-Thread]]
** [[#install-libtools | 7.2 Install Libtools]]
** [[#install-protobuf | 7.3 Install Protobuf]]
** [[#install-screen | 7.4 Install Screen]]
** [[#install-php | 7.5 Install PHP]]
** [[#install-bzr | 7.6 Install BZR]]
** [[#install-libxml2 | 7.7 Install libxml2]]
** [[#update-packages | 7.8 Update Packages]]
* [[#credits | 8 Credits]]

= Requirements =

These following are the software that need to be installed beforehand.

* Have bzr installed
* Have Z-Thread installed
* Have nano (or your favorite text editor) Installed
* Have screen installed
* Have libxml2 installed
* Have build-essentials

It is typically a good idea to update your repositories before installing anything.

<code>sudo apt-get update</code>

You can install them all at once with the following line:

<code>sudo apt-get install bzr build-essential automake libboost-dev libxml2-dev ftgl-dev libglew-dev bison pkg-config autoconf autotools-dev protobuf-compiler screen nano libxml2</code>

= Installation =

What to install? Well, for this tutorial I will be using Alpha Project’s but you have the choices and they are all here: [https://code.launchpad.net/armagetronad Armagetron Advanced: a Tron Clone in 3d].

== Downloading Source ==

Let’s use a location that won’t restrict us for security reasons or any other the computer could think of. Example, let’s try out <code>/home/${USER}/</code> directory. Replace the <code>${USER}</code> with your username.

<code>cd /home/${USER}/</code>

Now download the source into the folder

<code>bzr branch lp:~armagetronad-ap/armagetronad/0.2.9-armagetronad-sty+ct+ap</code>

== Configuring Files ==

After downloading, do

<code>cd 0.2.9-armagetronad-sty+ct+ap</code>

Then do

<pre class="./bootstrap.sh"></pre>
Next minimize the terminal and in your <code>/home/${USER}/</code> folder, make a directory to install the server in. For this tutorial’s case, I’ll do

<code>mkdir /home/${USER}/armagetronad</code>

and next configuring the server itself.

<code>./configure --enable-dedicated --enable-authentication --prefix=/home/${USER}/armagetronad/ --exec_prefix=/home/${USER}/armagetronad/</code>

If you wish to change the default MAX_CLIENTS limit of 32, then I suggest you add

<code>--with-maxclients=X</code>

to your configure line. Be sure to replace <code>X</code> with the number you want

'''Quick Method'''

<code>CXXFLAGS=&quot;-pipe&quot; ./configure --enable-dedicated --enable-armathentication --disable-automakedefaults --disable-sysinstall --disable-useradd --disable-etc --disable-desktop --disable-initscripts --disable-uninstall --disable-games --prefix=/home/${USER}/armagetronad</code>

== Installing Files ==

Two commands and 30 minutes of time is required for this part. Well, <code>make</code> can be faster or slower depending on the speed of your computer.

<source lang="make">make install</source>
'''OR'''

<code>make &amp;&amp; make install</code>

The first command will compile the source code into binary form, preparing for installation. You can speed it up by “multithreading” make with something like the following, replacing 4 with the number of cores (and/or threads, if you have something such as Hyperthreading enabled) on your CPU.

<code>make -j4 make install</code>

Then run the second command and your server should be installed. Go into your <code>/home/${USER}/armagetronad/</code> folder and you should be able to see three folders

<pre class="bin">etc
share</pre>
Go into <code>bin</code> folder and check to make sure you have

<pre class="armagetronad-dedicated"></pre>
If you have it, that means your server has been installed successfully!

== [https://pastebin.com/Wt8zGNEK create_server.sh] ==

= Putting Together =

This is where we will be describing on how to have multiple servers, the folders required and stuff like that.

Ok, first enter into your the folder you installed your server in. For this tutorial, that is <code>/home/${USER}/armagetronad</code><br />
Next create the following folder

<code>mkdir servers</code>

It doesn’t have to be <code>servers</code>. Have the folder name set to whatever you prefer but I always set it with that name so I know that’s where servers go.

== Setting up Servers ==

Now go into that folder. <code>servers</code> is the folder for this tutorial.

<code>mkdir {server_name}</code>

Replace <code>{server_name}</code> with the name of the server or whichever. The choice is again down to you. Next enter into that newly created directory and start creating the folders we need.

Doing it and their explanations are also given below:

<code>mkdir scripts     # the folder for scripts to run that particular server, also for script.php mkdir settings    # the folder for holding our custom settings and config files &amp; folders mkdir var         # the folder for the files the server writes to, like ladderlog.txt, players.txt, etc... mkdir logs        # the folder for logs of your server, especially its console or any errors it detected. No need to create if not needed.</code>

As an example, this tutorial will have following directories

<code>mkdir Test cd Test mkidr scripts mkdir settings mkdir var mkdir logs</code>

After creating the directories, go and place the files required in each of them. If you don’t get it, read the descriptions above for clarifications. Even after reading them and your confused… read the bit below…

'''Read this if you’re folder lost!'''<br />
Folder: scripts<br />
Description: This is the folder for all of your scripts, such as the start-up script and any other configuration scripts you want to use go. Getting Files: Continue to read tutorial and you’ll know soon.

Folder: settings<br />
Description: Settings folder which holds your configs and the regular settings to make the server run properly. Getting Files:

<code>cd /home/${USER}/armagetronad/etc/ cp armagetronad-dedicated /home/${USER}/armagetronad/servers/Test/settings/</code>

== Command Files ==

This is where you will be creating files you would definitely need if hackers tend to jump in servers and take over. In your <code>/home/${USER}/armagetronad/servers/Test/</code> directory, create the files command.txt and console.txt

<code>touch command.txt &amp;&amp; touch console.txt</code>

The <code>command.txt</code> is the file used to send commands to the server using your terminal.<br />
The <code>console.txt</code> is the file that stores the console as the server does it’s job. Useful to going back and checking to ensure nothing terrible happened. Also useful to check for errors.

= Setting up Scripts =

It’s time to set up some scripts to actually run the server!

These scripts are straightforward I hope. Replace ${USER} and any other file or folder names that your and mine differ from.

== Server Scripts ==

This script puts a loop on the server so it can easily be restarted. It also has variables which configure the paths which the server will use.

After preparing the server up, cd into <code>scripts</code> and do

<code>nano server.sh</code>

I prefer to use <code>server</code> as the standard file name but you can choose what you want it named but I generally prefer to name it like this so I know it’s to actually run the server, not the start-up script. However, have the extension as <code>.sh</code>

Now a new screen will appear in your terminal. Paste the following in:

<pre class="#!/bin/bash">
loc=&quot;/path/to/&quot;
tron=$loc&quot;bin/armagetronad-dedicated&quot;
server=$loc&quot;servers/&quot;$1&quot;/&quot;
var=$server&quot;var&quot;
settings=$server&quot;settings&quot;
command=$server&quot;command.txt&quot;
console=$server&quot;console.txt&quot;

### Comment ###
# $1 is the folder name of server given from start.sh it is executed

#mkdir $server&quot;logs&quot;
#screen -S $1 -X log on
#screen -S $1 -X logfile $server&quot;logs/$1.log&quot;
#screen -S $1 -X logstamp on

while true; do
    $tron --vardir $var --userconfigdir $settings --input $command &gt;&gt; $console
    echo &quot;!============================== SERVER RESTARTING IMMEDIATELY ==============================!&quot; &gt;&gt; $console
    sleep 1
done</pre>
The <code>while true; do</code> is a loop system that ensures your server will restart when the server quits or crashes. As it automatically restarts after crash or whatever it was that caused it to shut down, the script will write <code>============== SERVER RESTARTING ==============</code> to console.txt

Change the <math display="inline">loc variable to your prefix path. (probably /home/</math>{USER}/)

Now mark the file executable so it can be run:

<code>chmod +x server.sh</code>

== Start Script ==

This script runs the above script in a screen session so the server can be run in the background. Using screen also allows you to attach and detach from the server console if necessary (although it can be easy to accidentally terminate your server if you use Ctrl+C instead of Ctrl+A+D to detach!)

We’ll call it <code>start.sh</code> here.

<pre class="#!/bin/sh">
server=&quot;your_server_folder_name&quot;

loc=&quot;/path/to/servers/&quot;$server&quot;/&quot;
command=$loc&quot;command.txt&quot;
console=$loc&quot;console.txt&quot;

case $1 in
    start)
        if ! screen -list | grep -q $server; then
                rm -rf $command
            touch $command

                #rm -rf $console

            echo &quot;Starting &quot;$server&quot; immediately!&quot;
            screen -dmS $server ./server.sh $server
        else
            echo $server&quot; is already running...&quot;
        fi
    ;;
    stop)
        if ! screen -list | grep -q $server; then
            echo $server&quot; server is already stopped...&quot;
        else
            echo &quot;Stopping &quot;$server&quot; immediately!&quot;
            echo &quot;EXIT&quot; &gt;&gt; $command
            sleep 1
            screen -S $server -X quit 
        fi
    ;;
esac</pre>
Don’t forget to replace <code>your_server_folder_name</code> with the name you want to give the server to be stored in the screen under as.<br />
So, replace the things that yours and mine differ from and finish of by doing:

<code>chmod +x start.sh</code>

= Server Execution =

== Starting Server ==

Now that you’ve created the [[#Server_Scripts|Server Script]] and [[#Start_Script|Start Script]], let’s start the servers.

cd to your scripts folder

<code>cd /home/${USER}/armagetronad/servers/Test/scripts</code>

Once in, execute the following:

<code>./start.sh start</code>

After execution, a message show appear in the terminal saying “Server Starting”. You can check to make sure its up by typing the following

<code>screen -r {server_name}</code>

Instead of <code>{server_name}</code>, type in the name you gave the server and it should be listed in the list of screen running. To dtach yourself from the screen without causing it to quit, simply press together the keys: <code>CTRL + A + D</code>

<code>screen -ls    # lists all screens running currently</code>

== Stopping Server ==

Not really a special content here, simply have to go back into your scripts folder and do:

<code>./start.sh stop</code>

and a message saying “Server Stopping” should appear. To ensure the server has stopped, do

<code>screen -ls</code>

= Advanced =

Here you will learn to do more high ordered scripting to make your server fascinating and cool!

== [http://rxtron.com/scripts/tutorial.html Scripting tutorial] ==

This section will inform you on how to run script.php. First you create the file, either manually through editor or nano. After making your code, save it in your server’s scripts folder. Then run

<code>chmod +x script.php</code>

to make it executable. Now, in the directory with the settings (settings_custom.cfg, whatever) create a file named script.cfg and add the following lines

<code>KILL_SCRIPT script.php SPAWN_SCRIPT script.php</code>

In game, you can now include script.cfg at any time to restart the script.

Now, add <code>INCLUDE script.cfg</code> in your config (probably settings_custom.cfg) and it will be launched on server startup.

= Extras =

These are snippets of stuff that I found useful when I had problems with things when running my server.

Nelg: I don’t really know why most of these are here when they’re also included with the apt-get line above, so I’ll probably clean this up later

== Install Z-Thread ==

ZThread is neccessary to be able to login during the round. The easiest way to install it is by installing it from your distro’s packages.

<code>sudo apt-get install libzthread-dev</code>

== Install Libtools ==

You simply enter the following into the terminal and it will automatically should install it for you:

<code>sudo apt-get install libtool</code>

== Install Protobuf ==

The easiest way to install protobuf is to install from your distro’s packages like so:

<code>sudo apt-get install protobuf-compiler</code>

== Install Screen ==

The screen command is used in the start scripts to run your server in the background.

<code>sudo apt-get install screen</code>

== Install PHP ==

PHP is typically the language of choice for scripting in Armagetron.

<code>sudo apt-get install php</code>

== Install BZR ==

This will automatically start the installation of the bzr which you will need in order to download the armagetronad source files.

<code>sudo apt-get install bzr</code>

== Install libxml2 ==

This will automatically start to install libxml2. This is needed if the ./configure is to work properly.

<code>sudo apt-get install libxml2-dev</code>

== Update Packages ==

This should be done first as most virtual servers won’t be usable before being updated.

<code>sudo apt-get update</code>

= Credits =

'''Vertrex''': Main author of this tutorial.

'''Nelg''': Various improvements throughout.

Good luck! ;)

__NOTOC__