IFProject
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
- Install IFProject: To get started, install IFProject via pip. Ensure you have Python 3.11 or later installed on your system.
pip install IFProject - Running a Story: Once installed, you can start playing an interactive fiction story by running the IFengine with your story file (in YAML format).
This command will serve your game on localhost, allowing you to play it in your browser.IFengine mystory.yaml
Development
If you're interested in working with IFProject code, see our Project Developer Guide 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.
1 maintainer
Metadata
1 maintainer
Release files for IFProject 0.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| IFProject-0.0.0.tar.gz | 19.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| IFProject-0.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 38.2 kB
Release files / IFProject-0.0.0.tar.gz
| Download URL | IFProject-0.0.0.tar.gz |
|---|---|
| Size | 19.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cf1c69a521dfd4f005d1d03a568d96dabfadcd4daa81a3fb25689776b20cf230
|
|
BLAKE2b-256 checksum How to use checksums |
491c9640e9fd7f36f218bb63ba61dfe791dd87e594856e10ebb52e97ed6c5c65
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.12.1
|
Release files / IFProject-0.0.0-py3-none-any.whl
| Download URL | IFProject-0.0.0-py3-none-any.whl |
|---|---|
| Size | 18.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
62c52390ff5cf1e0ae97996bd8f3e847ebc2027e57a32967bfea0eb6fa6a525c
|
|
BLAKE2b-256 checksum How to use checksums |
34ec3499151c88012bd7eef6f3d0a6adf53d71cc4a245326d551af9dbb9b5d0c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.12.1
|
