Skip to content

Commit

Permalink
Merge pull request #2 from VictorWesterlund/VictorWesterlund-readme-p…
Browse files Browse the repository at this point in the history
…ackage

Update README.md with new package-based installation
  • Loading branch information
VictorWesterlund authored Nov 23, 2020
2 parents 025a0e5 + 8544d4f commit d3a2f67
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# 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
1. Download and install [Python 3](https://www.python.org/downloads/) for your architecture
2. Download and install [Pillow](https://pypi.org/project/Pillow/) for Python 3 with `pip3`
2. Install the latest build of PySheeter with [`pip3`](https://pypi.org/project/pysheeter/)
```bash
$ pip3 install Pillow
$ python3 -m pip install pysheeter
```
### Sprite sheet from folder
1. Import `Sheet` from `pysheeter`
```python
from pysheeter import Sheet
from pysheeter import PySheeter
```
2. Initialize the class with a path to your PNG-folder
```python
spritesheet = pysheeter.Sheet("example/")
spritesheet = PySheeter.Sheet("example/")
```
3. Create a sprite sheet with `put()`
```python
Expand All @@ -41,11 +41,11 @@ spritesheet.put("example_h1632.png",(16,32),False)
### Sprite sheet from individual PNG-images
1. Import `Sheet` from `pysheeter`
```python
from pysheeter import Sheet
from pysheeter import PySheeter
```
2. Initialize the class without any arguments
```python
spritesheet = pysheeter.Sheet()
spritesheet = PySheeter.Sheet()
```
3. Add PNG-images with `add()`
```python
Expand Down

0 comments on commit d3a2f67

Please sign in to comment.