How are we doing it?
- We assume that you are working on a Windows operating system and you are extracting the ZIP- and edit the config files on it.
- We use
Trackmania Canyonas TitlePack, so you will have a running Maniaplanet Dedicated Server with the
Canyonenvironment. Of course you can replace
Stadiumto use that TitlePack.
In this manual I present two scenarios of an typical Maniaplanet Dedicated Server installation. There are more possibilities then just these two, but i can not handle all of them. You could also use a VirtualBox on your Windows computer and the VirtualBox simulates a computer which runs Linux (e.g. Ubuntu). On that you can install the Linux variant of a Maniaplanet dedicated server.
Scenario No.1: Hosted in a data center (24/7)
You have a so called
dedicated server which is running
Linux and is located inside of a data center and it is available 24/7 from the internet.
This is the default scenario for this manual.
Scenario No.2: Hosted at home
You want to install the Maniaplanet Dedicated Server on your computer which is running Windows and is located at your home.
All steps required an extra handling, files or tools are marked with
- Ubuntu Server 16.x (64-bit), 12.x (32-bit)
- CentOS 6.x (64-bit)
- Debian 7.x (64-bit)
- openSUSE 12.x, 13.x (32-bit, 64-bit)
- openSUSE Leap 42.x (64-bit)
- FreeBSD 10.x (64-bit)
- Windows 7 (32-bit, 64-bit)
- Windows 8 (32-bit)
- Windows 10 (64-bit)
MySQL Community Edition
- Uniform Server ZeroXIII 13.3.2 (no installation required)
- USBWebserver 8.6 (no installation required)
- XAMPP 1.8.3
- WampServer 2.5
- VertrigoServ 2.35
This documentation uses a defined path structure which looks like this:
Maniaplanet dedicated server
GameServer\ GameServer\GameData\ GameServer\Packs\ GameServer\UserData\Config\ GameServer\UserData\Maps\MatchSettings\ GameServer\UserData\Replays\GReplays\ GameServer\UserData\Replays\VReplays\
UASECO server controller
uaseco\cache\ uaseco\cache\mapimages\ uaseco\cache\webrequest\ uaseco\config\ uaseco\docs\ uaseco\docs\dedicated server\ uaseco\includes\ uaseco\includes\core\ uaseco\includes\core\XmlRpc\ uaseco\includes\dedimania\ uaseco\includes\maniaexchange\ uaseco\includes\musicserver\ uaseco\includes\musicserver\getid3\ uaseco\locales\ uaseco\logs\ uaseco\newinstall\ uaseco\newinstall\config\ uaseco\newinstall\database\ uaseco\newinstall\dedicated server\ uaseco\newinstall\locales\ uaseco\plugins\
To run UASECO and a Maniaplanet Dedicated Server the minimum requirements are:
PHP/5.6.0 or newer (7.x.x recommended), in where the following extensions have to be enabled:
- Optional: Exchangeable Image Information (exif)
- Required: File Transfer Protocol (ftp)
- Required: Iconv character set conversion facility (iconv)
- Required: Image Processing and GD (GD Library)
- Required: LibXML (libxml)
- Required: Multibyte String (mbstring)
- Required: MySQL Improved (mysqli)
- Required: SimpleXML (SimpleXML)
PHP have to allow the function
WebRequestclass, so make sure that the
execwhich the php-cli is using!
You can choose between MySQL and MariaDB, UASECO supports both:
MySQL/5.1.0 or newer (5.7.x recommended), in where the following extensions have to be enabled:
- Required: InnoDB Storage Engine
MariaDB/5.5.20 or newer (10.1.x recommended), in where the following extensions have to be enabled:
- Required: XtraDB or InnoDB Storage Engine
Maniaplanet Dedicated Server version
2017-06-15_16_00 or newer, and requires:
- XML-RPC API-Version
- ModeScript API-Version
The Maniaplanet Dedicated Server and UASECO has to run on the same physical machine, otherwise UASECO is not able to read all Map files from the Maniaplanet Dedicated Server playlist.
These are my recommendations for a Maniaplanet Dedicated Server with UASECO and I use these software in this manual.
- Ubuntu Server/17.04 or newer
- Uniform Server ZeroXIII (no installation required)
- Text Editor Notepad++ (open source)
- SFTP, SCP and FTP client WinSCP (Free software)
- SSH client PuTTY (open source)
If you have already installed a text editor which can handle utf8 files correct, then you do not need Notepad++ (the included Windows Notepad can not handle it!). WinSCP is only required if you want to transfer the Maniaplanet Dedicated Server and UASECO on your dedicated server inside the data center.
Bunch of required files
Before we are able to start the installation process, we need to download all theses files and store them onto your harddrive into a folder.
Download the latest release of the Maniaplanet dedicated server 2017-06-15_16_00
You only need to download that TitlePack which you want to use:
If you want to setup a Maniaplanet Dedicated Server on where all above TitlePacks are mixed, then you need this TitlePack too (and of course all of the above):
Download the release UASECO/0.9.5 2017-06-08.
Uniform Server ZeroXIII
Download the latest release of the Uniform Server ZeroXIII at SourceForge
Lets starting it
In order to setup a Maniaplanet Dedicated Server and UASECO you need the following:
PlayerLoginfrom the player
PlayerPasswordfrom the player
Validation Keyfrom the player
- A valid e-mail-address
To make the foreign players able to connect to your Maniaplanet dedicated server, you have to open some ports in your firewall.
If you want to run the Maniaplanet Dedicated Server and UASECO on a computer that is located at your home, then you probably a router over that this computer is connected to the internet. In this case you have to forward traffic at the listed ports below to the local IP of your computer on that the Maniaplanet dedicated server and UASECO are running on.
- Server port
2350UDP and TCP incomming and outgoing traffic
- P2P port
3450UDP and TCP incomming and outgoing traffic
- HTTP port
443TCP and UDP incomming and outgoing traffic (mostly for the Maniaplanet Dedicated Server to communicate to the MasterServer)
Do not open the XML-RPC port 5000 to the internet, because this is only for local communication between the Maniaplanet Dedicated Server and UASECO!
If you want to have more then one Maniaplanet Dedicated Server on one computer, then you have to increase the
XML-RPC port, e.g. to
5001 and so on.
You have to create a server account at your Maniaplanet Account Manager, login with your
Later we need the
ServerPassword of that server you have created.
To be able to receive Planets by donations from players or to pay out Planets by e.g. Records-Eyepiece for the ranks 1 till 3 after each map, you have to transfer an amount of Planets from your player account to the just created Maniaplanet Dedicated Server account.
Please create a folder on your harddrive, in this manual we use
C:\ManiaplanetServer\. In these folder
we will install the Maniaplanet Dedicated Server , UASECO and the Uniform Server ZeroXIII (only
- Create a subfolder in
C:\ManiaplanetServer\with the name
GameServer, then a path
C:\ManiaplanetServer\GameServer\should exists now.
- Create a subfolder in
C:\ManiaplanetServer\with the name
uaseco, then a path
C:\ManiaplanetServer\uaseco\should exists now.
- Create a subfolder in
C:\ManiaplanetServer\with the name
UniformServerZeroXIII, then a path
C:\ManiaplanetServer\UniformServerZeroXIII\should exists now.
- Execute the downloaded Uniform Server ZeroXIII file, e.g.
13_3_2_ZeroXIII.exeand extract the files into the folder
- Remove the beginning
;from the following entries (if not already):
If an entry from the above list is missing, please add them.
To be able to see all of the output and read the most of the UTF-8 encoded Nicknames and Mapnames, you can setup the Windows Command Prompt. For a fully detailed manual and with screenshots visit https://www.isunshare.com/windows-8/change-font-font-size-and-layout-in-cmd.html
Prefered changes for an 1920 x 1080 px resolution:
- Change the font size to
- Change the font to
- Change the window size to width
Installing the Maniaplanet Dedicated Server
Extract the file
ManiaplanetServer_2017-06-15.zip into the folder
GameData\ Packs\ RemoteControlExamples\ UserData\ ListCallbacks_2011-08-01.html ListCallbacks_2011-10-06.html ListCallbacks_2012-06-19.html ListCallbacks_2013-04-16.html ManiaPlanetServer ManiaPlanetServer.exe RunSrvSM.bat RunSrvSM.sh RunSrvTM.bat RunSrvTM.sh
You have to setup the Maniaplanet Dedicated Server to run in the
<game_mode> "Script" and
also you have to declare which
<title> the Maniaplanet Dedicated Server should use.
C:\ManiaplanetServer\GameServer\UserData\Maps\MatchSettings\maplist_canyon.txt with Notepad++:
<?xml version="1.0" encoding="utf-8" ?> <playlist> <gameinfos> <game_mode>0</game_mode> <script_name>TimeAttack.Script.txt</script_name> <title>TMCanyon@nadeo</title> <gameinfos> </playlist>
The above example is shorter and only the required tags that need to be changed or added are shown.
<dedicated> <authorization_levels> <level> <name>SuperAdmin</name> <password>YOUR_SUPERADMIN_PASSWORD</password> </level> <level> <name>Admin</name> <password>YOUR_ADMIN_PASSWORD</password> </level> <level> <name>User</name> <password>YOUR_USER_PASSWORD</password> </level> </authorization_levels> <masterserver_account> <login>YOUR_SERVER_LOGIN</login> <password>YOUR_SERVER_PASSWORD</password> <validation_key>YOUR_VALIDATION_KEY</validation_key> </masterserver_account> <server_options> <name>YOUR_SERVER_NAME</name> </server_options> <system_config> <connection_uploadrate>8000</connection_uploadrate> <connection_downloadrate>8000</connection_downloadrate> <server_port>2350</server_port> <server_p2p_port>3450</server_p2p_port> <xmlrpc_port>5000</xmlrpc_port> <title>TMCanyon@nadeo</title> <disable_coherence_checks>true</disable_coherence_checks> </system_config> </dedicated>
The above example is shorter and only the required tags that need to be changed or added are shown. For a detailed description of each tag visit the official documentation.
YOUR_SUPERADMIN_PASSWORDwith a secure password for maximum security, do not re-use this!
YOUR_ADMIN_PASSWORDwith a secure password for maximum security, do not re-use this!
YOUR_USER_PASSWORDwith a secure password for maximum security, do not re-use this and do not use your password from your player login here!
YOUR_SERVER_LOGINwith your setup at the PlayerPage.
YOUR_SERVER_PASSWORDwith your setup at the PlayerPage.
YOUR_VALIDATION_KEYwith your validation key you have received by mail after your Player account registration (usually five characters long).
YOUR_SERVER_NAMEwith a name that describes your server, you can use formating codes and Crazy Nicknames to make your server unique. This name will be shown in the in-game serverlist.
- You should setup
<connection_downloadrate>to the values the internet connection can handle (Kbits per second).
<title>has to be in sync with the settings from
- You should
trueto prevent players to be kicked and banned from the Maniaplanet Dedicated Server when the connection of the player is very slow.
I prefer to have a simple filename for the startup file for the Maniaplanet Dedicated Server, so I use the
ServerLogin as part of the filename.
With this you can see easily which Maniaplanet Dedicated Server it is.
#!/bin/sh ./ManiaPlanetServer /title=TMCanyon@nadeo /game_settings=MatchSettings/maplist_canyon.txt /dedicated_cfg=dedicated_canyon.txt
ManiaPlanetServer.exe /title=TMCanyon@nadeo /game_settings=MatchSettings/maplist_canyon.txt /dedicated_cfg=dedicated_canyon.txt
- The parameter
/titlehas to be the same as in the
C:\ManiaplanetServer\GameServer\UserData\Config\dedicated_canyon.txt, so it is
- The parameter
/game_settingshas to be the MatchSettings file relative from
C:\ManiaplanetServer\GameServer\UserData\Maps\, so it is just
- The parameter
/dedicated_cfghas to be the filename
C:\ManiaplanetServer\GameServer\UserData\Config\dedicated_canyon.txt, without the path
C:\ManiaplanetServer\GameServer\UserData\Config\, so it is then just
To save space on the drive (and to not transfer unnecessary you can remove the following files and folders from
RemoteControlExamples\ ListCallbacks_2011-08-01.html ListCallbacks_2011-10-06.html ListCallbacks_2012-06-19.html ListCallbacks_2013-04-16.html RunSrvSM.bat RunSrvSM.sh
If you do not want the
@home scenario, then you can also delete the
RunSrvTM.bat file too.
Installing the UASECO server controller
In this part of this documentation we install the server controller USAECO, this will store the informations for Records, Players, Maps and so on, and let you control several things at the dedicated Server.
Extract the file
UASECO-0.9.5-2017-06-08.zip into the folder
uaseco\cache\ uaseco\config\ uaseco\docs\ uaseco\includes\ uaseco\locales\ uaseco\logs\ uaseco\newinstall\ uaseco\plugins\ uaseco.php
You have to create a database in MySQL or MariaDB in where UASECO can store informations, settings, records and so on. You can use phpMyAdmin for this, or connect directly to the MySQL console.
Connect to theMySQL console
mysql --user='root' -p
You will be asked for the password of root, after successfully authentication, create an new database.
Create an new database for UASECO:
CREATE DATABASE `uaseco` DEFAULT CHARACTER SET 'utf8' DEFAULT COLLATE 'utf8_bin';
You can use an other name as
uaseco for that database, but in this documentation I will use this name.
After that you have to create a seperate user and grant this user all rights to the
Create an new User
CREATE USER 'MYSQL_USER'@'localhost'; SET PASSWORD FOR 'MYSQL_USER'@'MYSQL_HOST' = password('MYSQL_PASSWORD'); GRANT ALL PRIVILEGES ON `uaseco`.* TO 'MYSQL_USER'@'localhost' WITH GRANT OPTION;
MYSQL_USERwith the mysql user you have created or you got from your provider.
MYSQL_HOSTwith the hostname on which your MySQL or MariaDB server is running on, normally it is
MYSQL_PASSWORDwith a secure password.
Setup the database tables
Setting up the database tables in MySQL is done automatically the first time UASECO runs, so here is no need to setup it manually.
If you are switching from XAseco2 to UASECO, then you can use your current database to keep all records of the players. In the last section Starting you will find a manual to convert your database.
Now you have to setup several files in the
config folder, to make UASECO able to connect to the database and to the Maniaplanet Dedicated Server,
and to welcome your players on your server.
The below action is only for an new installation, if you want to upgrade your UASECO installation, please visit the Upgrade Guide!
- Move all files from
C:\ManiaplanetServer\uaseco\newinstall\config\into the folder
- Move all files from
C:\ManiaplanetServer\uaseco\newinstall\locales\into the folder
C:\ManiaplanetServer\uaseco\newinstall\uaseco.sh\into the folder
C:\ManiaplanetServer\uaseco\newinstall\webrequest.sh\into the folder
C:\ManiaplanetServer\uaseco\newinstall\uaseco.bat\into the folder
C:\ManiaplanetServer\uaseco\newinstall\webrequest.bat\into the folder
If the folder
C:\ManiaplanetServer\uaseco\newinstall\dedicated-server\ does contain a folder which name matches the release date of the Maniaplanet Dedicated Server then
you have to copy all the files:
- Copy the contents of
C:\ManiaplanetServer\uaseco\newinstall\dedicated-server\RELEASE_DATEinto the folder
C:\ManiaplanetServer\GameServer\UserData\Scripts\and override all the files.
RELEASE_DATEwith the release date of the Maniaplanet Dedicated Server.
<dedicated_server> <login>SuperAdmin</login> <password>YOUR_SUPERADMIN_PASSWORD</password> <ip>127.0.0.1</ip> <port>YOUR_DEDICATED_PORT</port> <timeout>180</timeout> </dedicated_server> <masteradmins> <tmlogin>YOUR_PLAYER_LOGIN</tmlogin> </masteradmins> <dbms> <host>DATABASE_HOST</host> <login>DATABASE_LOGIN</login> <password>DATABASE_PASSWORD</password> <database>DATABASE_NAME</database> <table_prefix>uaseco_</table_prefix> </dbms> <dedicated_installation>PATH_TO_DEDICATED_SERVER</dedicated_installation> <admin_contact>YOUR_MAIL_ADRESS</admin_contact> <mapimages_path>MAP_IMAGES_PATH</mapimages_path>
YOUR_DEDICATED_PORTwith your setup from
YOUR_SUPERADMIN_PASSWORDwith your setup from
YOUR_PLAYER_LOGINwith your player login. You can add more then one MasterAdmins if you want, just duplicate this line.
DATABASE_LOGINwith the mysql user for the database
uasecoyou created above.
DATABASE_PASSWORDthis with the mysql password for the database
uasecoyou have set above.
DATABASE_NAMEthis with the mysql you set above (e.g.
PATH_TO_DEDICATED_SERVERthis with the full path in where the file
ManiaPlanetServeris located after you have uploaded it to your dedicated server. For
@homethe path is
YOUR_MAIL_ADRESSwith a working mail address.
MAP_IMAGES_PATHwith an full path in where the images of the maps will be stored. Make sure your
HTTP Webserverhandles this folder.
<masterserver_account> <login>YOUR_DEDIMANIA_LOGIN</login> <dedimaniacode>YOUR_DEDIMANIA_CODE</dedimaniacode> </masterserver_account>
YOUR_SERVER_LOGINthis with the
YOUR_DEDIMANIA_CODEthis with code you have created at Dedimania.
YOUR_NATIONthis with a ISO 3166 ALPHA-3 string which represents your nation, see a full list at WikiPedia at the row Alpha-3.
<features> <maplist> <mapimages> <access_url>YOUR_MAP_IMAGES_FOLDER_URL</access_url> </mapimages> </maplist> </features>
YOUR_MAP_IMAGES_FOLDER_URLwith the full URL of the
http://example.com/mapimages/(you have setup this folder in
These are the minimal settings, you can change more later, but lets have a running system first!
Edit newinstall\uaseco.sh and newinstall\webrequest.sh
cd /home/tm2/uasecowith the real path on your server.
Edit newinstall\uaseco.bat and newinstall\webrequest.bat (
Transfer the files
Transfer all files and folders from
C:\ManiaplanetServer\ into a folder by FTP or SCP to your dedicated server, e.g.
YOUR_USERwith the correct user of your system.
After uploading you have to change some rights, login by SSH on your dedicated server:
cd /home/YOUR_USER/ chmod 0700 GameServer/ManiaPlanetServer chmod 0700 GameServer/run_tm_YOUR_SERVER_LOGIN.sh chmod 0755 GameServer/UserData/Replays/GReplays/ chmod 0755 GameServer/UserData/Replays/VReplays/ chmod 0700 uaseco/uaseco.sh chmod 0700 uaseco/webrequest.sh
YOUR_USERwith the correct user of your system and
ServerLoginyou have created at the setup of the Maniaplanet Dedicated Server.
Lets go into the hot phase
Connect to your dedicated server by SSH.
If you have a XAseco2 database and want to use them, you have to convert it into the UASECO database structure. For this just use the included converter:
cd /home/YOUR_USER/uaseco/ php -d max_execution_time=0 -d memory_limit=-1 newinstall/database/convert-xaseco2-to-uaseco.php
YOUR_USERwith the correct user of your system. You have to setup the
config\UASECO.xmlfirst, because the settings for the database will be read from this file!
cd /home/YOUR_USER/GameServer/ ./run_tm_YOUR_SERVER_LOGIN.sh
cd C:\ManiaplanetServer\GameServer\ .\run_tm_YOUR_SERVER_LOGIN.bat
cd /home/YOUR_USER/uaseco/ ./webrequest.sh ./uaseco.sh
cd C:\ManiaplanetServer\uaseco\ .\webrequest.bat .\uaseco.bat
This is a private enthusiast Website. Maniaplanet, Trackmania, Shootmania, Nadeo are trademarks of Ubisoft Entertainment.
Windows is a registered trademark of Microsoft Corporation.