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.

Installation

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

Packages

  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

Examples

  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.60.0.tar.gz (2.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

balladeer-0.60.0-py3-none-any.whl (2.2 MB view details)

Uploaded Python 3

File details

Details for the file balladeer-0.60.0.tar.gz.

File metadata

  • Download URL: balladeer-0.60.0.tar.gz
  • Upload date:
  • Size: 2.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.2

File hashes

Hashes for balladeer-0.60.0.tar.gz
Algorithm Hash digest
SHA256 b8e3be3925d1057ab5ca88cb325aba75b0a4b99dc5fa1b0fbebf896c7ae88c5c
MD5 0b5bde182d6e44060b6e1441fa2243a8
BLAKE2b-256 8ab88335421585b0a9d3eb13fb0e2c9ce2fbc1685dd30417595a577365bd7cbf

See more details on using hashes here.

File details

Details for the file balladeer-0.60.0-py3-none-any.whl.

File metadata

  • Download URL: balladeer-0.60.0-py3-none-any.whl
  • Upload date:
  • Size: 2.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.2

File hashes

Hashes for balladeer-0.60.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e892ce7387c7445ad714254aba2f6780cf5f74ec6305c361c3074685e8e10a69
MD5 277f008d0d763803513f3504ae1b4f4b
BLAKE2b-256 e09c30b04b89caeb36beca410f3d01d5d04d945d1a9ffd6061acf572477850a3

See more details on using hashes here.

Supported by

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