SVN Checkout
From Victory Engine
This short tutorial will describe how to download the latest, bleeding-edge version of the Victory Engine for using it in your project. We'll describe how to build a .jar file which you can include in your build path. If you wish to edit the Engine, read Import into Eclipse.
To check out and build the Engine, you will need:
- To know how to use the command line.
- Subversion (SVN) Client; we will use the standard command line edition. Available here for Windows.
- Apache Ant
- Sun JDK 6.
Contents |
Checking out ("Downloading") from SVN
Find or create a directory to store the engine in, for example C:\lib\victory in Windows or /usr/local/lib/victory in Linux. The location of this doesn't matter much, but keeping it short and near other libraries is easier. Open a command terminal in this directory (or if you are already on a shell, move to this directory), and execute the following command:
svn co http://code.victoryengine.org/svn/victory/trunk/engine .
If all is well, SVN will now start retrieving the latest version from our repository, and put it in the directory you just created.
If you use other SVN client software, such as TortoiseSVN, perform a "check out" of that url. How this works depends on the client.
Building the engine
Change your working directory to the directory you created above (you're probably already there). First, try building the engine.
ant
If all goes well, try exporting it to a jar file.
ant export
If that goes well too, you will find some .jar files in the export folder. These are the files that you should add to your project (not all of them, just the ones you need). Note that export also contains a folder called lib, the contents of which are used by the Victory engine and should be added to your project as well.
Generating documentation
To generate a HTML version of the API documentation, run:
ant javadoc
And the docs will be placed in a folder called doc
Cleaning
If at any time weird things happen when you try to build the engine after the first time, try cleaning:
ant clean
This will remove all automatically generated content.
Getting the new version
To get the latest version of the Victory engine, you don't need to perform the steps above again. Simply open a command terminal in the engine's root directory and run:
svn update
Then rerun Ant.
