Metadata-Version: 2.1
Name: whimsylib
Version: 1.4.2
Summary: A generic game engine for text-based games, inspired by adventurelib.
Home-page: https://github.com/Cronenbrogues/whimsylib
Author: The Arch Cronenbrogues
Author-email: cronenbrogues@googlegroups.com
License: UNKNOWN
Platform: UNKNOWN
Requires-Python: >=3.8
Description-Content-Type: text/markdown

[![PyPI version](https://img.shields.io/pypi/v/whimsylib.svg)](https://pypi.org/project/whimsylib/)

# whimsylib

A game engine for text-based games, inspired by [adventurelib](https://github.com/lordmauve/adventurelib).

This is currently the game engine behind [cronenbroguelike](https://github.com/Cronenbrogues/cronenbroguelike).

## Develop

Set up a virtualenv and install the dev requirements.

```
python3.8 -m venv venv
source venv/bin/activate
pip install -r requirements/requirements-dev.txt
```

## Release

Update the version number in `setup.py`, and then push a new tag with that version number. This will trigger a Github Action that publishes the new version to [PyPI](https://pypi.org/project/whimsylib/).

## API Documentation

Coming soon!


