Utilities for finding sprites in a sprite sheet
Project description
Spriteutils
Spriteutils is small project to determine Sprites (specified by there unique label mask and bounding box) in the given Sprite Sheet.
A Sprite is a small raster graphic (a bitmap) that represents an object
It is not uncommon for games to have tens to hundreds of sprites. Loading each of these as an individual image would consume a lot of memory and processing power. To help manage sprites and avoid using so many images, many games use Sprite Sheets
This project is a tool to determine sprites (specified by there unique mask and bounding box) in the given Sprite Sheet.
Installaltion:
Prequisites: Python 3.7
$ pip install spriteutils-pkg
Documentation
After install the package, open python (python version must be >= 3.7)
$ python
Import the package and using method help to read the document
>>> from spriteutils import SpriteSheet
>>> help(SpriteSheet)
Functional test
Replicate the following step in python
# Import the package
>>> from spriteutils import SpriteSheet
# Specified the image file path name or create a PIL image
>>> image = "path/to/your/image"
# Create sprite sheet object
>>> sprite_sheet = SpriteSheet(image)
# Find all the sprites of the sprite sheet
>>> sprites ,label_map = sprite_sheet.find_sprites()
# Draw sprite masks for each sprite in the sprite sheet
>>> image = sprite_sheet.create_sprite_labels_image()
# Show the sprite masks image
>>> image.show()
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
License
This project is licensed under the MIT License - see the LICENSE file for details
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for spriteutils_pkg-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eff195c4d830b7c3daeef0a9cc9bf9538cf2bf67e56ef5b96870e815ead35dd5 |
|
MD5 | ee644ead2f41f17b87c6ae7022304c22 |
|
BLAKE2b-256 | be76ea5ca03269b62a12f618258205412b2fb7e30d646485066ad77ac078c633 |