Skip to content

Commit

Permalink
add README and screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
z64me committed Jan 23, 2022
1 parent 080f5a8 commit c0ee3cf
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# EzSpriteSheet

Creating sprite sheets has never been easier: toss a folder at it and watch magic happen!

![image](ezspritesheet.png)

![image](ezspritesheet-gallery.gif)

## Features

EzSpriteSheet is more feature-rich than its competition:

| Feature | TexturePacker | EzSpriteSheet |
| ---------------------------------------- | ----------------------- | ------------- |
| Rotate sprites to save space |||
| Add padding around packed sprites |||
| Detect and omit duplicate sprites |||
| Trim excess pixels from around sprites |||
| Users can write their own export modules | ||
| Automatic pivot point detection | ||
| Supports animated GIF's | ||
| Supports animated WEBP's | ||
| Open source | ||
| Price | $39.99 per 2 computers | Free |

## Reference implementations

The following reference implementations demonstrate how to use EzSpriteSheet's output in your own programs:
- [C + SDL2](example/c99/sdl2)
- [JavaScript + HTML5 canvas](example/javascript/canvas)

Try the JavaScript demo live in your web browser: [https://z64.me/bin/ezspritesheet.js](https://z64.me/bin/ezspritesheet.js)

## License and EULA

EzSpriteSheet is released under the GNU GPL3 license. A commercial license is available for those wishing to reuse or rebrand its code for commercial purposes. Contact me through [my website](https://z64.me/) for more information.

If you use EzSpriteSheet to build something awesome, you agree to do the following:
- Visibly attribute `EzSpriteSheet <z64.me>` in your product's credits.
- Tell me about it!

## Attribution

The following libraries and software made this project possible:
- [stb](https://github.com/nothings/stb)
- [giflib](https://sourceforge.net/projects/giflib/)
- [libwebp](https://developers.google.com/speed/webp/download)
- [libpcre2](https://www.pcre.org/)
- [QtCreator](https://www.qt.io/)
- [RectangleBinPack](https://github.com/juj/RectangleBinPack)
- Sprite art courtesy of [@DynoPunch](https://twitter.com/DynoPunch)

[Read the companion article? 🍿](https://z64.me/post/ezspritesheet/)

Binary file added ezspritesheet-gallery.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ezspritesheet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c0ee3cf

Please sign in to comment.