https://github.com/michibo/fabulation
fabulation is a minimalist static html generator for simple text adventures
https://github.com/michibo/fabulation
html javascript python static-site-generator text-adventure
Last synced: about 2 months ago
JSON representation
fabulation is a minimalist static html generator for simple text adventures
- Host: GitHub
- URL: https://github.com/michibo/fabulation
- Owner: michibo
- License: gpl-3.0
- Created: 2016-11-27T22:39:04.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-10T14:38:59.000Z (about 1 year ago)
- Last Synced: 2024-10-23T21:14:04.044Z (6 months ago)
- Topics: html, javascript, python, static-site-generator, text-adventure
- Language: JavaScript
- Homepage:
- Size: 352 KB
- Stars: 8
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
fabulation
==========
[fabulation](//github.com/michibo/fabulation) is a simple tool to narrate a story in a non-linear fashion. In other words it can be used to create very simple text adventures. You can write a set of 'scenes' and jump from scene to scene using links. Each scene can be decorated with audio or pictures.
Fabulation generates a html-file that you can access via browser and publish on the internet.
Requirements:
============
To run **fabulation** a python3 installation is required. **fabulation** additionally requires
- [Mistune](//mistune.readthedocs.io/) as its Markdown implementation (mistune v3 is now required),
- [Jinja2](//jinja.palletsprojects.com/) as a template engine and
- [PyYAML](//pyyaml.org/) to read and write configuration files.
The extra python packages can be installed for instance with *pip*
pip install mistune jinja2 pyyaml
Howto:
======
See example.yml for an example on how to write a fabulation input file. The result is
[example.html](//htmlpreview.github.io/?https://github.com/michibo/fabulation/blob/master/example.html)
To generate an output (example.html) from an input (example.yml) file all
python fabulation.py example.yml example.html
The output.html uses [jQuery](//jquery.com/) and [HowlerJS](//howlerjs.com/) for sounds.
A very eleborate example can be found here: http://tmtnslt.com/jonas/