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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for balladeer-0.57.0.tar.gz
Algorithm Hash digest
SHA256 2a562e7c01c34e61e88e62b7fa8f681bdaf0cd1607ff4f8cd45a3b1e4c83896c
MD5 ae7cad4c7fe97d7125f429f0f790f3d6
BLAKE2b-256 101712e17fad9821d5ce52b1593700214a639bde30c1573ac325178820ba6720

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for balladeer-0.57.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1cd13492625fee4bfcaa583c24ead2255a3a2593e83ee9598b1bb5c2fe83cd4c
MD5 b8ea6bc32c5213ed75d3ff162d02e025
BLAKE2b-256 0765687d866a7f74eb3c7c525ab6de2cffe9d226d8da76b238b046786bff53e0

See more details on using hashes here.

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