Metadata-Version: 2.1
Name: uvn-fira
Version: 1.2.4
Summary: The backend and API code for the Unscripted mini-game.
Home-page: https://github.com/alicerunsonfedora/fira
License: MPL-2.0
Author: Marquis Kurt
Author-email: software@marquiskurt.net
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*
Classifier: License :: OSI Approved
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: toml (>=0.10.0,<0.11.0)
Description-Content-Type: text/markdown

# Fira

Fira is the package that contains the backend code and API code for Unscripted's minigame. Fira is named after Fira Sans, one of the game's characters.


[![MPL](https://img.shields.io/github/license/alicerunsonfedora/fira)](LICENSE.txt)
![Python](https://img.shields.io/badge/python-2.7+-blue.svg)

## Requirements

- Python 2.7
- Poetry package manager
- Ren'Py

## Installing

To install Fira to a Python environment, run `pip install uvn-fira`. For environments in Ren'Py, run `pip install uvn-fira --target game/python-packages`.

## Building from Source

Clone the Fira repository and then run `poetry install` to create a Python virtual environment and install the development dependencies to.

To build the final package, run `poetry build`.

To publish the package to PyPI, run `poetry publish`.

> Note: For any scripts that rely on these functions, make sure you have your Python environment link to the Ren'Py module.

## License

The Fira package is licensed under the Mozilla Public License v2.0.
