Metadata-Version: 2.1
Name: IFProject
Version: 0.0.0
Summary: A Python package for creating Interactive Fiction Narratives!
Author-email: Max Suica <max.suica@gmail.com>, Kyle Hess <donotreply@github.com>
License: AGPLv3
Project-URL: Homepage, https://github.com/maxsu/IFProject
Keywords: IF,Interactive Fiction,PyScript
Classifier: Topic :: Games/Entertainment :: Role-Playing
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.12
Classifier: Environment :: Web Environment
Classifier: Environment :: WebAssembly
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Android
Classifier: Operating System :: iOS
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: build
Requires-Dist: twine
Requires-Dist: mkdocstrings-python
Requires-Dist: pydispatch
Requires-Dist: logging518
Requires-Dist: ruff
Requires-Dist: pytest
Requires-Dist: coverage
Requires-Dist: mypy
Requires-Dist: autohooks
Requires-Dist: autohooks-plugin-ruff
Requires-Dist: autohooks-plugin-pytest
Requires-Dist: autohooks-plugin-mypy

# IFProject

![image](https://github.com/maxsu/IFProject/assets/25123/8ae388e0-5313-4004-a304-7d811e9d28ec)


## Introduction
Welcome to IFProject, a Python-based story engine dedicated to creating and playing Interactive Fiction (IF). Utilizing the power of PyScript, IFProject allows you to run your interactive stories directly in the browser, providing an accessible and immersive experience for both creators and players of IF.

## Requirements
- Python 3.11 or higher
- Internet browser

## Installation
1. **Install IFProject**: To get started, install IFProject via pip. Ensure you have Python 3.11 or later installed on your system.
   ```
   pip install IFProject
   ```
2. **Running a Story**: Once installed, you can start playing an interactive fiction story by running the IFengine with your story file (in YAML format).
   ```
   IFengine mystory.yaml
   ```
   This command will serve your game on localhost, allowing you to play it in your browser.

## Development
If you're interested in working with IFProject code, see our [Project Developer Guide](https://github.com/maxsu/IFProject/blob/main/docs/Project%20Developer%20Guide.md) to get started!

## License
IFProject is licensed under the Affero GPL v3 license.

## Contact
For any questions or suggestions, feel free to join us on the [IFProject Discord](https://discord.gg/2DU6pwVn).
