Processing Library Template

Github Pages Branch

This fork of the processing library template automatically publishes all documentation to the docs folder of the repository, so that you can use github pages to host the library.

About

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.

Import to Eclipse

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.

Option A: GitHub

1. Fork the template repository to use as a starting point.

• Navigate to https://github.com/processing/processing-library-template in your browser.
• Click the "Fork" button in the top-right of the page.
• Once your fork is ready, open the new repository's "Settings" by clicking the link in the menu bar on the right.
• Change the repository name to the name of your Library and save your changes.
• NOTE: GitHub only allows you to fork a project once. If you need to create multiple forks, you can follow these instructions.

1. Clone your new repository to your Eclipse workspace.

• Open Eclipse and select the File → Import... menu item.
• Select Git → Projects from Git, and click "Next >".
• Select "URI" and click "Next >".
• Enter your repository's clone URL in the "URI" field. The remaining fields in the "Location" and "Connection" groups will get automatically filled in.
• Enter your GitHub credentials in the "Authentication" group, and click "Next >".
• Select the master branch on the next screen, and click "Next >".
• The default settings on the "Local Configuration" screen should work fine, click "Next >".
• Make sure "Import existing projects" is selected, and click "Next >".
• Eclipse should find and select the processing-library-template automatically, click "Finish".

1. Rename your Eclipse project.

• In the Package Explorer, right-click (ctrl-click) on the folder icon of the processing-library-template project, and select Refactor → Rename... from the menu that pops up.
• Give the project the name of your Library, and click "OK".

Option B: Downloaded Package

1. Download the latest Eclipse template from here. Don't unzip the ZIP file yet.
2. Create a new Java project in Eclipse.

• From the menubar choose File → New → Java Project.
• Give the project the name of your Library.
• Click "Finish".

1. Import the template source files.

• Right-click (ctrl-click) onto the folder icon of your newly created project in the Package Explorer and select "Import..." from the menu that pops up.
• Select General → Archive File, and click "Next >".
• Navigate to the ZIP file you downloaded earlier in step 1, and click "Finish".

Set Up and Compile

1. Add Processing to the project build path.

• Open your project's "Properties" window.
• Under "Java Build Path", select the "Libraries" tab and then "Add External JARs...".
• Locate and add Processing's core.jar to your build path. It is recommended that a copy of core.jar is located in your Eclipse workspace in a libs folder. If the libs folder does not exist yet, create it. Read the section below regarding where to find the core.jar file.
• Confirm the setup with "OK".

1. Edit the Library properties.

• Open the resources folder inside of your Java project and double-click the build.properties file. You should see its contents in the Eclipse editor.
• Edit the properties file, making changes to items 1-4 so that the values and paths are properly set for your project to compile. A path can be relative or absolute.
• Make changes to items under 5. These are metadata used in the automatically generated HTML, README, and properties documents.

1. Compile your Library using Ant.

• From the menu bar, choose Window → Show View → Ant. A tab with the title "Ant" will pop up on the right side of your Eclipse editor.
• Drag the resources/build.xml file in there, and a new item "ProcessingLibs" will appear.
• Press the "Play" button inside the "Ant" tab.

1. BUILD SUCCESSFUL. The Library template will start to compile, control messages will appear in the console window, warnings can be ignored. When finished it should say BUILD SUCCESSFUL. Congratulations, you are set and you can start writing your own Library by making changes to the source code in folder src.
2. BUILD FAILED. In case the compile process fails, check the output in the console which will give you a closer idea of what went wrong. Errors may have been caused by

• Incorrect path settings in the build.properties file.
• Error "Javadoc failed". if you are on Windows, make sure you are using a JDK instead of a JRE in order to be able to create the Javadoc for your Library. JRE does not come with the Javadoc application, but it is required to create Libraries from this template.

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.

Source code

If you want to share your Library's source code, we recommend using an online repository available for free at GitHub.

Adding core.jar and other .jar files to your classpath

The 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.

The 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 opengl.jar file.

What is the difference between JDK and JRE?

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.

The JRE System Library

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:

1. Open the properties of your project from the menu Project → Properties. Select "Java Build Path" and in its submenu, click on the "Libraries" tab.
2. A list of JARs and class folders in the build path will show up. In this list you can find the JRE System Library that is used to compile your code. Remove this JRE System library.
3. Click "Add Library...". In the popup window, choose "JRE System Library" and press "Next".
4. Select an alternate JRE from the pull-down menu or click and modify the "Installed JREs". Confirm with "Finish" and "OK".

Compiling with Ant and javadoc

Ant is a Java-based build tool. For more information visit the Ant web site. Ant uses a file named build.xml to store build settings for a 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.