Skip to main content

Web-enabled interactive fiction framework.

Project description

Balladeer is a Python package for creating web-enabled interactive screenplay.

For tutorials and updates, please visit the development blog site.

An API manual is included in the code repository and is available to read online.


Here are the install instructions for Linux. You need Python version 3.11 or higher.

Virtual Environment

  1. First make a fresh Python virtual environment:

    python3 -m venv ~/ballad


  1. Update the package manager within it:

    ~/ballad/bin/python -m pip install -U pip wheel
  2. Install (or update) Balladeer:

    ~/ballad/bin/python -m pip install -U balladeer


  1. Download the repository as a zip file. Unzip it to a local directory.

  2. cd to one of the directories under examples:

    cd balladeer/examples/ex_00_hello_world
  3. Run the example like this:

    ~/ballad/bin/python -m main
    Hello, World!

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

balladeer-0.51.0.tar.gz (2.1 MB view hashes)

Uploaded Source

Built Distribution

balladeer-0.51.0-py3-none-any.whl (2.1 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page