| Name | IFProject JSON |
| Version |
0.0.0
JSON |
| download |
| home_page | |
| Summary | A Python package for creating Interactive Fiction Narratives! |
| upload_time | 2024-02-05 14:52:31 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.12 |
| license | AGPLv3 |
| keywords |
if
interactive fiction
pyscript
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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
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).
Raw data
{
"_id": null,
"home_page": "",
"name": "IFProject",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": "",
"keywords": "IF,Interactive Fiction,PyScript",
"author": "",
"author_email": "Max Suica <max.suica@gmail.com>, Kyle Hess <donotreply@github.com>",
"download_url": "https://files.pythonhosted.org/packages/49/1c/9640e9fd7f36f218bb63ba61dfe791dd87e594856e10ebb52e97ed6c5c65/IFProject-0.0.0.tar.gz",
"platform": null,
"description": "# IFProject\n\n\n\n\n## Introduction\nWelcome 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.\n\n## Requirements\n- Python 3.11 or higher\n- Internet browser\n\n## Installation\n1. **Install IFProject**: To get started, install IFProject via pip. Ensure you have Python 3.11 or later installed on your system.\n ```\n pip install IFProject\n ```\n2. **Running a Story**: Once installed, you can start playing an interactive fiction story by running the IFengine with your story file (in YAML format).\n ```\n IFengine mystory.yaml\n ```\n This command will serve your game on localhost, allowing you to play it in your browser.\n\n## Development\nIf 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!\n\n## License\nIFProject is licensed under the Affero GPL v3 license.\n\n## Contact\nFor any questions or suggestions, feel free to join us on the [IFProject Discord](https://discord.gg/2DU6pwVn).\n",
"bugtrack_url": null,
"license": "AGPLv3",
"summary": "A Python package for creating Interactive Fiction Narratives!",
"version": "0.0.0",
"project_urls": {
"Homepage": "https://github.com/maxsu/IFProject"
},
"split_keywords": [
"if",
"interactive fiction",
"pyscript"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "34ec3499151c88012bd7eef6f3d0a6adf53d71cc4a245326d551af9dbb9b5d0c",
"md5": "2c8940abc39d303d3ff4202dcdcbe6c9",
"sha256": "62c52390ff5cf1e0ae97996bd8f3e847ebc2027e57a32967bfea0eb6fa6a525c"
},
"downloads": -1,
"filename": "IFProject-0.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2c8940abc39d303d3ff4202dcdcbe6c9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 18632,
"upload_time": "2024-02-05T14:52:29",
"upload_time_iso_8601": "2024-02-05T14:52:29.593423Z",
"url": "https://files.pythonhosted.org/packages/34/ec/3499151c88012bd7eef6f3d0a6adf53d71cc4a245326d551af9dbb9b5d0c/IFProject-0.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "491c9640e9fd7f36f218bb63ba61dfe791dd87e594856e10ebb52e97ed6c5c65",
"md5": "b74bfd0e2a9f53c9f21a90e231ed52a7",
"sha256": "cf1c69a521dfd4f005d1d03a568d96dabfadcd4daa81a3fb25689776b20cf230"
},
"downloads": -1,
"filename": "IFProject-0.0.0.tar.gz",
"has_sig": false,
"md5_digest": "b74bfd0e2a9f53c9f21a90e231ed52a7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 19594,
"upload_time": "2024-02-05T14:52:31",
"upload_time_iso_8601": "2024-02-05T14:52:31.068755Z",
"url": "https://files.pythonhosted.org/packages/49/1c/9640e9fd7f36f218bb63ba61dfe791dd87e594856e10ebb52e97ed6c5c65/IFProject-0.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-05 14:52:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maxsu",
"github_project": "IFProject",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ifproject"
}
