Creating a Development Environment

You need the following to modify and build ShootOFF's code:

• Git to fetch the latest version of the source code and manage your changes
• An IDE or text editor to modify source code files
• If you are using Eclipse, import our formatter.xml for source code formatting
• If you are using Eclipse, we recommend you install e(fx)clipse to get better integration with JavaFX, which we use for ShootOFF's GUI
• Oracle's JDK 8 or the latest OpenJDK and OpenJFX (Oracle's JDK is much easier to install) for environmental dependencies
• Gradle to build, package, and deploy the project using the JDK
• OPTIONAL We recommend you download and install Scene Builder if you intend to edit ShootOFF's GUI. Our GUI uses JavaFX's fxml format

Eclipse is our IDE of choice for developing and debugging code. However, at this time NetBeans has the only viable profiler that works with Java 8 and JavaFX code.

We strongly recommend that you always use the most recent version of Eclipse and Gradle when working with ShootOFF's code. The latest version of Eclipse is important because source code formatting can be inconsistent across Eclipse versions (particularly between major version numbers). If, for example, you are using Eclipse Juno and we are using Eclipse Mars, you will get different formatting results even with the same formatting profile we use. This will cause a lot of really annoying conflicts when you go to commit your changes. There are much fewer concerns with using older versions of Gradle, but the newer versions tend to be much faster.

Ubuntu Instructions

This is a quick rundown of building on Ubuntu.

Install java 8

sudo add-apt-repository ppa:webupd8team/java
sudo apt-get update
sudo apt-get install oracle-java8-installer
sudo apt-get install oracle-java8-set-default

Download e(fx)clipse and extract it

Download ShootOFF

git clone https://github.com/phrack/ShootOFF.git

Install gradle

sudo apt-get install gradle

In the ShootOFF directory, build the eclipse project

gradle eclipse

Import the project into Eclipse using Import -> Existing Projects into Workspace

You can now run or debug ShootOFF in eclipse