2008-04-20 13:02:22 -07:00
|
|
|
|
Steve Wadsworth (lizzardo on RomRaider forum)
|
|
|
|
|
|
|
|
|
|
This file is an attempt to consolidate available information on setting up, building,
|
2008-04-29 03:43:09 -07:00
|
|
|
|
and packaging RomRaider. All instructions assume a Windows environment and the use
|
|
|
|
|
of Eclipse for development. Apologies for the Windows-centricity, but some of the
|
|
|
|
|
tools inherited from the RomRaider project are Windows-based.
|
2008-04-20 13:02:22 -07:00
|
|
|
|
|
|
|
|
|
----------------------------------------------
|
|
|
|
|
Setting up the project (from romraider.com)
|
|
|
|
|
|
2008-04-29 03:43:09 -07:00
|
|
|
|
As an open source project, RomRaider depends on Java developers like you for
|
|
|
|
|
enhancements, bug fixes and general maintenance. This page is meant to be a
|
|
|
|
|
guide to setting up a development environment from scratch. The guide was
|
2008-04-20 13:02:22 -07:00
|
|
|
|
originally written by Tgui in this thread and has been adapted and revised.
|
|
|
|
|
|
2008-04-29 03:43:09 -07:00
|
|
|
|
RomRaider<EFBFBD>s official IDE is Eclipse. You are free to use any Java IDE you
|
|
|
|
|
choose, but due to the extremely simple process of setting up the environment
|
2008-04-20 13:02:22 -07:00
|
|
|
|
and the power of Eclipse, it<69>s probably your best choice.
|
|
|
|
|
|
|
|
|
|
* Installing Eclipse and Subclipse
|
|
|
|
|
o Install the latest version of the Java Development Kit
|
2011-09-23 13:35:10 -07:00
|
|
|
|
o Get and Install Eclipse JDT for your platform
|
2008-04-29 03:43:09 -07:00
|
|
|
|
o Install Subclipse for Subversion (SVN) integration, following the
|
2011-09-23 13:35:10 -07:00
|
|
|
|
steps outlined in #3 below.
|
2008-04-20 13:02:22 -07:00
|
|
|
|
* Setting up the RomRaider project
|
2008-04-29 03:43:09 -07:00
|
|
|
|
o Open the Java perspective in Eclipse by clicking
|
2008-04-20 13:02:22 -07:00
|
|
|
|
Window > Open Perspective > Java
|
|
|
|
|
o Right click in the package explorer and select <20>Import<72><74>
|
|
|
|
|
o Select <20>Checkout Projects from SVN<56> and click <20>Next<78>
|
|
|
|
|
o Select <20>Use a new repository location:<3A> and click <20>Next<78>
|
2008-04-29 03:43:09 -07:00
|
|
|
|
o Enter <20>https://svn2.assembla.com/svn/romraider<65> and click <20>Next<78>
|
2008-04-20 13:02:22 -07:00
|
|
|
|
o Highlight <20>trunk<6E> in the folder tree and click <20>Next<78>
|
2008-04-29 03:43:09 -07:00
|
|
|
|
o Name the project <20>romraider<65> and click <20>Finish<73>
|
2008-04-20 13:02:22 -07:00
|
|
|
|
|
2011-09-23 13:35:10 -07:00
|
|
|
|
* Setting the library path
|
|
|
|
|
o You may need to change the path to the Jars within your
|
|
|
|
|
libs dir (ex: Linux). See Note #1 below or you should read this
|
|
|
|
|
to set the Build Paths:
|
|
|
|
|
http://help.eclipse.org/indigo/topic/org.eclipse.jdt.doc.user/reference/ref-properties-build-path.htm
|
2008-04-20 13:02:22 -07:00
|
|
|
|
|
2011-09-23 13:35:10 -07:00
|
|
|
|
* Building the Project for the First Time
|
|
|
|
|
o First complete a build using ant. Right-click on build.xml and
|
|
|
|
|
select Run As -> 2 Ant build then select all in the targets tab.
|
|
|
|
|
More info in Note #4 below.
|
|
|
|
|
o When the build is finished (successfully I hope), Right-click on
|
|
|
|
|
the root romraider project and select Refresh. This should clear
|
|
|
|
|
all the errors and warnings you may have seen.
|
2008-04-20 13:02:22 -07:00
|
|
|
|
|
|
|
|
|
----------------------------------------------
|
|
|
|
|
|
2008-04-29 03:43:09 -07:00
|
|
|
|
Notes on the above:
|
2008-04-20 13:02:22 -07:00
|
|
|
|
|
|
|
|
|
1) Make sure the build path for the Java builder is set correctly. On the top menu:
|
|
|
|
|
|
|
|
|
|
Project -> Properties -> Java Build Path
|
|
|
|
|
|
|
|
|
|
On the Source tab, the default output folder should be set to
|
|
|
|
|
|
2008-04-29 03:43:09 -07:00
|
|
|
|
romraider/build/classes
|
2008-04-20 13:02:22 -07:00
|
|
|
|
|
|
|
|
|
2) The jars in the java build path mentioned above should be correct in the SVN
|
2011-09-23 13:35:10 -07:00
|
|
|
|
repository for a Windows environment.
|
2008-04-29 03:43:09 -07:00
|
|
|
|
|
|
|
|
|
3) A command line Subversion client needs to be installed and available in the default
|
2008-05-04 09:41:33 -07:00
|
|
|
|
path. To verify this, open a command prompt and run
|
|
|
|
|
|
|
|
|
|
svn info https://svn2.assembla.com/svn/romraider
|
|
|
|
|
|
|
|
|
|
You should get a response of the form
|
|
|
|
|
|
|
|
|
|
Path: romraider
|
|
|
|
|
URL: https://svn2.assembla.com/svn/romraider
|
|
|
|
|
Repository Root: https://svn2.assembla.com/svn/romraider
|
|
|
|
|
Repository UUID: 38686702-15cf-42e4-a595-3071df8bf5ea
|
|
|
|
|
Revision: 78
|
|
|
|
|
Node Kind: directory
|
|
|
|
|
Last Changed Author: kascade
|
|
|
|
|
Last Changed Rev: 78
|
|
|
|
|
Last Changed Date: 2008-05-02 15:50:23 -0700 (Fri, 02 May 2008)
|
|
|
|
|
|
|
|
|
|
If this does not work correctly, the ant build will fail.
|
2008-04-20 13:02:22 -07:00
|
|
|
|
|
2011-09-23 13:35:10 -07:00
|
|
|
|
4) The ant build file is in the main directory and uses the default name of
|
|
|
|
|
"build.xml".
|
|
|
|
|
|
|
|
|
|
The Java builder is set as the default. During development it's convenient to have
|
|
|
|
|
the "Problems" pane show warning and errors. The ant build does not send warnings
|
|
|
|
|
or errors there. The ant build is primarily for automation of the complete build
|
|
|
|
|
process for packaging.
|
|
|
|
|
|
|
|
|
|
To build using ant, right-click on the build.xml
|
|
|
|
|
file in the Package Explorer (Java perspective) and select
|
|
|
|
|
|
|
|
|
|
Run As -> 2 Ant build, then select "all" in the targets tab. To get more verbose
|
|
|
|
|
output from ant set the -v option in the arguments field on the Main tab.
|
|
|
|
|
|
|
|
|
|
The "help" target lists available targets with a brief description of each.
|
|
|
|
|
|
|
|
|
|
The "all" target does just that. It rebuilds everything, finishing with the installers.
|
2008-04-20 13:02:22 -07:00
|
|
|
|
|
2008-05-04 09:41:33 -07:00
|
|
|
|
|
2008-04-23 08:50:30 -07:00
|
|
|
|
|
|
|
|
|
|