improved readme

This commit is contained in:
Steffen Schröder 2014-05-20 16:10:36 +02:00
parent 0fc03e1d08
commit 2550f43669
3 changed files with 70 additions and 66 deletions

View File

@ -6,36 +6,41 @@ The newly designed and easy to use ManiaPlanet Server Controller.
http://www.maniacontrol.com
SETUP:
# SETUP:
1. Copy all Files into the desired Directory.
1. Copy all files into the desired directory.
2. Configure the needed Settings in the 'configs/server.xml' file:
2. Configure the needed settings in the 'configs/server.xml' file:
2.1 Enter Your ManiaPlanet-Server Information.
(The needed Settings are defined in the file 'dedicated_cfg.txt' of Your Game-Server.)
2.1 Enter Your ManiaPlanet-server information.
(The needed settings are defined in the file 'dedicated_cfg.txt' of your game server.)
2.2 Enter the Information about Your MySQL-Server, -User and -Database.
2.2 Enter the Information about your MySQL server, user and database.
2.3 Add as many Player-Logins of Master-Administrators as You wish.
2.3 Add as many player logins of master-administrators as you wish.
3. Run the Controller with the Shell Script 'ManiaControl.sh' (on UNIX) or with the Batch File 'ManiaControl.bat' (on Windows).
3. Run the controller with the shell script 'ManiaControl.sh' (on UNIX) or with the batch file 'ManiaControl.bat' (on Windows).
4. Enjoy!
INFORMATION:
# INFORMATION:
- ManiaControl is mainly tested on UNIX Machines.
- Even though it might run properly on Windows we can't promise it will work all Cases.
- In order to run ManiaControl on Windows you have to alter the File ManiaControl.bat and enter the Path to your php.exe!
- Tests were performed using PHP Version 5.4!
- In the current nightly release there is no 5.3 support (it should come soon)
- If You notice Problems with other Versions please let us know.
- You need to activate the php extension php_curl and php_mysqli
- for trackmania you need also activate the php_xmlrpc extension
- ManiaControl is mainly tested on UNIX machines.
- Even though it might run properly on Windows we can't promise it will work all cases.
- In order to run ManiaControl on Windows you have to alter the file 'ManiaControl.bat' and enter the path to your php.exe!
# REQUIREMENTS:
- MySQL Database
- PHP 5.4+
- Needed extensions:
- php_mysqli
- php_curl
- php_xmlrpc (TM only)
- Please report bugs by writing a Mail to bugs@maniacontrol.com!
# How to report bugs or request features?:
- Write a mail to bugs(at)maniacontrol(dot)com
- Open an issue on GitHub.com/ManiaControl/ManiaControl
- Post in the ManiaPlanet Forum

46
application/README.md Normal file
View File

@ -0,0 +1,46 @@
ManiaControl
============
The newly designed and easy to use ManiaPlanet Server Controller.
http://www.maniacontrol.com
# SETUP:
1. Copy all files into the desired directory.
2. Configure the needed settings in the 'configs/server.xml' file:
2.1 Enter Your ManiaPlanet-server information.
(The needed settings are defined in the file 'dedicated_cfg.txt' of your game server.)
2.2 Enter the Information about your MySQL server, user and database.
2.3 Add as many player logins of master-administrators as you wish.
3. Run the controller with the shell script 'ManiaControl.sh' (on UNIX) or with the batch file 'ManiaControl.bat' (on Windows).
4. Enjoy!
# INFORMATION:
- ManiaControl is mainly tested on UNIX machines.
- Even though it might run properly on Windows we can't promise it will work all cases.
- In order to run ManiaControl on Windows you have to alter the file 'ManiaControl.bat' and enter the path to your php.exe!
# REQUIREMENTS:
- MySQL Database
- PHP 5.4+
- Needed extensions:
- php_mysqli
- php_curl
- php_xmlrpc (TM only)
# How to report bugs or request features?:
- Write a mail to bugs(at)maniacontrol(dot)com
- Open an issue on GitHub.com/ManiaControl/ManiaControl
- Post in the ManiaPlanet Forum

View File

@ -1,47 +0,0 @@
*******************************************************
* *
* ManiaControl - ManiaPlanet Server Controller *
* Written by steeffeen & kremsy *
* *
* Website: *
* ManiaControl.com *
* *
* Contact: *
* steff@maniacontrol.com, *
* lukas@maniacontrol.com *
* *
*******************************************************
SETUP:
1. Copy all Files into the desired Directory.
2. Configure the needed Settings in the 'configs/server.xml' file:
2.1 Enter Your ManiaPlanet-Server Information.
(The needed Settings are defined in the file 'dedicated_cfg.txt' of Your Game-Server.)
2.2 Enter the Information about Your MySQL-Server, -User and -Database.
2.3 Add as many Player-Logins of Master-Administrators as You wish.
3. Run the Controller with the Shell Script 'ManiaControl.sh' (on UNIX) or with the Batch File 'ManiaControl.bat' (on Windows).
4. Enjoy!
INFORMATION:
- ManiaControl is mainly tested on UNIX Machines.
- Even though it might run properly on Windows we can't promise it will work all Cases.
- In order to run ManiaControl on Windows you have to alter the File ManiaControl.bat and enter the Path to your php.exe!
- Tests were performed using PHP Version 5.4!
- In the current nightly release there is no 5.3 support (it should come soon)
- If You notice Problems with other Versions please let us know.
- You need to activate the php extension php_curl and php_mysqli
- for trackmania you need also activate the php_xmlrpc extension
- Please report bugs by writing a Mail to bugs@maniacontrol.com!