Skip to content
A p5.js library for games and playthings
JavaScript HTML CSS Other
Branch: master
Clone or download
Latest commit 42cd19c Dec 1, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples Correct friction values in asteroids example Nov 11, 2017
lib Warn and ignore extra parameters when creating a rectangle collider Dec 1, 2017
test Warn and ignore extra parameters when creating a rectangle collider Dec 1, 2017
theme Update yuidoc-lucid-theme Nov 3, 2016
.editorconfig Added .editorconfig and .gitignore Oct 2, 2015
.eslintrc.js Change space-before-function-paren setting. Mar 31, 2016
.gitattributes Add .gitattributes for 'npm test' to work on windows. Mar 31, 2016
.gitignore
.travis.yml Support npm-provided p5 in docs generation Nov 9, 2017
README.md Make 'npm run docs' a postinstall step. Apr 1, 2016
asterisk.png Beta upload Jun 24, 2015
bower.json add bower ignores Sep 8, 2015
index.html Add link to local docs in dev start page. Mar 14, 2016
license.txt Beta upload Jun 24, 2015
package.json Support npm-provided p5 in docs generation Nov 9, 2017
update-gh-pages.sh Support npm-provided p5 in docs generation Nov 9, 2017
yuidoc.json Eliminate more YUIDoc warnings Mar 14, 2016

README.md

Build Status

p5.play is a p5.js library for the creation of games and playthings.

You can find examples and more information at p5play.molleindustria.org.

p5.play provides a Sprite class to manage visual objects in 2D space and features such as animation support, basic collision detection and resolution, sprite grouping, helpers for mouse and keyboard interactions, and a virtual camera.

p5.play extends p5.js, a javascript library (and a community) that aims to make coding accessible for artists, designers, educators, and beginners. If you are not familiar with p5.js, you should start at p5js.org/tutorials.

Development

The following documentation is for developing p5.play itself. If you want to use p5.play, please see p5play.molleindustria.org.

Quick Start

First install node.js. Then run:

npm install
npm start

Your web browser should open to a welcome page. If it doesn't, visit localhost:8080 in your browser.

Unit Tests

To run the unit tests in your browser, visit localhost:8080/test.

To run them from the command-line, use npm test.

Documentation

The docs can be found at localhost:8080/docs or via the "Reference" link on the quick start welcome page.

Use npm run docs to regenerate the local documentation using YUIDoc.

A (mostly current) copy of the docs is also hosted at p5play.molleindustria.org/docs.

Examples

Several example sketches are available at p5play.molleindustria.org/examples.

You can try these examples against your local copy of p5.play at localhost:8080/examples or via the "Examples" link on the quick start welcome page.

You can’t perform that action at this time.