Search RomRaider

RomRaider

Documentation

Community

Developers



  • View Page
  • Page History/Versions
  • Print Page

Getting Started

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 originally written by Tgui and has been adapted and revised for the reflect the current source control system.

RomRaider’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 and the power of Eclipse, it’s probably your best choice.

  • Installing the Java Development Kit and Eclipse
    • Install the latest version of the 32bit Java SE 6 Development Kit, DO NOT use the 64bit JDK version!
    • Get and install ‘Eclipse IDE for Java Developers’ 32bit for your specific platform. The Java EE version will work too but there are subtle differences (noted below).
    • Set the JAVA_HOME environment variable for your Operating System to point to the JDK installation directory. i.e.: For Windows 32bit, JAVA_HOME=C:\Program Files\Java\jdk1.6.0_45
    • If you choose to use the latest 32bit JDK version you still need to install the rt.jar for Java 6 and set the -bootclasspath option to cross-compile down to Java 6 code. Ref: Cross-Compilation Example
  • Setting up the RomRaider project
    • If you use the Java EE version you may need to install the Git plug in, or you can use the non integrated command line Git tools outside of Eclipse (while Eclipse is not running of course).
    • If you have Java EE and wish to install the Git plugin, open Help > Eclipse Marketplace, Search for ‘EGit’ (name of the plug in), select it, Install, and restart Eclipse
    • Open the Git perspective in Eclipse by clicking Window > Open Perspective > Other > Git Repository Exploring
    • Press the Clone Git Repository button
    • In the window the pops up paste in the repository URL: “https://github.com/RomRaider/RomRaider.git
    • Click “Next”
    • In the branches window click “Deselect All”, then scroll to the bottom and select “master”, click “Next”
    • Enter a directory path on your computer to store the repository in. Do Not save it in the Eclipse workspace directory.
    • Click “Finish”
    • After the repository has been copied to your system it will appear in the left pane of Eclipse, Git Repositories.
    • Right-click on the repository entry and select “Import Projects”.
    • Click “Next” and select “Finish”.
    • To switch to the Java view, open the Java perspective by clicking Window > Open Perspective > Java
  • Setting the library path
  • Building the Project for the First Time
    • First complete a build using ant. Right-click on build.xml and select Run As → 2 Ant build (this may appear as item 3 in the Java EE version). Switch to the targets tab. Select only the target ‘all’, then click Run.
    • 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 decorations you may have seen on some files.
    • Additional information can be found in the Building_RomRaider.txt file in the repository.
    • The built files are stored in the repository’s build directory: RomRaider\build\dist
    • Install the build of your choosing and enjoy RomRaider.
  • Setup EGit
    • Ensure you have configured your user settings in Eclipse under menu Window > Preferences > Team > Git > Configuration > User Settings, add entries for user.name and user.email
    • Switch to the Repository Settings tab. Under the RomRaider repository Add Entry core.autocrlf with a value of false (this ensures Linux scripts don’t get CRLF conversions performed on them, which breaks them)
    • Switch to the Repository Settings tab and Add Entry branch.master.rebase with a value of true
    • The EGit reference can be found here and a Git command x-ref here.

Here is a thread on RomRaider repository history.





RomRaider Forums

Join our forums, the best place to find help and answers!







RomRaider is developed and supported by volunteers working on their own time. To support their efforts please consider making a donation.





Page last modified on October 28, 2016, at 05:06 PM
Powered by PmWiki