Skip to main content

Pity of Thieves

This is a technical demonstration of Balladeer. I first wrote it for the Icehouse game jam in 2021.

Balladeer helps you build parser-based Interactive Fiction for the Web. Balladeer is a Python library.

Installation

Windows

Pity of Thieves is a command line program. You use it from the Windows command interpreter.

To launch a new command window:

  1. Tap the Windows key so that the Start Menu pops up.

  2. Type the word cmd.

  3. When you see the Command Prompt app highlighted, tap the Enter key.

You should see a prompt like this (your user name will differ):

Microsoft Windows [Version 10.0.18362.1139]
(c) 2019 Microsoft Corporation. All rights reserved.

C:\Users\author>

Prerequisites

Download and install Python from https://www.python.org/ . You need Python version 3.8 or higher. Make sure to check the option to add python to your environment path. This makes command line operation more easy.

After you’ve installed Python, open a command window and type python. You should see something like this:

C:\Users\author>python
Python 3.8.2 (tags/v3.8.2:7b3ab59, Feb 25 2020, 22:45:29) [MSC v.1916 32 bit (Intel)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>>

Type quit() and press Return.

Virtual Environment

  1. First make a fresh Python virtual environment:

    python -m venv C:\Users\author\balladeer-app
  2. Update the package manager within it:

    C:\Users\author\balladeer-app\Scripts\pip install -U pip wheel
  3. Install dependencies:

    C:\Users\author\balladeer-app\Scripts\pip install aiohttp
  4. Install (or update) Balladeer:

    C:\Users\author\balladeer-app\Scripts\pip install -U balladeer

Download

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

  2. cd to pity_of_thieves.

Run

You can run the demo in two modes.

  1. Launch a local web server to play in a browser (http://localhost:8080):

    C:\Users\author\balladeer-app\Scripts\python -m pot.server
  2. Or text-only in the terminal:

    C:\Users\author\balladeer-app\Scripts\python -m pot.story

Linux

The Linux command line is generally more easy to work with than the Windows command prompt. If you’re finding the Windows command prompt tricky, you can install Git Bash which behaves in a Linux-like way.

I encourage you to move to a Linux operating system when you are able. You can try one out at little cost on a Raspberry Pi or similar device.

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

Virtual Environment

  1. First make a fresh Python virtual environment:

    python3 -m venv ~/balladeer-app
  2. Update the package manager within it:

    ~/balladeer-app/bin/pip install -U pip wheel
  3. Install dependencies:

    ~/balladeer-app/bin/pip install aiohttp
  4. Install (or update) Balladeer:

    ~/balladeer-app/bin/pip install -U balladeer

Download

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

  2. cd to pity_of_thieves.

Run

You can run the demo in two modes.

  1. Launch a local web server to play the web app (http://localhost:8080):

    ~/balladeer-app/bin/python -m pot.server
  2. Or text-only in the terminal:

    ~/balladeer-app/bin/python -m pot.story

The freedom to copy

You are free to use this project as a teaching example, or as the basis of your own work. Please read the licence and make sure you understand the Affero GPL.

Metadata

Release files for pity-of-thieves 0.9.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pity-of-thieves 0.9.0
File Size Uploaded Provenance
pity_of_thieves-0.9.0.tar.gz 691.6 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for pity-of-thieves 0.9.0
File Interpreter ABI Platform
pity_of_thieves-0.9.0-py3-none-any.whl Python 3 none any Details

Total release size: 1.2 MB

Release files / pity_of_thieves-0.9.0.tar.gz

Download URL pity_of_thieves-0.9.0.tar.gz
Size 691.6 kB
Tags Source
SHA-256 checksum
How to use checksums
30beb13425ec6d008625cb5abf267dbc40e3acecaa58790f7d98abb90b247ac3
BLAKE2b-256 checksum
How to use checksums
f2ee655841a89bf96b017dad973d8586e3168406ba87c5e8c367beef357bafe4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.5

Release files / pity_of_thieves-0.9.0-py3-none-any.whl

Download URL pity_of_thieves-0.9.0-py3-none-any.whl
Size 486.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7db0b6472ebb7008e33b8916609e50d5b93b776181dd9e95bc1c7e7bae91c697
BLAKE2b-256 checksum
How to use checksums
e29e1340dbeb03e994fa68ce83f8135750a2aebaeb7c28886a2049a45eaeae7c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.5

Security for pity-of-thieves 0.9.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page