piskel/README.md

89 lines
3.7 KiB
Markdown
Raw Normal View History

2012-08-23 09:46:07 +04:00
Piskel
2012-08-23 02:53:24 +04:00
======
2014-06-14 17:04:18 +04: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/)
2014-06-14 17:03:01 +04:00
A simple web-based tool for Spriting and Pixel art.
2012-08-23 09:46:07 +04:00
![Piskel editor screenshot](https://screenletstore.appspot.com/img/8f03e768-ac59-11e3-b2a1-7f5a1b97c420.jpeg "Piskel editor screenshot")
2012-08-28 03:18:56 +04:00
You can try the standalone editor at **http://juliandescottes.github.io/piskel** or see it integrated in **http://piskelapp.com**.
2013-05-30 01:11:26 +04:00
Piskel is mainly developped by :
2013-05-30 01:11:26 +04:00
* **[@juliandescottes](https://github.com/juliandescottes)**
* **[@grosbouddha](https://github.com/grosbouddha)**
2013-05-30 01:11:26 +04:00
## What's the point ?
2012-09-16 18:04:40 +04:00
You can use Piskel to do two things :
2014-03-15 20:00:11 +04:00
* **spriting** : create retro-style sprites for games
2012-09-16 18:04:40 +04:00
![Megaman spritesheet](http://piskel-imgstore-a.appspot.com/img/c8081287-ac58-11e3-bd8c-b3c4036c0eee.png "Megaman spritesheet")
2012-09-16 01:37:08 +04:00
2014-03-15 20:00:11 +04:00
* **pixelart** : create crazy/pretty pixelart animations for fun !
2012-09-16 01:37:08 +04:00
![Rabbit jumping](http://piskel-imgstore-a.appspot.com/img/947f2dab-ac58-11e3-949a-b3c4036c0eee.gif "Rabit jumping")
2012-09-16 01:37:08 +04:00
Integrated in **[piskelapp.com](http://piskelapp.com)**, you can share everything you work on with others as easily as you share a link.
2012-08-30 14:18:57 +04:00
## Requirements
2012-08-30 14:18:57 +04:00
Piskel supports the following browsers :
* **Chrome** (latest)
* **Firefox** (latest)
2014-11-26 10:55:53 +03:00
* **Internet Explorer** 11+
2012-08-30 14:18:57 +04:00
2014-03-17 00:25:20 +04:00
... and a fairly recent computer.
2012-08-28 03:18:56 +04:00
2014-03-17 00:25:20 +04: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.
2012-08-23 09:46:07 +04:00
## Offline version
2014-08-17 22:42:38 +04:00
Offline builds are available. More details in the [dedicated wiki page](https://github.com/juliandescottes/piskel/wiki/Desktop-applications).
## Built with
2012-08-23 09:46:07 +04:00
2014-03-17 01:09:48 +04:00
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** :
2014-03-17 00:25:20 +04:00
* [spectrum](https://github.com/bgrins/spectrum) : awesome standalone colorpicker
* [gifjs](http://jnordberg.github.io/gif.js/) : generate animated GIFs in javascript, using webworkers
2015-04-13 09:53:24 +03:00
* [supergif](https://github.com/buzzfeed/libgif-js) : modified version of SuperGif to parse and import GIFs
2014-04-11 03:14:07 +04: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
* [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)
2014-03-17 00:25:20 +04:00
## Contributing ?
Help is always welcome !
2014-03-17 00:25:20 +04:00
* **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
2015-04-15 10:08:30 +03:00
## License
2015-04-15 18:39:56 +03:00
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
## Mobile/Tablets
There is no support for mobile for now.
2012-08-23 09:51:42 +04:00