Introduction

Most developers won't need to edit the PulpCore code itself: the distribution includes pre-built binaries, and nightly builds are available. But if you need to edit the code for debugging, or you just want to contribute some code, this document will help you get started.

Requirements

An SVN client (to download the code).
The JDK 1.4 runtime jar (to make sure PulpCore runs on Java 1.4).
JDK 1.5 or newer (To build the PulpCore tools).
Retroweaver 2.0.5
SVG Salamander
Apache Ant 1.7 (included in most IDEs)
Java Pack200 Ant Task

Optional

ProGuard 3.10
JUnit 4.3 or newer.
Mozilla Rhino (for running JSLint on pulpcore.js).

Get the code from SVN

The previous version 0.10 has it's own branch, and can be acquired with this command:

svn checkout http://pulpcore.googlecode.com/svn/branches/0.10/ pulpcore-read-only

The more stable version 0.11 is in the trunk and can be acquired with this command:

svn checkout http://pulpcore.googlecode.com/svn/trunk/ pulpcore-read-only

See http://code.google.com/p/pulpcore/source for details.

Building

Edit the build.properties file with the local paths on your system.
Run the "build" task with Ant.

If you get an OutOfMemoryError, set the ANT_OPTS environment variable to increase the maximum heap space.

Most Unix shells:

export ANT_OPTS=-Xmx256m

Windows:

set ANT_OPTS=-Xmx256m

Submitting Patches

Currently there is no formal way to submit patches, but for now:

Submit an issue (and attach your diff). It will show up on the Discussion Group, too.
Or, send me email.

Comment by stencyl, Nov 27, 2008

If you're running Ant from within Eclipse, this helps get around the OutOfMemory? issue too.

1) Go to Open External Tools Dialog and locate the pulpcore build task. 2) Go to the JRE tab 3) Make sure you're executing in a separate JRE. 4) Click on Installed JRE's... 5) Click on the JRE you want to use and click Edit... 6) For "Default VM Arguments", add the following line to increase the heap size for the VM.

-Xms768m -Xmx1024m -XX:MaxPermSize?=512m

You may need to adjust this to fit your needs, but this worked out of the box for me.

The original source for this tip was from: http://soenkerohde.com/2008/06/change-eclipse-ant-settings-when-you-run-out-of-memory/

Comment by dazappa.matt, Dec 24, 2008

TIP: On Windows I had to make all of the backslashes double backslashes for it to work. Do this with every line if something doesn't seem right. Ex: library.path=C:\\Program Files\\Java\\jdk1.5.0\\jre\\lib\\rt.jar