HowToBuildStendhal: Difference between revisions

From Arianne
Jump to navigation Jump to search
Content deleted Content added
imported>Kymara
small fixes to server jar names and spelling
imported>Kymara
updating this quite nice simple guide
Line 1: Line 1:
Building Stendhal is very simple if you use ant and you satisfy the dependencies.
Building Stendhal is very simple if you use ant and you satisfy the dependencies.

You can also [[Configure a development environment (IDE)]].


=Requirements=
=Requirements=
To compile Stendhal you will need:
To compile Stendhal you will need:
* module stendhal<br>http://arianne.sourceforge.net/?arianne_url=games/game_stendhal
* stendhal source as a stendhal-''version''-src.tar.gz <br>http://arianne.sourceforge.net/?arianne_url=games/game_stendhal#downloads
* Java SDK 1.5<br>http://java.sun.com ''or higher''
* module marauroa <br>http://arianne.sourceforge.net/?arianne_url=servers/server_marauroa
* Java SDK 1.5<br>http://java.sun.com
* Ant 1.6<br>http://ant.apache.org
* Ant 1.6<br>http://ant.apache.org


Optionally:
Optionally:
* Tiled<br>http://tiled.rpgdx.net/
* Tiled<br>http://mapeditor.org/

You can download a compiled marauroa file but Stendhal CVS occasionally requires Marauroa CVS as well.


We do not include dependencies in the source download, to keep the size small. They are in CVS, however, and you can download them via the CVS webfrontend at http://arianne.cvs.sourceforge.net/arianne/stendhal/libs/
We do not include dependencies in the source download, to keep the size small. They are in CVS, however, and you can download them via the CVS webfrontend at http://arianne.cvs.sourceforge.net/arianne/stendhal/libs/
Line 18: Line 17:
==Build using ant==
==Build using ant==
First you need ant properly installed on your system to build Stendhal.
First you need ant properly installed on your system to build Stendhal.
Second you need to compile successfully Marauroa using the compile task.


Then unpack the stendhal source gzip.
To build Stendhal first make sure you have the JAR files in the correct place.

<pre>
<pre>
cd path/to/stendhal
cd path/to/stendhal source
cd ..
mkdir libs
cd stendhal
cd stendhal
</pre>
</pre>


Now add any missing dependencies to the ''lib'' folder: ''TODO: check what these are''
Make sure you remove the version number from name or that you create links to the real file without any version number.

Now just write:
Now just write:
ant dist
ant dist
Line 37: Line 35:
stendhal-''version''.jar
stendhal-''version''.jar
stendhal-data-''version''.jar
stendhal-data-''version''.jar
stendhal-sound-data-''version''.jar


Server files
Server files
Line 61: Line 60:


In future if you wish to just create the client and server jars (not zips and all release packages) then
In future if you wish to just create the client and server jars (not zips and all release packages) then
ant clean && ant
ant clean compile
will suffice. Remember to "ant clean" before you "ant build" everytime - this is done automatically if you "ant dist", however.
will suffice. Remember to "ant clean" before you "ant build" everytime - this is done automatically if you "ant dist", however.



Revision as of 18:29, 14 January 2010

Building Stendhal is very simple if you use ant and you satisfy the dependencies.

You can also Configure a development environment (IDE).

Requirements

To compile Stendhal you will need:

Optionally:

We do not include dependencies in the source download, to keep the size small. They are in CVS, however, and you can download them via the CVS webfrontend at http://arianne.cvs.sourceforge.net/arianne/stendhal/libs/

Build

Build using ant

First you need ant properly installed on your system to build Stendhal.

Then unpack the stendhal source gzip.

  cd path/to/stendhal source
  cd stendhal

Now add any missing dependencies to the lib folder: TODO: check what these are

Now just write:

ant dist

This will build a full set of JAR files at stendhal/build/lib folder.

Client files

 stendhal-version.jar
 stendhal-data-version.jar
 stendhal-sound-data-version.jar

Server files

 stendhal-server-version.jar
 stendhal-xmlconf-version.jar
 stendhal-maps-version.jar

Webstart

In order for webstart to work, the client .jar-files have to be signed. There is some documentation on http://java.sun.com how this works. So I will put here only a small piece of information to get it integrated into the build process:

Put your private key into a file called keystore.ks into the stendhal-root folder Create a file called build.ant-private.properties with theses lines (replacing the values):

keystore.alias=miguelangelblanchlardin@hotmail.com
keystore.password=secret

Trouble shooting

If you have the message error:

stendhal_source/build.xml:42: Could not create task or type of type: replaceregexp.

For linux users this is corrected by installing the "ant-apache-regexp" package. If you use debian or another debian dist (like Ubuntu) this is included in the "ant-optional" package.

Finally

When you have successfully built Stendhal please read the install documentation. It is available on the Wiki at InstallingStendhal.

In future if you wish to just create the client and server jars (not zips and all release packages) then

ant clean compile

will suffice. Remember to "ant clean" before you "ant build" everytime - this is done automatically if you "ant dist", however.





Back to stendhal main wiki page