Compare commits

..

No commits in common. "master" and "1.0.6" have entirely different histories.

19 changed files with 84 additions and 273 deletions

162
.gitignore vendored
View file

@ -1,162 +1,2 @@
._*
# Byte-compiled / optimized / DLL files
__pycache__/ __pycache__/
*.py[cod] example_*
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
.pybuilder/
target/
# Jupyter Notebook
.ipynb_checkpoints
# IPython
profile_default/
ipython_config.py
# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock
# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock
# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/
# Celery stuff
celerybeat-schedule
celerybeat.pid
# SageMath parsed files
*.sage.py
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
.dmypy.json
dmypy.json
# Pyre type checker
.pyre/
# pytype static type analyzer
.pytype/
# Cython debug symbols
cython_debug/
# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/

View file

@ -1,12 +1,8 @@
# PySheeter # PySheeter
![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/VictorWesterlund/pysheeter?include_prereleases)
![GitHub last commit](https://img.shields.io/github/last-commit/VictorWesterlund/pysheeter)
![Maintenance](https://img.shields.io/maintenance/yes/2020)
Lightweight Pillow Python package to create and scale sprite sheets from individual PNGs or whole folders Lightweight Pillow Python package to create and scale sprite sheets from individual PNGs or whole folders
## Get started / Basic usage ## Get started / Basic usage
1. Download and install the latest version of [Python 3](https://www.python.org/downloads/) for your architecture 1. Download and install [Python 3](https://www.python.org/downloads/) for your architecture
2. Install the latest build of PySheeter with [`pip3`](https://pypi.org/project/pysheeter/) 2. Install the latest build of PySheeter with [`pip3`](https://pypi.org/project/pysheeter/)
```bash ```bash
$ python3 -m pip install pysheeter $ python3 -m pip install pysheeter
@ -31,13 +27,13 @@ __Example usage:__
# from 'example.py' # from 'example.py'
from pysheeter import PySheeter from pysheeter import PySheeter
# Load sprites from './files/' (all sprites are 64x64) # Load sprites from 'example/'
spritesheet = PySheeter.Sheet("example") spritesheet = PySheeter.Sheet("example")
# Create a vertical spritesheet with the dimensions 16x16 (scaled) # Create a vertical spritesheet with the dimensions 16x16
spritesheet.put("example_v1616.png",(16,16)) spritesheet.put("example_v1616.png",(16,16))
# Create a horizontal spritesheet with the dimensions 16x32 (scaled & stretched) # Create a horizontal spritesheet with the dimensions 16x32
spritesheet.put("example_h1632.png",(16,32),False) spritesheet.put("example_h1632.png",(16,32),False)
``` ```
![Example 1](https://storage.googleapis.com/public.victorwesterlund.com/github/VictorWesterlund/pysheeter/1example_v1616.png) ![Example 1](https://storage.googleapis.com/public.victorwesterlund.com/github/VictorWesterlund/pysheeter/1example_v1616.png)

1
__init__.py Normal file
View file

@ -0,0 +1 @@
from lib import PySheeter

View file

@ -1,23 +0,0 @@
from pysheeter.pysheeter import Sheet as SpriteSheet
# Simple PySheeter CLI
def main():
print("Welcome to the PySheeter CLI")
# Gather parameters from user input
folder = str(input("Enter path to folder of sprites:\n"))
ext = str(input("Enter the file extension of these sprites (without dot, 'png', 'jpg' etc.):\n"))
size = int(input("What width in pixels do you want each sprite to be? (1:1 aspect ratio):\n"))
vertical = not bool(input("Do you want a vertical sprite sheet? [Y,n]:\n"))
dest = str(input("Finally, enter a file name (or path) for the sprite sheet:\n"))
print("Reading sprites from folder...")
sheet = SpriteSheet(folder, ext)
print("Creating sprite sheet...")
sheet.put(dest, (size, size), vertical)
print("Done!")
if __name__ == "__main__":
main()

10
example.py Normal file
View file

@ -0,0 +1,10 @@
from pysheeter import PySheeter
# Load sprites from 'example/'
spritesheet = PySheeter.Sheet("example")
# Create a vertical spritesheet with the dimensions 16x16
spritesheet.put("example_v1616.png",(16,16))
# Create a horizontal spritesheet with the dimensions 16x32
spritesheet.put("example_h1632.png",(16,32),False)

BIN
example/1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 373 B

BIN
example/2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 406 B

BIN
example/3.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 471 B

BIN
example/4.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 291 B

BIN
example/5.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 333 B

BIN
example/6.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 333 B

BIN
example/7.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 280 B

BIN
example/8.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 333 B

BIN
example/9.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 450 B

68
pysheeter/PySheeter.py Normal file
View file

@ -0,0 +1,68 @@
import json
from PIL import Image
from pathlib import Path
# Create new sprite
class Sprite:
def __init__(self,image,size):
self.image = Image.open(image).convert("RGBA")
# Resize image to size[width,height] if nessesary
if(self.image.width != size[0] or self.image.height != size[1]):
self.resize(size)
# Resize image without maintaining aspect ratio
def resize(self,size,resample=Image.LANCZOS):
self.image = self.image.resize((size[0],size[1]),resample)
# --------------------------------
# Create new sheet of sprites
class Sheet:
def __init__(self,folder = None):
self.sprites = []
# Auto-import sprite folder
if(folder):
self.path = Path(folder).glob("**/*.png")
self.sprites = [x for x in self.path]
print(f"Loaded {len(self.sprites)} sprites")
# Concatinate sprites vertically
def concatV(self,size):
sheet = Image.new("RGBA",(size[0],size[1] * len(self.sprites)))
for i, sprite in enumerate(self.sprites):
sheet.paste(Sprite(sprite,size).image,(0,size[1] * i))
return sheet
# Concatinate sprites horizontally
def concatH(self,size):
sheet = Image.new("RGBA",(size[0] * len(self.sprites),size[1]))
for i, sprite in enumerate(self.sprites):
sheet.paste(Sprite(sprite,size).image,(size[0] * i,0))
return sheet
# Add sprite by path
def add(self,path):
self.sprites.append(path)
# Remove sprite by path
def remove(self,path):
self.sprites.remove(path)
# Create and save spritesheet
def put(self,dest,size,vertical = True):
if(vertical):
sheet = self.concatV(size)
else:
sheet = self.concatH(size)
sheet.save(dest)
print(f"Saved spritesheet to '{dest}'")

View file

View file

@ -1,66 +0,0 @@
from typing import Union
from pathlib import Path
from PIL import Image
# Create new sprite
class Sprite:
def __init__(self, image: str, resize: Union[tuple, list] = None):
self.image = Image.open(image).convert("RGBA")
# Resize image if necessary
if (resize):
self.resize(resize)
# Resize image without maintaining aspect ratio
def resize(self, size: Union[tuple, list], resample = Image.LANCZOS):
self.image = self.image.resize((size[0], size[1]), resample)
# --------------------------------
# Create new sheet of sprites
class Sheet:
def __init__(self, folder: str = None):
self.sprites = []
# Auto-import PNGs from folder
if(folder):
self.path = Path(folder).glob(f"**/*.png")
self.sprites = [x for x in self.path]
# Concatinate sprites vertically
def concat_vertical(self, size: Union[tuple, list]):
sheet_size = (size[0], size[1] * len(self.sprites))
sheet = Image.new("RGBA", sheet_size)
for i, sprite in enumerate(self.sprites):
sheet.paste(Sprite(sprite, size).image, (0, size[1] * i))
return sheet
# Concatinate sprites horizontally
def concat_horizontal(self, size: Union[tuple, list]):
sheet_size = (size[0] * len(self.sprites), size[1])
sheet = Image.new("RGBA", sheet_size)
for i, sprite in enumerate(self.sprites):
sheet.paste(Sprite(sprite, size).image, (size[0] * i, 0))
return sheet
# Add sprite by path
def add(self, path: str):
self.sprites.append(path)
# Remove sprite by path
def remove(self, path: str):
self.sprites.remove(path)
# Create and save spritesheet
def put(self, dest: str, size: Union[tuple, list], vertical: bool = True):
if(vertical):
sheet = self.concat_vertical(size)
else:
sheet = self.concat_horizontal(size)
sheet.save(dest)

View file

@ -1,2 +0,0 @@
# The requirements in setup.py should also be updated when changing this
pillow

View file

@ -1,13 +0,0 @@
from setuptools import setup, find_packages
setup(
name = "pysheeter",
version = "1.1.0",
description = "Simple python library for creating sprite sheets from images",
author = "Victor Westerlund",
author_email = "victor.vesterlund@gmail.com",
url = "https://github.com/victorwesterlund/reflect-client-python",
packages = ["pysheeter"],
# The requirement.txt file should also be updated when changing this
install_requires = ["pillow"]
)