Have ideas to improve npm?Join in the discussion! »

    sandpit

    0.0.16 • Public • Published

    ⛱ Sandpit

    A playground for creative coding using JavaScript and the canvas element.

    npm install sandpit --save

    npm Build Status

    NOTE: Sandpit is really new, and so the API is likely to change between now and 1.0. Help shape it by leaving issues and suggestions here. You are the best.

    An example animation of Sandpit

    Built in ES6, Sandpit uses dat.GUI to manage settings and encourages copy and paste sharing of ideas. It features a bunch of helpers so you can get straight down to coding.


    Getting Started

    Add Sandpit to your project:

    npm install sandpit --save

    Or if you're into Yarn, that works too:

    yarn add sandpit

    In your app, add:

    import Sandpit from 'sandpit' // for es6
    var Sandpit = require('sandpit') // for es5

    Celebrate. You are a success.

    Setting up a new project

    If you're looking for a quick way to set up a sandpit with an ES6 friendly enviornment, you can use create-react-app:

    npm install create-react-app -g
    create-react-app party
    cd party
    npm install sandpit --save
    npm start

    Then replace src/index.js with:

    import Sandpit from 'sandpit'
     
    var sandpit = new Sandpit('body', Sandpit.CANVAS)
    sandpit.settings = {youAreGreat: {value: true}}
    sandpit.loop = () => { console.log(sandpit.time) }
    sandpit.start()

    You can grab an example from https://github.com/superhighfives/sandpit-demo.

    Sticking with the script tag

    Alternatively, you can use the latest Sandpit version in the browser, which is useful for Codepen and the like.

    <script src="https://sandpitjs.com/lib/sandpit.min.js"></script>
    <script>var sandpit = new Sandpit('body', Sandpit.CANVAS)</script>

    You can see it in action using ES6, and ES5.

    Browser support

    Currently Sandpit targets modern browsers, including IE11 and Edge, and uses babel-polyfill when compiled for ES5.

    Why use Sandpit?

    The goal of Sandpit is to normalise and simplify the process of creating coding—using code to make pretty things. This usually takes the form of drawing onto the Canvas element, in either a 2d or 3d context. It has resulted in a ton of tools, from Processing.js to Three.js, and an incredible community of people who have pushed the bar of what can be done on the web.

    Sandpit supports a bunch of key features that aim to simplify creative coding. Specifically, helps with the following:

    • Manages inputs, like touches, taps, clicks, force and the accelerometer, and takes care of touch event handling for multitouch on mobile so you don't have to worry about pinch to zoom
    • Makes it easy to drop in settings, with a simple API for specifying ranges, types and defaults (with dat.GUI behind the scenes)
    • Stores settings in the query string, so you can copy and paste them without needing to touch a line of code
    • Offers a bunch of helpers, covering maths, color and vector manipulation (kudos to color and Victor)
    • Supports bringing your own canvas—for example, to simplify using Three

    Demos and examples

    Some examples of Sandpit in action

    There are a bunch of examples at https://sandpitjs.com, the source for which can be found at https://github.com/superhighfives/sandpit/tree/master/src/demos.

    Documentation

    Look no further—here's documentation of the full API.

    Want to contribute?

    You 100% should. You can find out more about contributing here.

    Who's behind it?

    Install

    npm i [email protected]

    Version

    0.0.16

    License

    MIT

    Last publish

    Collaborators

    • avatar