vlw/pysheeter
1
0
Fork 0
mirror of https://codeberg.org/vlw/pysheeter.git synced 2025-09-14 11:33:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge remote-tracking branch 'origin/VictorWesterlund-readme-package' into package

Browse source
This commit is contained in:
Victor Westerlund 2020-11-23 18:23:21 +01:00
commit a242145f82
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,20 +1,20 @@
# PySheeter # PySheeter
Lightweight Pillow Python-script to create and scale sprite sheets from PNGs in folders or individually 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 [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 version of PySheeter with [`pip3`](https://pypi.org/project/pysheeter-VicW/) 2. Install the latest build of PySheeter with [`pip3`](https://pypi.org/project/pysheeter/)
```bash ```bash
$ pip3 install pysheeter-VicW $ python3 -m pip install pysheeter
``` ```
### Sprite sheet from folder ### Sprite sheet from folder
1. Import `Sheet` from `pysheeter` 1. Import `Sheet` from `pysheeter`
```python ```python
from pysheeter import Sheet from pysheeter import PySheeter
``` ```
2. Initialize the class with a path to your PNG-folder 2. Initialize the class with a path to your PNG-folder
```python ```python
spritesheet = pysheeter.Sheet("example/") spritesheet = PySheeter.Sheet("example/")
``` ```
3. Create a sprite sheet with `put()` 3. Create a sprite sheet with `put()`
```python ```python
@ -41,11 +41,11 @@ spritesheet.put("example_h1632.png",(16,32),False)
### Sprite sheet from individual PNG-images ### Sprite sheet from individual PNG-images
1. Import `Sheet` from `pysheeter` 1. Import `Sheet` from `pysheeter`
```python ```python
from pysheeter import Sheet from pysheeter import PySheeter
``` ```
2. Initialize the class without any arguments 2. Initialize the class without any arguments
```python ```python
spritesheet = pysheeter.Sheet() spritesheet = PySheeter.Sheet()
``` ```
3. Add PNG-images with `add()` 3. Add PNG-images with `add()`
```python ```python