Metadata-Version: 2.1
Name: csgame
Version: 0.1.1
Summary: useful tools for pygame development
Home-page: https://github.com/costott/csgame
Author: C Stott
Author-email: connorbstott@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >3.0
Description-Content-Type: text/markdown
License-File: LICENSE

# csgame
useful tools for pygame development

## instructions
1. Install:
```
pip install csgame
```
2. Initialise in project:
``` python
import csgame
```

## features
### colours
dynamic colours with special features
> BiColour - colour that can swap between 2 colours

> BiColourSmooth - BiColour that has a smooth transition when swapping

> FlashColour - colour that can momentarily flash to another colour

### menu
useful tools for menus
> Button - interactible button which can be pressed to perform an action

> Menu - holds a collection of buttons and is responsible for updating them

### player
provides basic player movement
> TopDownPlayer - simple top-down style player movement

> SideScrollPlayer - simple side scroll player movement with gravity

### camera
manipulates how sprites are drawn as if a camera is looking at them
> CameraSpriteGroup - sprite group which has a camera tracking a target
