Environment Setup

This page is about setting up your environment to run and make changes to the development version of Scelight locally on your computer. To contribute to the Scelight project, you should first read the Way of Contributions page.

Eclipse is the recommended IDE for developing Scelight as I provide Eclipse configuration, code templates and format styles. You may use other IDEs too if you wish so, but I give no support for them.

Once you have a Scelight clone in your computer, you can import it as an existing project into your Eclipse workspace.

Java 7 (JRE) is required to run Scelight. Java 7 (JDK) is required to generate developer Javadoc. You may use Java 8 or higher versions too, but the code must compile and run win Java 7 without issues.

In Eclipse, right click on the project => Properties -> Java Code Style => Code Templates. Import the eclipse/Icza-codetemplates.xml file.

In Eclipse, right click on the project => Properties -> Java Code Style => Formatter. Import the eclipse/Icza-format-style.xml file.

Note that you should always format your code (e.g. right click => Source => Format or CTRL+SHIFT+F to format current file) according to the formatting rules defined in eclipse/Icza-format-style.xml.

Also note that the Scelight project has strict rules about javadocs. Complete Javadoc is required for everywhere, for everything. You can view these in Properties => Java compiler => Javadoc. For example it will result in compile-time errors if

• javadoc is missing (even for private tags)
• the javadoc is malformed

Check out existing code in the Scelight repo for examples.

You can run Scelight by right clicking on Scelight.launch or Scelight-dev.launch files, then choose Run as. The latter one launches Scelight in developer mode, which also prints all log messages to the console too.