Skip to content
This repository has been archived by the owner on May 8, 2018. It is now read-only.

spearwolf/picimo.old

Repository files navigation

picimo

Pictures in Motion

NEW: I started working on picimo's successor, version 2. It’s almost a full rewrite. See the new project page https://github.com/spearwolf/picimo-next

THIS REPOSITORY IS NO LONGER MAINTAINED.


picimo is a sprite engine for javascript running in a modern browser. it is built from scratch and exclusively utilizes webgl as rendering technology.

it is written in pure ES5 javascript (no transpilers are used) ES2016 using the babel transpiler.

it is, however, under active development and building a fantastic sprite engine together with an incredible easy-and-fun-to-use api is difficult to get correct. if you are comfortable with bleeding-edge software please try picimo and share your feedback.

have fun! ;-)

Table of Contents

Examples

Find examples of how to use this library in examples/. The examples/hello-world is a good starting point. Find more examples in spearwolf/picimo-examples/.

Setup local dev environment

Prerequisites

  • node 5.x (5.11 or higher)

Start local dev server

$ npm start

This will start a local http server, serves the application at http://localhost:8080/, watches for changes in and rebuilds all if changes are detected.

The api docs can be found here: http://localhost:8080/api-docs

The source docs can be found here: http://localhost:8080/esdoc

Build scripts overview

command description
npm run build:dev build the development version of picimo.js into build/
npm run build:release build the release version picimo.min.js
npm run api-docs generate the api docs into build/api-docs
npm run esdoc generate the source docs into build/esdoc
npm run release build the release version picimo.min.js and the api docs
npm run clean remove all build artifacts
npm start start a local http server and watch for changes