piskel/README.md

Piskel
======

[![Travis Status](https://api.travis-ci.org/juliandescottes/piskel.png?branch=master)](https://travis-ci.org/juliandescottes/piskel) [![Built with Grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/)

A simple web-based tool for Spriting and Pixel art.

![Piskel editor screenshot](https://screenletstore.appspot.com/img/8f03e768-ac59-11e3-b2a1-7f5a1b97c420.jpeg "Piskel editor screenshot")

You can try the standalone editor at **http://juliandescottes.github.io/piskel** or see it integrated in **http://piskelapp.com**.

Piskel is mainly developped by :

* **[@juliandescottes](https://github.com/juliandescottes)**
* **[@grosbouddha](https://github.com/grosbouddha)**

## What's the point ?

You can use Piskel to do two things :
* **spriting** : create retro-style sprites for games

![Megaman spritesheet](http://piskel-imgstore-a.appspot.com/img/c8081287-ac58-11e3-bd8c-b3c4036c0eee.png "Megaman spritesheet")

* **pixelart** : create crazy/pretty pixelart animations for fun !

![Rabbit jumping](http://piskel-imgstore-a.appspot.com/img/947f2dab-ac58-11e3-949a-b3c4036c0eee.gif "Rabit jumping")

Integrated in **[piskelapp.com](http://piskelapp.com)**, you can share everything you work on with others as easily as you share a link.

## Requirements

Piskel supports the following browsers :
* **Chrome** (latest)
* **Firefox** (latest)
* **Internet Explorer** 10+

... and a fairly recent computer.

We don't plan/want/could be forced into supporting older IEs. For Opera and Safari, we've never tested them but the gap shouldn't be huge.

## Offline version (Windows and MacOS)

Offline builds are available. More details in the [dedicated wiki page](https://github.com/juliandescottes/piskel/wiki/Desktop-applications).

## Built with

The Piskel editor is purely built in **JavaScript, HTML and CSS**. It uses Canvas extensively for displaying all them pretty sprites.

We also use the following **libraries** :
* [spectrum](https://github.com/bgrins/spectrum) : awesome standalone colorpicker
* [gifjs](http://jnordberg.github.io/gif.js/) : generate animated GIFs in javascript, using webworkers
* [jszip](https://github.com/Stuk/jszip) : create, read and edit .zip files with Javascript
* [canvas-toBlob](https://github.com/eligrey/canvas-toBlob.js/) : shim for canvas toBlob
* [jquery](http://jquery.com/) : used sporadically in the application
* [bootstrap-tooltip](http://getbootstrap.com/javascript/#tooltips) : nice tooltips

As well as some **icons** from the [Noun Project](http://thenounproject.com/) :
* Folder by Simple Icons from The Noun Project
* (and probably one or two others)


## Contributing ?

Help is always welcome !

* **Issues** : Found a problem when using the application, want to request a feature, [open an issue](https://github.com/juliandescottes/piskel/issues).
* **Participate** : Have a look at the [wiki](https://github.com/juliandescottes/piskel/wiki) to set up the development environment

## Licensing

Probably need to pick one at some point ... Until then it's a "do whatever you want with it" license.

## Mobile/Tablets

There is no support for mobile for now.
Update README.md 2012-08-23 05:46:07 +00:00			`Piskel`
Initial commit 2012-08-22 22:53:24 +00:00			`======`

More cosmetic changes to README.MD ! 2014-06-14 13:04:18 +00:00			`[![Travis Status](https://api.travis-ci.org/juliandescottes/piskel.png?branch=master)](https://travis-ci.org/juliandescottes/piskel) [![Built with Grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/)`
Add travis build status to README.cmd 2014-06-14 13:03:01 +00:00
Cleanup README.md Removed old screenshots, added actual information about the project ! 2014-03-15 15:59:16 +00:00			`A simple web-based tool for Spriting and Pixel art.`
Update README.md 2012-08-23 05:46:07 +00:00
Cleanup README.md Removed old screenshots, added actual information about the project ! 2014-03-15 15:59:16 +00:00			`![Piskel editor screenshot](https://screenletstore.appspot.com/img/8f03e768-ac59-11e3-b2a1-7f5a1b97c420.jpeg "Piskel editor screenshot")`
Update README.md 2012-08-27 23:18:56 +00:00
Cleanup README.md Removed old screenshots, added actual information about the project ! 2014-03-15 15:59:16 +00:00			`You can try the standalone editor at http://juliandescottes.github.io/piskel or see it integrated in http://piskelapp.com.`
Update README.md 2013-05-29 21:11:26 +00:00
Cleanup README.md Removed old screenshots, added actual information about the project ! 2014-03-15 15:59:16 +00:00			`Piskel is mainly developped by :`
Update README.md 2013-05-29 21:11:26 +00:00
Cleanup README.md Removed old screenshots, added actual information about the project ! 2014-03-15 15:59:16 +00:00			`* [@juliandescottes](https://github.com/juliandescottes)`
			`* [@grosbouddha](https://github.com/grosbouddha)`
Update README.md 2013-05-29 21:11:26 +00:00
Cleanup README.md Removed old screenshots, added actual information about the project ! 2014-03-15 15:59:16 +00:00			`## What's the point ?`
Update README.md 2012-09-16 14:04:40 +00:00
Cleanup README.md Removed old screenshots, added actual information about the project ! 2014-03-15 15:59:16 +00:00			`You can use Piskel to do two things :`
Update README.md 2014-03-15 16:00:11 +00:00			`* spriting : create retro-style sprites for games`
Update README.md 2012-09-16 14:04:40 +00:00
Cleanup README.md Removed old screenshots, added actual information about the project ! 2014-03-15 15:59:16 +00:00			`![Megaman spritesheet](http://piskel-imgstore-a.appspot.com/img/c8081287-ac58-11e3-bd8c-b3c4036c0eee.png "Megaman spritesheet")`
Update README.md 2012-09-15 21:37:08 +00:00
Update README.md 2014-03-15 16:00:11 +00:00			`* pixelart : create crazy/pretty pixelart animations for fun !`
Update README.md 2012-09-15 21:37:08 +00:00
Cleanup README.md Removed old screenshots, added actual information about the project ! 2014-03-15 15:59:16 +00:00			`![Rabbit jumping](http://piskel-imgstore-a.appspot.com/img/947f2dab-ac58-11e3-949a-b3c4036c0eee.gif "Rabit jumping")`
Update README.md 2012-09-15 21:37:08 +00:00
Cleanup README.md Removed old screenshots, added actual information about the project ! 2014-03-15 15:59:16 +00:00			`Integrated in [piskelapp.com](http://piskelapp.com), you can share everything you work on with others as easily as you share a link.`
Update README.md 2012-08-30 10:18:57 +00:00
Cleanup README.md Removed old screenshots, added actual information about the project ! 2014-03-15 15:59:16 +00:00			`## Requirements`
Update README.md 2012-08-30 10:18:57 +00:00
Cleanup README.md Removed old screenshots, added actual information about the project ! 2014-03-15 15:59:16 +00:00			`Piskel supports the following browsers :`
			`* Chrome (latest)`
			`* Firefox (latest)`
Updating README.md 2014-03-16 20:25:20 +00:00			`* Internet Explorer 10+`
Update README.md 2012-08-30 10:18:57 +00:00
Updating README.md 2014-03-16 20:25:20 +00:00			`... and a fairly recent computer.`
Update README.md 2012-08-27 23:18:56 +00:00
Updating README.md 2014-03-16 20:25:20 +00:00			`We don't plan/want/could be forced into supporting older IEs. For Opera and Safari, we've never tested them but the gap shouldn't be huge.`
Update README.md 2012-08-23 05:46:07 +00:00
Update README.md 2014-08-17 18:42:38 +00:00			`## Offline version (Windows and MacOS)`

			`Offline builds are available. More details in the [dedicated wiki page](https://github.com/juliandescottes/piskel/wiki/Desktop-applications).`

Cleanup README.md Removed old screenshots, added actual information about the project ! 2014-03-15 15:59:16 +00:00			`## Built with`
Update README.md 2012-08-23 05:46:07 +00:00
Updating README.md 2014-03-16 21:09:48 +00:00			`The Piskel editor is purely built in JavaScript, HTML and CSS. It uses Canvas extensively for displaying all them pretty sprites.`
Cleanup README.md Removed old screenshots, added actual information about the project ! 2014-03-15 15:59:16 +00:00
			`We also use the following libraries :`
Updating README.md 2014-03-16 20:25:20 +00:00			`* [spectrum](https://github.com/bgrins/spectrum) : awesome standalone colorpicker`
Cleanup README.md Removed old screenshots, added actual information about the project ! 2014-03-15 15:59:16 +00:00			`* [gifjs](http://jnordberg.github.io/gif.js/) : generate animated GIFs in javascript, using webworkers`
Update README.md 2014-04-10 23:14:07 +00:00			`* [jszip](https://github.com/Stuk/jszip) : create, read and edit .zip files with Javascript`
			`* [canvas-toBlob](https://github.com/eligrey/canvas-toBlob.js/) : shim for canvas toBlob`
Cleanup README.md Removed old screenshots, added actual information about the project ! 2014-03-15 15:59:16 +00:00			`* [jquery](http://jquery.com/) : used sporadically in the application`
			`* [bootstrap-tooltip](http://getbootstrap.com/javascript/#tooltips) : nice tooltips`

			`As well as some icons from the [Noun Project](http://thenounproject.com/) :`
			`* Folder by Simple Icons from The Noun Project`
			`* (and probably one or two others)`


Updating README.md 2014-03-16 20:25:20 +00:00			`## Contributing ?`
Cleanup README.md Removed old screenshots, added actual information about the project ! 2014-03-15 15:59:16 +00:00
			`Help is always welcome !`

Updating README.md 2014-03-16 20:25:20 +00:00			`* Issues : Found a problem when using the application, want to request a feature, [open an issue](https://github.com/juliandescottes/piskel/issues).`
Cleanup README.md Removed old screenshots, added actual information about the project ! 2014-03-15 15:59:16 +00:00			`* Participate : Have a look at the [wiki](https://github.com/juliandescottes/piskel/wiki) to set up the development environment`

			`## Licensing`

			`Probably need to pick one at some point ... Until then it's a "do whatever you want with it" license.`

			`## Mobile/Tablets`

			`There is no support for mobile for now.`
Update README.md 2012-08-23 05:51:42 +00:00