InstallingStendhal: Difference between revisions

Jump to navigation Jump to search
Content deleted Content added
imported>MiguelAngelBlanchLardin
No edit summary
imported>MiguelAngelBlanchLardin
No edit summary
Line 10: Line 10:
or check out the cvs version and build it.
or check out the cvs version and build it.


== Start MySql ==
== Start MySQL ==


Refer to the MySql installation documentation for details.
Refer to the MySql installation documentation for details.
Line 18: Line 18:
Make sure to edit the configuration files to disallow external access if you are just going to use it for local testing, or simply use a firewall to block external access to the database.
Make sure to edit the configuration files to disallow external access if you are just going to use it for local testing, or simply use a firewall to block external access to the database.


== Configure MySQL and create .ini file ==
Read at [[http://arianne.sourceforge.net/wiki/index.php/InitialStepsWithMarauroa#Configuration Marauroa configuration]] how to create a database and how to create the configuration .ini file for marauroa.


== Create a MySql user and database for the game ==

Run the sql client (bin/mysql.exe on the windows noinstall package).
Replace <user> and <password> with the desired values and paste the following lines to the prompt that opens:
<pre>
create database stendhal;
grant all on stendhal.* to <user>@localhost identified by '<password>';
</pre>
It should produce output similar to this:
<pre>
Welcome to the MySQL monitor. Commands end with ; or \g.
Your MySQL connection id is 1 to server version: 4.1.10
Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
mysql> create database stendhal;
Query OK, 1 row affected (0.03 sec)
mysql> grant all on stendhal.* to testuser@localhost identified by 'testpass';
Query OK, 0 rows affected (0.00 sec)
mysql>
</pre>

== Create Marauroa.ini file ==

To create the marauroa.ini file you need to can write it by hand, copy from another place or use our application to generate it.<br>
To launch the application that will generate the marauroa.ini file write:
<pre>
java -cp marauroa-XXX.jar marauroa.server.generateini
</pre>

It is a text application that will ask you for values. Let's see it.
<pre>
Marauroa - arianne's open source multiplayer online framework for game development -
(C) 1999-2005 Miguel Angel Blanch Lardin

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

</pre>
Now write the name of the file where you will store the configuration.<br>
Usually pressing <b>ENTER</b> will do the work, as marauroa.ini is a fine name.
<pre>
Write name of the .ini file (marauroa.ini):
Using "marauroa.ini" as .ini file
</pre>

We need to give a name for database.<br>
Use the one you have written above on database creation.
<pre>
Write name of the database (marauroa): stendhal
Using "stendhal" as database name

Write name of the database host (localhost):
Using "localhost" as database host

Write name of the database user (marauroa_user): stendhal_user
Using "stendhal_user" as database user

Write value of the database user password (marauroa_pass): stendhal_passwd
Using "stendhal_passwd" as database user password

In order to make efective these options please run:
# mysql
create database stendhal;
grant all on stendhal.* to stendhal_user@localhost identified by 'stendhal_passwd';
exit

</pre>

Marauroa acts as a server. So it needs a valid UDP port where it will listen to incoming packets.

<pre>
Write UDP port used by Marauroa (>1024): 32160
Using "32160" as database user password
</pre>

This is perhaps the most complex part of Arianne: Choosing the game.<br>
If you are using one of the Arianne supported games, just write the name and the params will be filled using a template automatically, but if you are using your own game, you must provide the complete class name for RPWorld and RPRuleProcessor of your game.
<pre>
Marauroa is a server middleware to run multiplayer games. You need toadd a game
to the system so that server can work. Actually Arianne has implemented several
games:
- stendhal
- mapacman
- the1001
If you write your own game, just write it name here.
You will be asked for more info.

Write name of the game server will run: stendhal
Using "stendhal" as game

Setting RPWorld and RPRuleProcessor for Stendhal
Make sure Marauroa can find in CLASSPATH the folder games/stendhal/*
NOTE: Copy games generated in stendhal inside folder that contains marauroa.jar file
</pre>

You also have to choose the turn time.<br>
Any range is valid, but the best value is around mean ping time for players, that is around 200-300 ms.
<pre>
Write turn time duration in milliseconds (200<time<1000)): 300
Using turn of 300 milliseconds
</pre>

Finally decide where to store logs and statistics.<br>
Logs will be stored at ''path''/logs.
<pre>
Write path for logs generation (./)):
Using path "./" for log generation

Write path for statistics generation (./)):
Using path "./" for statistics generation

COMPLETE---
Generating "marauroa.ini" file
Generated.
</pre>

Congrats!. You configured your Marauroa server.


== Copy Stendhal to the Maraurora classpath ==
== Copy Stendhal to the Maraurora classpath ==