search

b-g / processing-sublime

A Sublime Text package for the programming language Processing
MIT License
447 stars 60 forks source link
processing processing-sketch sublime-package sublime-text

readme

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.

Use external editor preference

This package assumes that you chose to install processing-java for all users (recommended). If you choose to install processing-java only in your home directory, then you have to slightly change the build script, see the comment in the file Processing.sublime-build.

Linux

You will need to set your PATH to where your processing application is located, e.g.: export PATH=$PATH:/opt/processing/processing-2.0b4

You also need to create an alias for processing-java in /bin/ instead of /usr/bin/, e.g.: sudo ln -s /opt/processing/processing-java /bin/processing-java

Windows

You will need to set your PATH environment variable to where your processing application is located:

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

Advanced System Settings > Environment Variables

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

Go to your Sublime Text Packages directory and clone this repository: git clone https://github.com/b-g/processing-sublime/ Processing

Download Manually

Usage

Custom Shortcuts

To get .pde files to run with ⌘R and ⇧⌘R (like Processing) instead of ⌘B and ⇧⌘B, add the following code to the User Key Bindings file via the Preferences > Key Bindings - User menu item in Sublime Text.

{
  "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 to jump to the related line and file.

Filenames of Sketches

Your filenames have to follow specific rules, otherwise they won't work with processing-java:

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. You know this is right when you can open a terminal, run ant, and see a Build failed message. This means that ant is runnable, and failing is ok because there is no "Buildfile."

Make sure that the variable DEFAULT_PROCESSING_LIBRARY_PATH within the file Processing.py inside this package matches your installation of Processing. If you are on OS X and Processing.app is in the Applications directory, then you do not need to edit this. Despite this, OS X users may need to install the Fix Mac Path package, due to the way Sublime manages environment variables such as 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 and draw, add additional classes to your sketch, and run it with ⌘B. Just be sure that Ant is the active build system.

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

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