StendhalLocalhostServerOnLinux: Difference between revisions

Jump to navigation Jump to search
← Older edit
Content deleted Content added
imported>Kymara
imported>Kribbel
m link for skipping
 
(143 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Navigation for Stendhal Top|Building & Hosting}}

This guide applies to:
This guide applies to:
*Marauroa 2.1 and above
*Marauroa 3.0 and above
*Stendhal 0.65.5 and above
*Stendhal 0.95 and above
<br>
<br>
= Setting up a localhost server =
= Setting up a localhost server =
This guide will teach you how to set up a server on your Linux machine. The server will be a local one, so people from around the world cannot get to your server. Only those who are directly connected to you via a LAN can connect to this server. The required packages are:
This guide will teach you how to set up a server on your Linux machine. The required packages are:
*A compiled version of the Stendhal Server, version X.XX
*A compiled version of the Stendhal Server, version {{version}}
*Optionally: MySQL ''sudo apt-get install mysql-server''
*GNU/Linux ''(This may be others, the directions should apply almost exactly to any *nix system)''
*GNU/Linux ''(This may be others, the directions should apply almost exactly to any *nix system)''
*A text editor ''(just use your favourite)''
*Command-line access ''(ask system administrator if it's a problem)''
*Command-line access ''(ask system administrator if it's a problem)''


For '''easy''' H2 database configuration (which is shipped with Stendhal and is installation-free) just skip straight to '''[[StendhalLocalhostServerOnLinux#Choosing_the_Java_Virtual_Machine|Choosing the Java Virtual Machine]]'''.
== Getting the materials ==
Download a current version of the Stendhal server, stendhal-server-{{version}}.zip from [http://arianne.sourceforge.net/?arianne_url=games/game_stendhal#downloadsection arianne.sf.net].


For '''advanced''' MySQL configuration, keep reading.
If you want to compile it yourself from CVS or the source code provided at the downloads link, then see [[HowToBuildStendhal|How to build Stendhal]] for more info. If you run a Linux System, then you have the necessary tools to get everything else.


== Setting up MySQL ==
Stendhal works with OpenJDK or Sun Java, you will need Java 5 or greater.


Install MySQL:
For Sun Java: Use your Package manager to download '''Sun Java 1.5''' or greater version. At a command line, type
java -version
and if you see anything other than the new java you just installed, then you need to update the java used. At a command line, type
update-java-alternatives --list
(using sudo if you are an ubuntu user, or as root if you are another linux user) which should give you output something like this:


sudo apt-get install mysql-server
*java-1.5.0-sun 53 /usr/lib/jvm/java-1.5.0-sun
*java-6-sun 63 /usr/lib/jvm/java-6-sun
*java-gcj 1042 /usr/lib/jvm/java-gcj


Also download the java connector library if necessary (it's called ''MySQL Connector/J'' ), and make sure a symbolic/soft link to it named ''mysql-connector.jar'' is on the classpath (e.g. in the directory called ''libs'' inside the ''stendhal_server'' directory) when running ''maraurorad'' later.
now, lets say you want to use the java-1.5.0-sun. Then you type
update-java-alternatives --set java-1.5.0-sun
Now run ''java --version'' again to check it worked.


For example:
= Setting up MySQL =

'''You can skip this whole step if you want the fast installation with an H2 database.'''
ln -s /path/to/file-name/mysql-connector-java-5.1.10.jar mysql-connector.jar


After you've installed MySQL, make sure you have a database ready for it.
After you've installed MySQL, make sure you have a database ready for it.
Line 43: Line 35:
create database marauroa;
create database marauroa;
grant all on marauroa.* to 'FOO'@'localhost' identified by 'BAR';
grant all on marauroa.* to 'FOO'@'localhost' identified by 'BAR';
FOO and BAR are the username and password to be used by Marauroa, respectively. Replace them with whatever you want. If the user doesn't exist, it will be created. Remember these values (FOO and BAR)!
'''FOO and BAR are the username and password to be used by Marauroa''', respectively. Replace them with whatever you want. If the user doesn't exist, it will be created. '''Remember these values (FOO and BAR)!'''
If you get a problem like:
If you get a problem like:
ERROR 1044 (42000): Access denied for user 'FOO'@'localhost' to database 'stendhal_db'
ERROR 1044 (42000): Access denied for user 'FOO'@'localhost' to database 'marauroa'
then you need to login to mysql as the root mysql user, who should have 'grant' access. As root you can then try
then you need to login to mysql as the root mysql user, who should have 'grant' access. As root you can then try
grant all on marauroa.* to 'FOO'@'localhost' identified by 'BAR';
grant all on marauroa.* to 'FOO'@'localhost' identified by 'BAR';
again
again


'''Note''': It is recommended to edit the MySQL configuration file 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.
= Makin' the cake =
Well, now that we have the materials ready, we need to mix them together to create a great product, no? Here are the steps we are going to take:
#Create a server directory, to hold everything in a nice, organized way
#Unzip your Stendhal Server zip in this server directory
#Run the Stendhal GenerateINI script, to get a configuration file
#Have fun
We will go through them in turn. The first and last shouldn't be to hard. Let's create that directory!


== Creating the server directory ==
== Choosing the Java Virtual Machine ==
Stendhal works with OpenJDK or Oracle Java, you will need Java 7 or greater.

For Sun Java: Use your Package manager to download '''OpenJDK 7''' or Oracle Java 7 or greater version. At a command line, type
java -version
and if you see anything other than the new java you just installed, then you need to update the java used. At a command line, type
update-java-alternatives --list
(using sudo if you are an ubuntu user, or as root if you are another linux user) which should give you output something like this:

*''java-1.7.0-oracle 53 /usr/lib/jvm/java-1.7.0-oracle''
*''java-gcj 1042 /usr/lib/jvm/java-gcj''
*''java-7-openjdk 1061 /usr/lib/jvm/java-7-openjdk''

now, lets say you want to use the ''java-7-openjdk''. Then you type
update-java-alternatives --set java-7-openjdk
Now run
java -version
again to check it worked.

== Get the materials ==
Download a current version of the Stendhal server, ''stendhal-server-{{version}}.zip'' from [http://arianne.sourceforge.net/?arianne_url=games/game_stendhal#downloadsection arianne.sf.net].

If you want to compile it yourself from CVS or the source code provided at the downloads link, then see [[HowToBuildStendhal|How to build Stendhal]] for more info. If you run a Linux System, then you have the necessary tools to get everything else.

== Create the server directory ==
Let's create your folder to run the server from, in your home directory. NOTE: The commands given are for use in the command-line, but you can take the GUI route as well. For some commands, you must run them from the command-line, and I will tell you
Let's create your folder to run the server from, in your home directory. NOTE: The commands given are for use in the command-line, but you can take the GUI route as well. For some commands, you must run them from the command-line, and I will tell you
cd
cd
Line 66: Line 76:
== Stendhal server files ==
== Stendhal server files ==
Unzip the stendhal server zip which you downloaded, into the stendhal_server directory.
Unzip the stendhal server zip which you downloaded, into the stendhal_server directory.

Now check you have the following files in the stendhal_server directory:
*stendhal-server-X.XX.jar
*stendhal-xmlconf-X.XX.jar
*stendhal-maps-X.XX.jar
*groovy.jar
*simple.jar
*marauroa.jar
*log4j.jar
*log4j.properties
*jython.jar
*mysql-connector.jar ''optional''
*commons-lang.jar

... or in a directory called ''lib'' or ''libs'' inside the stendhal_server directory. If any are in ''lib'' or ''libs'' please move them up into the main stendhal_server directory.

<small>If any of the latter jars are missing you can fetch them here: http://arianne.cvs.sourceforge.net/arianne/stendhal/libs/</small>
Done!
Done!


== Configure marauroa ==
== Run the server ==
The first time you run the server a configuration file for the server (named ''server.ini'') will be generated.
Time to configure Marauroa and the database access. In the command-line (not in GUI!), run:

java -cp stendhal-server-{{version}}.jar games.stendhal.server.core.engine.GenerateINI
There is a script ''runserver.sh'' in the stendhal_server directory - you may need to make it executable first.
So
cd /path/to/stendhal_server
To make it executable, in a command prompt type
chmod u+x runserver.sh
To start it from a command prompt, type
./runserver.sh


Now, it will ask you questions.
Now, it will ask you questions.


===H2===
=== H2 database ===
For the '''fast''' installation
For the '''fast''' installation just hit ''Enter'' twice, to accept the defaults, that you want '''H2''' database, and then to build the key, and wait for it to say:
* hit ''Enter'' to accept the defaults, that you want '''H2''' database
* hit ''Enter'' so that to build the key, and wait for it to say:
server.ini has been generated
server.ini has been generated


'''Warning:''' Any value for the RSA key generation small than 512 may cause the server not to work properly and refuse the client connections.
===MySQL===

=== MySQL database ===
If you want to use MySQL then see below for more details:
If you want to use MySQL then see below for more details:
When it asks you for...
When it asks you for...
Line 101: Line 105:
*database name, hit enter to use the default (marauroa)
*database name, hit enter to use the default (marauroa)
*host, hit enter to use the default (localhost)
*host, hit enter to use the default (localhost)
*user, write the username you used in giving MySQL permissions (FOO)
*user, '''write the username you used in giving MySQL permissions (FOO)'''
*password, write the password you used giving MySQL permissions (BAR)
*password, '''write the password you used giving MySQL permissions (BAR)'''
*RSA key size- This is to make sure that the login information is valid and secure.
*port, anything above 1024. 32160 is the default for stendhal, but it can be anything above 1024
'''Warning:''' Any value for the RSA key generation smaller than 512 may cause the server not to work properly and refuse the client connections.
*game, type "stendhal" (or a number for that, if a multiple-choice menu appears)
*turn time, or how long the server takes to process each event, choose anything above 200, but below 1000. This is in milliseconds. default is 300
*log and stats generation logs, use the default ("./") - it's in the same directory as everything else
*RSA key size, choose anything smaller than 1024 bits, but greater than 512 (or equal to). This is to make sure that the login information is valid and secure. Like the prompt says, anything greater than 1024 can take a LONG time. But, if you have ~30 minutes to spare (more or less, depending on your comp), you could use the extra security


Download a recent mysql-connector.jar from the [https://dev.mysql.com/downloads/connector/j/ MySQL site].
Well, thats everything! When it's finished, you'll have a new file, "server.ini". Don't lose it, as it contains the information to get your server up & running, as well as the key to do that. If Marauroa won't start, and nor will your server, check to see if that INI file is there (at the same directory! NOWHERE ELSE!) and if it is, try running the GenerateINI command again; the file could have change with updating the RSA keys


Well, thats everything! When it's finished, you'll have a new file, "server.ini". Don't lose it, as it contains the information to get your server up & running, as well as the key to do that. If Marauroa won't start, and nor will your server, check to see if that INI file is there (at the same directory! NOWHERE ELSE!) and if it is not, try running the runserver.sh script again; the file could have changed when updating the RSA keys
== Starting Server ==
To start the stendhal server you can just type
java -jar stendhal-server-{{version}}.jar


== Stopping the Server ==
Or, there is a script runserver.sh in the stendhal_server directory - you may need to make it executable first.
In the server window just type '''CTRL+c'''
So

cd /path/to/stendhal_server
== Starting the Server again ==
To make it executable, in a command prompt type
To start the stendhal server again you can just type from a command prompt:
chmod u+x runserver.sh
To start it from a command prompt, type
./runserver.sh
./runserver.sh

'''Note:''' Remember that the server configuration file (''server.ini'') is only generated the first time you run the server unless you delete it.


== Have fun ==
== Have fun ==
Well, that's it! Pretty easy, huh? Check out the troubleshooting and extras sections for more things to do.
Well, that's it! Remember, when you use a client to connect you will need to create a new account and at server name ''localhost''.


= Extras =
= Extras =
Line 136: Line 136:
Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/log4j/Logger
Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/log4j/Logger
</pre>
</pre>

''<span style="color:red;">DEPRECATED:</span> "log4j.jar" is now intended to be located in "libs" directory''

Please open runserver.sh in a text editor. You'll see the classpath defined there, something like
Please open runserver.sh in a text editor. You'll see the classpath defined there, something like
LOCALCLASSPATH=.:data/script/:data/conf/:stendhal-server-$STENDHAL_VERSION.jar:marauroa.jar:mysql-connector.jar:log4j.jar:commons-lang.jar
LOCALCLASSPATH=.:data/script/:data/conf/:stendhal-server-$STENDHAL_VERSION.jar:marauroa.jar:mysql-connector.jar:log4j.jar:commons-lang.jar
Line 141: Line 144:
In this case the user had his log4j.jar in the folder called ''libs'' but the classpath expects it to be in the main folder where runserver.sh ran from. So you can: edit the classpath, replacing ''log4j.jar'' above with ''libs/log4j.jar'' '''or''' move the file.
In this case the user had his log4j.jar in the folder called ''libs'' but the classpath expects it to be in the main folder where runserver.sh ran from. So you can: edit the classpath, replacing ''log4j.jar'' above with ''libs/log4j.jar'' '''or''' move the file.


=== Note for Slackware users: ===
=== MySQL possible error ===


If when you try to run the server later, you get this error in the log:
If when you try to run the server later, you get this error in the log:
Line 170: Line 173:
(Many thanks to Tam Tam. Original source: http://forums.mysql.com/read.php?39,24742,147169#msg-147169 )
(Many thanks to Tam Tam. Original source: http://forums.mysql.com/read.php?39,24742,147169#msg-147169 )


== Server bonuses ==
== Server bonuses ==
=== You are the man! ===
=== You are the man! ===
Want to be an admin? Now you can! It's easy! First create a file called "admins.list" This is a plain text file, with each name on a separate line. The name must be EXACT, or it will not work. Then go to the directory where you extracted stendhal-server-X.XX.zip, and browse to data/conf (create it if it isn't already there). Add admins.list there. You may need to adjust the classpath which your server loads from.
Want to be an admin? Now you can! It's easy! Go to the directory where you extracted stendhal-server-{{version}}.zip, and browse to data/conf. Edit admins.txt there, with each admin name on a separate line. The name must be EXACT, or it will not work. The server needs '.' on the classpath, which is already done if you are using ''runserver.sh''.

=== Be my wife? And other server extensions ===
Server extensions. They add much (or little) functionality to a server, that another may not have. If you want to add the Spouse extension, which adds marriage (uh-oh!) to your server, just add these to your marauroa.ini file we created earlier (note that marriage is now built in to the server and doesn't require an extension, but you can use this template for all extensions, this is just an example):
# load StendhalServerExtension(s)
groovy=games.stendhal.server.scripting.StendhalGroovyRunner
http=games.stendhal.server.StendhalHttpServer
spouse=games.stendhal.server.extension.SpouseExtension
server_extension=groovy,http,spouse
http.port = 8080
The first 3 lines (not including the comment) point to specfic classes in your code. The server_extension line tells marauroa to load those extensions at start time. After adding these, restart your server. Don't worry - the RSA keys won't break because you added these lines. I personally have 3 server extensions that I wrote as well, 2 of which are broken (help!). To add those, just add this:
my_extension=java.class.path.to.my_extension
And add "my_extension" to the end of server_extension (don't forget the comma separating everything!)


= Finished =
= Finished =
Retrieved from "https://meet.konsthol.eu/w/index.php?title=StendhalLocalhostServerOnLinux"