Processing Package for Sublime Text

A Processing package for Sublime Text 2 and 3. Check the demo video on vimeo! Please note: you must have at least (>=Processing 2.0b6), otherwise the build system of the this package won't work. The video is a bit outdated, you don't have to run any longer the Processing.app in parallel to run sketches. If you have to use an old Processing version (e.g. 1.5.1), you can use version 1.0 of this package.

Preparations

OSX

Use Processing's Tools > Install "processing-java" menu item after you have installed Processing.

This package assumes that you chose to install

processing-java

processing-java

Linux

You will need to set your

PATH

export PATH=$PATH:/opt/processing/processing-2.0b4

You also need to create an alias for

processing-java

/bin/

/usr/bin/

sudo ln -s /opt/processing/processing-java /bin/processing-java

Windows

You will need to set your

PATH

• Open the "Advanced System Settings" by running

  sysdm.cpl

• In the "System Properties" window, click on the Advanced tab.
• In the "Advanced" section, click the Environment Variables button.
• Edit the "Path" variable. Append the processing path (e.g.

  ;C:\Program Files\Processing-2.0b6\

  ) to the variable value. Each entry is separated with a semicolon.

Or, write a separate build system as documented in this comment.

Installation

There are three easy ways to install the Processing package:

Using Sublime Package Control

If you are using Sublime Package Control, you can easily install the Processing Package via the Sublime Text > Preferences > Package Control: Install Package menu item.

Using Git

Alternatively you can install the package and keep up to date by cloning the repo directly into your Sublime Text

Packages

Go to your Sublime Text

Packages

git clone https://github.com/b-g/processing-sublime/ Processing

Download Manually

• Download the files using the GitHub .zip download option.
• Unzip the file and rename the directory to

  Processing

  .
• Copy the directory to your Sublime Text

  Packages

  directory e.g. OS X:

  ~/Library/Application Support/Sublime Text 2/Packages/Processing

  .

Usage

• Open the directory containing a Processing sketch in Sublime Text. (e.g. Drag the folder to Sublime Text.)
• In Sublime Text, select the Tools > Build System > Processing menu item.
• In Sublime Text, select your main

  .pde

  file and use ⌘B to run the sketch. The build system expects that your sketch follows the normal directory structure and naming conventions of a Processing sketch (e.g.

  mysketch/mysketch.pde

  ).
• With ⇧⌘B and typing

  build

  , you can select alternative build systems, such as Run sketch fullscreen and various Export sketch options.

Custom Shortcuts

To get

.pde

{
  "keys": ["super+r"], "command": "build",
  "context": [{ "key": "selector", "operator": "equal", "operand": "source.pde" }]
},
{
  "keys": ["super+shift+r"], "command": "build",
    "args": {"variant": "Run sketch fullscreen"},
    "context": [{ "key": "selector", "operator": "equal", "operand": "source.pde" }]
}

Console Errors

Console error messages are clickable: e.g. double click

test.pde:10:0:10:0: The function rEEct(int, int, int, int) does not exist

Filenames of Sketches

Your filenames have to follow specific rules, otherwise they won't work with

processing-java

• must not contain dashes

  -

  (see processing/processing#4861)
• must not start with a number

  0123456789

  (see processing/processing#2152)
• must not start with an underscore

  _

  (see processing/processing#2152)
• must adhere to Java class naming rules (see stackoverflow discussion for the gist of it)

Want a "Pure Java" Project without Eclipse?

Complex projects often lead people into using Processing with Eclipse. If you want to stick with Sublime Text, but want a "pure Java" Processing project and the convenience of a fast "build and run" workflow, try creating a project with the New Java Ant Project command (see issue 61) and run your sketch with the Ant build system.

Prerequisites

Be sure that ant is installed and on your environment's

PATH

ant

Build failed

Make sure that the variable

DEFAULT_PROCESSING_LIBRARY_PATH

Processing.py

Processing.app

Applications

PATH

Using the Command

1. Create an empty directory (folder) for your new project, and open that empty directory in Sublime.
2. Use either the menu item Tools > Processing > New Java Ant Project or select the Processing: New Java Ant Project command from the command pallete (⇧⌘P).
3. Specify a Java package name for your source code (e.g.

   com.myorg.myapp

   ).
4. Use the Tools > Build System > Ant menu item to ensure that Ant is the active build system.
5. Use ⌘B to build and run your sketch. Out of the box, you should see a full screen app that displays the default 200x200px gray sketch, which is the Processing default.

You can now implement

setup

draw

Getting Started with Sublime Text

If you are new to Sublime I recommend the Perfect Workflow in Sublime Text tutorial. If you are short of time, then make sure to at least watch Multiple Cursors and Incremental Search (~6min), highly recommended!

Acknowledgements

• Original Processing TextMate Bundle: Leon Hong
• Textmate to Sublime snippet conversion: textmate-to-sublime-converter
• Maintainer: Benedikt Groß, Yong Joseph Bakos
• Syntax highlighting tweaking: Mark Brand
• Linux build script and testing: Julien Deswaef
• Windows build script and documention: Ralf Baecker
• Error console capturer: Greger Stolt Nilsen
• Syntax definition, snippet cleansing, Processing reference vs. sublime diff tool, and New Java Ant Project command: Yong Joseph Bakos
• How to set custom shortcuts: Raphaël de Courville
• Rebuild of the processing syntax highlighter: Kyle Fleming
• Filenames rules of sketches: MaxValue

See the contributing guide to learn about how to contribute to this project.