|xSlendiX 7aa73a3395||7 months ago|
|.github||1 year ago|
|data||6 years ago|
|examples||6 years ago|
|lib||6 years ago|
|resources||7 months ago|
|src/xyz/xslendi/uiutils||7 months ago|
|web||6 years ago|
|.classpath||7 months ago|
|.gitignore||7 years ago|
|.project||7 months ago|
|README.md||5 years ago|
|license.txt||3 years ago|
The following describes how to set up a Processing Library project in Eclipse and build it successfully, and to make your Library ready for distribution.
There are two options to import the template project into Eclipse: using a Git fork or using a downloaded package. If you are not familiar with Git or GitHub, you should opt for the downloaded package.
masterbranch on the next screen, and click "Next >".
processing-library-templateautomatically, click "Finish".
processing-library-templateproject, and select Refactor → Rename... from the menu that pops up.
core.jarto your build path. It is recommended that a copy of
core.jaris located in your Eclipse workspace in a
libsfolder. If the
libsfolder does not exist yet, create it. Read the section below regarding where to find the
resourcesfolder inside of your Java project and double-click the
build.propertiesfile. You should see its contents in the Eclipse editor.
resources/build.xmlfile in there, and a new item "ProcessingLibs" will appear.
After having compiled and built your project successfully, you should be able to find your Library in Processing's sketchbook folder, examples will be listed in Processing's sketchbook menu. Files that have been created for the distribution of the Library are located in your Eclipse's
workspace/yourProject/distribution folder. In there you will also find the
web folder which contains the documentation, a ZIP file for downloading your Library, a folder with examples as well as the
index.html and CSS file.
To distribute your Library please refer to the Library Guidelines.
If you want to share your Library's source code, we recommend using an online repository available for free at GitHub.
core.jar file contains the core classes of Processing and has to be part of your classpath when building a Library. On Windows and Linux, this file is located in the Processing distribution folder inside a folder named
lib. On Mac OS X, right-click the Processing.app and use "Show Package Contents" to see the guts. The
core.jar file is inside Contents → Resources → Java. For further information about the classes in
core.jar, you can see the source here and the developer documentation here.
If you created a
libs folder as described above, put the libraries you need to add to your classpath in there. In the "Properties" of your Java project, navigate to Java Build Path → Libraries, and click "Add External JARs...". Select the
.jar files from the
libs folder that are required for compiling your project. Adjust the
build.xml file accordingly.
libs folder is recommended but not a requirement, nevertheless you need to specify where your
.jar files are located in your system in order to add them to the classpath.
In case a Library depends on system libraries, put these dependencies next to the
.jar file. For example, Processing's
opengl.jar Library depends on JOGL hence the DLLs (for Windows) or jnilibs (for OS X) have to be located next to the
JDK stands for Java Development Kit whereas JRE stands for Java Runtime Environment. For developers it is recommended to work with a JDK instead of a JRE since more Java development related applications such as Javadoc are included. Javadoc is a requirement to properly compile and document a Processing Library as described on the guidelines page.
You can have both a JDK and a JRE installed on your system. In Eclipse you need to specify which one you want to use.
This primarily affects Windows and Linux users (because the full JDK is installed by default on Mac OS X). It is recommended that you use the JDK instead of a JRE. The JDK can be downloaded from Oracle's download site. Also see the Java Platform Installation page, which contains useful information.
To change the JRE used to compile your Java project:
Javadoc is an application that creates an HTML-based API documentation of Java code. You can check for its existence by typing
javadoc on the command line. On Mac OS X, it is installed by default. On Windows and Linux, installing the JDK will also install the Javadoc tool.