HowToBuildMarauroa: Difference between revisions

Jump to navigation Jump to search
Content deleted Content added
No edit summary
imported>MiguelAngelBlanchLardin
No edit summary
Line 1: Line 1:
Building Marauroa is very simple if you use ant and you satisfy the dependencies.

=Requirements=
=Requirements=
To compile Marauroa you will need:
To compile Marauroa you will need:
Line 4: Line 6:
* JUnit 1.3.8 http://junit.sourceforge.net
* JUnit 1.3.8 http://junit.sourceforge.net
* Ant 1.6 http://ant.apache.org
* Ant 1.6 http://ant.apache.org
* Jython 2.1 http://www.jython.org/download.html


In order to get it working with MySQL you will also need:
In order to get it working with MySQL you will also need:
* MySQL Connector/J http://www.mysql.com/downloads/api-jdbc-stable.html
* MySQL Connector/J http://www.mysql.com/downloads/api-jdbc-stable.html

The following libraries are optional and can be added if you wish:
* Jython 2.1 http://www.jython.org/download.html

If you want to build the java 3D gladiators client you will need:
* JOrbis 0.0.12 http://www.jcraft.com/jorbis/
* Quake 2 MD2 Loader http://www.newdawnsoftware.com/resources/j3d.html
* Loader3DS http://www.starfireresearch.com/services/java3d/inspector3ds.html


= Build=
= Build=
Line 28: Line 23:
it if you have configured correctly your classpath.
it if you have configured correctly your classpath.


There are several ant tasks.
Once complete you will have a marauroa-<version>.jar file in the lib folder.
You have to run it as:
You can generate all the documentation by doing ant docs.
<pre>
ant task_name -D...
</pre>

===compile===
Compiles Marauroa into build folder and copies all needed files to their correct place.
<pre>
Buildfile: build.xml

init:
[mkdir] Created dir: D:\Desarrollo\arianne\marauroa\build
[mkdir] Created dir: D:\Desarrollo\arianne\marauroa\lib
[mkdir] Created dir: D:\Desarrollo\arianne\marauroa\javadocs

installation:
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\build\marauroa\server
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\build\marauroa\server

compile:
[javac] Compiling 91 source files to D:\Desarrollo\arianne\marauroa\build

BUILD SUCCESSFUL
Total time: 4 seconds
</pre>

===clean===
Removes any trace of compiled stuff from marauroa.
<pre>
D:\Desarrollo\arianne\marauroa>ant clean
Buildfile: build.xml

clean:
[delete] Deleting directory D:\Desarrollo\arianne\marauroa\build
[delete] Deleting directory D:\Desarrollo\arianne\marauroa\lib
[delete] Deleting directory D:\Desarrollo\arianne\marauroa\javadocs

BUILD SUCCESSFUL
Total time: 0 seconds
</pre>
===jar===
Builds a marauroa-''version''.jar file inside the lib folder.
<pre>
Buildfile: build.xml

init:
[mkdir] Created dir: D:\Desarrollo\arianne\marauroa\build
[mkdir] Created dir: D:\Desarrollo\arianne\marauroa\lib
[mkdir] Created dir: D:\Desarrollo\arianne\marauroa\javadocs

installation:
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\build\marauroa\server
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\build\marauroa\server

compile:
[javac] Compiling 91 source files to D:\Desarrollo\arianne\marauroa\build

jar:
[jar] Building jar: D:\Desarrollo\arianne\marauroa\lib\marauroa-0.90.jar
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\lib

BUILD SUCCESSFUL
Total time: 5 seconds</pre>
===release===
This is a convenience task used to build the released files of marauroa:
* marauroa-''version''-src.tar.gz that contains all source code
* marauroa-''version''.zip that contains the compiled version of marauroa plus the needed dependencies to make it work.

<pre>
Buildfile: build.xml

init:
[mkdir] Created dir: D:\Desarrollo\arianne\marauroa\build
[mkdir] Created dir: D:\Desarrollo\arianne\marauroa\lib
[mkdir] Created dir: D:\Desarrollo\arianne\marauroa\javadocs

installation:
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\build\marauroa\server
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\build\marauroa\server

compile:
[javac] Compiling 91 source files to D:\Desarrollo\arianne\marauroa\build

jar:
[jar] Building jar: D:\Desarrollo\arianne\marauroa\lib\marauroa-0.90.jar
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\lib

release_binary:
[mkdir] Created dir: D:\Desarrollo\arianne\marauroa\marauroa-0.90
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\marauroa-0.90
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\marauroa-0.90
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\marauroa-0.90
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\marauroa-0.90
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\marauroa-0.90
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\marauroa-0.90
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\marauroa-0.90
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\marauroa-0.90
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\marauroa-0.90
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\marauroa-0.90
[zip] Building zip: D:\Desarrollo\arianne\marauroa\marauroa-0.90.zip
[delete] Deleting directory D:\Desarrollo\arianne\marauroa\marauroa-0.90

clean:
[delete] Deleting directory D:\Desarrollo\arianne\marauroa\build
[delete] Deleting directory D:\Desarrollo\arianne\marauroa\lib
[delete] Deleting directory D:\Desarrollo\arianne\marauroa\javadocs

release_source:
[mkdir] Created dir: D:\Desarrollo\arianne\marauroa\marauroa-0.90
[copy] Copying 97 files to D:\Desarrollo\arianne\marauroa\marauroa-0.90\src

[copy] Copying 15 files to D:\Desarrollo\arianne\marauroa\marauroa-0.90\extras
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\marauroa-0.90
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\marauroa-0.90
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\marauroa-0.90
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\marauroa-0.90
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\marauroa-0.90
[copy] Copying 1 file to D:\Desarrollo\arianne\marauroa\marauroa-0.90
[tar] Building tar: D:\Desarrollo\arianne\marauroa\marauroa-0.90-src.tar.gz
[delete] Deleting directory D:\Desarrollo\arianne\marauroa\marauroa-0.90

release:

BUILD SUCCESSFUL
Total time: 6 seconds
</pre>

===docs===
This task generates the java docs documentation.<br>
You better take a look at this wiki if you are looking for documentation.