HowToBuildStendhal
Building Stendhal is very simple if you use ant and you satisfy the dependencies.
Requirements
To compile Stendhal you will need:
- Java SDK 1.5
http://java.sun.com - Ant 1.6
http://ant.apache.org - Marauroa
http://arianne.sourceforge.net
Build
Build using ant
First you need ant properly installed on your system to build Stendhal. Second you need to compile successfully Marauroa using the compile task.
There are several ant tasks. You have to run it as:
ant task_name -D...
compile
Compiles Stendhal into build folder and copies all needed files to their correct place.
Buildfile: build.xml
init:
[mkdir] Created dir: D:\Desarrollo\arianne\stendhal\build
[mkdir] Created dir: D:\Desarrollo\arianne\stendhal\lib
[mkdir] Created dir: D:\Desarrollo\arianne\stendhal\javadocs
compile:
[copy] Copying 3 files to D:\Desarrollo\arianne\stendhal\build\sprites
[copy] Copying 3 files to D:\Desarrollo\arianne\stendhal\build\games\stendhal\server\maps
[javac] Compiling 23 source files to D:\Desarrollo\arianne\stendhal\build
BUILD SUCCESSFUL
Total time: 3 seconds
clean
Removes any trace of compiled stuff from stendhal.
Buildfile: build.xml clean: [delete] Deleting directory D:\Desarrollo\arianne\stendhal\build [delete] Deleting directory D:\Desarrollo\arianne\stendhal\lib [delete] Deleting directory D:\Desarrollo\arianne\stendhal\javadocs BUILD SUCCESSFUL Total time: 0 seconds
jar
Builds a stendhal-version.jar and stendhal-server-version.jar file inside the lib folder.
This task requieres that you write an extra propierty for the path of marauroa compiles code.
ant jar -Dlibdir=jars -Dmarauroa_build=../marauroa/build
Buildfile: build.xml
init:
[mkdir] Created dir: D:\Desarrollo\arianne\stendhal\build
[mkdir] Created dir: D:\Desarrollo\arianne\stendhal\lib
[mkdir] Created dir: D:\Desarrollo\arianne\stendhal\javadocs
client_compile:
[delete] Deleting directory D:\Desarrollo\arianne\stendhal\build
[mkdir] Created dir: D:\Desarrollo\arianne\stendhal\build
[copy] Copying 3 files to D:\Desarrollo\arianne\stendhal\build\sprites
[javac] Compiling 18 source files to D:\Desarrollo\arianne\stendhal\build
client_jar:
[jar] Building jar: D:\Desarrollo\arianne\stendhal\lib\stendhal-0.00.jar
server_compile:
[delete] Deleting directory D:\Desarrollo\arianne\stendhal\build
[mkdir] Created dir: D:\Desarrollo\arianne\stendhal\build
[copy] Copying 3 files to D:\Desarrollo\arianne\stendhal\build\games\stendhal\server\maps
[javac] Compiling 6 source files to D:\Desarrollo\arianne\stendhal\build
server_jar:
[jar] Building jar: D:\Desarrollo\arianne\stendhal\lib\stendhal-server-0.00.jar
jar:
BUILD SUCCESSFUL
Total time: 4 seconds
release
This is a convenience task used to build the released files of stendhal:
- stendhal-version-src.tar.gz that contains all source code
- stendhal-version.zip that contains the compiled version of stendhal client plus the needed dependencies to make it work.
- stendhal-server-version.zip that contains the compiled version of stendhal server.
This task requieres that you write an extra propierty for the path of marauroa compiles code.
ant jar -Dlibdir=jars -Dmarauroa_build=../marauroa/build
Buildfile: build.xml
init:
[mkdir] Created dir: D:\Desarrollo\arianne\stendhal\build
[mkdir] Created dir: D:\Desarrollo\arianne\stendhal\lib
[mkdir] Created dir: D:\Desarrollo\arianne\stendhal\javadocs
server_compile:
[delete] Deleting directory D:\Desarrollo\arianne\stendhal\build
[mkdir] Created dir: D:\Desarrollo\arianne\stendhal\build
[copy] Copying 3 files to D:\Desarrollo\arianne\stendhal\build\games\stendhal\server\maps
[javac] Compiling 6 source files to D:\Desarrollo\arianne\stendhal\build
server_jar:
[jar] Building jar: D:\Desarrollo\arianne\stendhal\lib\stendhal-server-0.00.jar
release_server_binary:
[mkdir] Created dir: D:\Desarrollo\arianne\stendhal\stendhal-server-0.00
[copy] Copying 1 file to D:\Desarrollo\arianne\stendhal\stendhal-server-0.00
[copy] Copying 1 file to D:\Desarrollo\arianne\stendhal\stendhal-server-0.00
[copy] Copying 1 file to D:\Desarrollo\arianne\stendhal\stendhal-server-0.00
[copy] Copying 1 file to D:\Desarrollo\arianne\stendhal\stendhal-server-0.00
[copy] Copying 1 file to D:\Desarrollo\arianne\stendhal\stendhal-server-0.00
[copy] Copying 1 file to D:\Desarrollo\arianne\stendhal\stendhal-server-0.00
[zip] Building zip: D:\Desarrollo\arianne\stendhal\stendhal-server-0.00.zip
[delete] Deleting directory D:\Desarrollo\arianne\stendhal\stendhal-server-0.00
client_compile:
[delete] Deleting directory D:\Desarrollo\arianne\stendhal\build
[mkdir] Created dir: D:\Desarrollo\arianne\stendhal\build
[copy] Copying 3 files to D:\Desarrollo\arianne\stendhal\build\sprites
[javac] Compiling 18 source files to D:\Desarrollo\arianne\stendhal\build
client_jar:
[jar] Building jar: D:\Desarrollo\arianne\stendhal\lib\stendhal-0.00.jar
release_client_binary:
[mkdir] Created dir: D:\Desarrollo\arianne\stendhal\stendhal-0.00
[copy] Copying 1 file to D:\Desarrollo\arianne\stendhal\stendhal-0.00
[copy] Copying 1 file to D:\Desarrollo\arianne\stendhal\stendhal-0.00
[copy] Copying 1 file to D:\Desarrollo\arianne\stendhal\stendhal-0.00
[copy] Copying 1 file to D:\Desarrollo\arianne\stendhal\stendhal-0.00
[copy] Copying 1 file to D:\Desarrollo\arianne\stendhal\stendhal-0.00
[copy] Copying 1 file to D:\Desarrollo\arianne\stendhal\stendhal-0.00
[zip] Building zip: D:\Desarrollo\arianne\stendhal\stendhal-0.00.zip
[delete] Deleting directory D:\Desarrollo\arianne\stendhal\stendhal-0.00
release_binary:
clean:
[delete] Deleting directory D:\Desarrollo\arianne\stendhal\build
[delete] Deleting directory D:\Desarrollo\arianne\stendhal\lib
[delete] Deleting directory D:\Desarrollo\arianne\stendhal\javadocs
release_source:
[mkdir] Created dir: D:\Desarrollo\arianne\stendhal\stendhal-0.00
[copy] Copying 24 files to D:\Desarrollo\arianne\stendhal\stendhal-0.00\src
[copy] Copying 3 files to D:\Desarrollo\arianne\stendhal\stendhal-0.00\sprites
[copy] Copying 3 files to D:\Desarrollo\arianne\stendhal\stendhal-0.00\maps
[copy] Copying 1 file to D:\Desarrollo\arianne\stendhal\stendhal-0.00
[copy] Copying 1 file to D:\Desarrollo\arianne\stendhal\stendhal-0.00
[copy] Copying 1 file to D:\Desarrollo\arianne\stendhal\stendhal-0.00
[copy] Copying 1 file to D:\Desarrollo\arianne\stendhal\stendhal-0.00
[copy] Copying 1 file to D:\Desarrollo\arianne\stendhal\stendhal-0.00
[copy] Copying 1 file to D:\Desarrollo\arianne\stendhal\stendhal-0.00
[tar] Building tar: D:\Desarrollo\arianne\stendhal\stendhal-0.00-src.tar.gz
[delete] Deleting directory D:\Desarrollo\arianne\stendhal\stendhal-0.00
release:
BUILD SUCCESSFUL
Total time: 5 seconds
docs
This task generates the java docs documentation.
You better take a look at this wiki if you are looking for documentation.