Spriteutils-Ngoc-Dang 1.0.1

A Sprite dectection tool

Sprites Detection

A sprite is a small raster graphic (a bitmap) that represents an object such as a character, a vehicle, a projectile, etc.

Sprite Sheet

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 (also known as image sprites).

A sprite sheet consists of multiple sprites in one image. In other words, sprite sheets pack multiple sprites into a single picture. Using sprite sheet, video game developers create sprite sheet animation representing one or several animation sequences while only loading a single file:

Sprite Bounding Box

A frame (bounding box) can be used to delimit the sprite in the sprite sheet. This bounding box is defined with two 2D points top_left and the bottom_right, which their respective coordinates x and y are relative to the top-left corner of the sprite sheet's image.

For example:

Sprite Mask

The mask of a sprite defines the 2D shape of the sprite. For example, the sprite sheet contains 3 following sprites:

The masks of these sprites are respectively:

Aim of the project

• Detect sprites packed in an image (sheet) and draw their masks and bounding boxes into a new image with the same size of the original image.
  
• Present a 2D map of all the the sprites with their labels.
  

Usage Information

Prerequisites

• Python 3.6 is required.
  
• pip is requied, to install sudo apt install pip

Usage

• pip install Friendlyngoc from your terminal

• Example of functioning:

  • Input as a spritesheet

  • A image with sprite masks

  >>> from Friendlyngoc_spriteutil.spriteutil import SpriteSheet
  >>> sprite_sheet = SpriteSheet('spritesheet.png')
  >>> sprites, labels = sprite_sheet.find_sprites()
  >>> len(sprites)
  22
  >>> # Create the mask image with bounding boxes.
  >>> image = sprite_sheet.create_sprite_labels_image()
  >>> image.save('sprites_masks.png')
  

Contact Information

• Name: Dang Duc Ngoc
• Maintainer: Dang Duc Ngoc
• Email: Email: [e-mail]
  
• Phone number: Phone: [phone]