Metadata-Version: 2.1
Name: tickytacky
Version: 0.10.0
Summary: Tickytacky pixel game maker
License: GNU General Public License
Author: JP Etcheber
Author-email: jetcheber@gmail.com
Requires-Python: >=3.8,<3.11
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: Flask (>=2.1.2,<3.0.0)
Requires-Dist: Pillow (>=9.1.0,<10.0.0)
Requires-Dist: pyglet (>=1.5.23,<2.0.0)
Description-Content-Type: text/markdown

# Tickytacky

[![tickytacky pypi shield](https://img.shields.io/pypi/v/tickytacky)](https://pypi.org/project/tickytacky/)

## Description

This library aims to make it easy to make retro-style games with Pyglet.

## Install from pypi

Create a virtualenvironment with python3 and install with pip:

```
pip3 install tickytacky
```

## Installing with Poetry

Install poetry according to the [poetry docs](https://python-poetry.org/docs).

Then, create a virtual environment with python3 and install with poetry.

```
poetry install
```

## Examples

Examples can be found here, in the examples, repo:

[Tickytacky Examples](https://github.com/numbertheory/tickytacky-examples)

## Sprite Maker

The sprite library contains a small Flask app you can run to assist with making
sprites.

Example:
```
python3 tickytacky/sprite.py
```

Then open http://0.0.0.0:5000/ to start using the sprite maker.

1. Select colors from the large color button. It's an HTML5 color selector, so it will
use your system's color picker to select any color.

2. Click the "Create Color option" to add it to the palette.

3. Choose that color from the palette options and draw with it. By default, the color name
will show as undefined, but you can change that in the text box.

4. If you remove a color from the palette, all pixels with that color will also be removed.

5. When done drawing, name the sprite and click the "Export" button. This will create a
new page which will show the JSON format for the sprite you drew.

6. Copy that info into a JSON file in your game.

