Tea and Sympathy

This is a technical demonstration of Balladeer.

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

Installation

Windows
Linux

Windows

Tea and Sympathy is a command line program. You use it from the Windows command interpreter.

To launch a new command window:

Tap the Windows key so that the Start Menu pops up.
Type the word cmd.
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

First make a fresh Python virtual environment:
```
python -m venv C:\Users\author\balladeer-app
```

Update the package manager within it:

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

Install dependencies:

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

Install (or update) Balladeer:

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

Download

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

Run

You can run the demo in two modes.

Launch a local web server to play in a browser (http://localhost:8080):
```
C:\Users\author\balladeer-app\Scripts\python -m tas.server
```

Or text-only in the terminal:

C:\Users\author\balladeer-app\Scripts\python -m tas.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

First make a fresh Python virtual environment:
```
python3 -m venv ~/balladeer-app
```

Update the package manager within it:

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

Install dependencies:
```
~/balladeer-app/bin/pip install aiohttp
```

Install (or update) Balladeer:

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

Download

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

Run

You can run the demo in two modes.

Launch a local web server to play the web app (http://localhost:8080):
```
~/balladeer-app/bin/python -m tas.server
```
Or text-only in the terminal:
```
~/balladeer-app/bin/python -m tas.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 tea-and-sympathy 0.17.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 tea-and-sympathy 0.17.0
File	Size	Uploaded	Provenance
tea_and_sympathy-0.17.0.tar.gz	33.3 kB	Dec 2, 2021	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for tea-and-sympathy 0.17.0
File	Interpreter	ABI	Platform	Reset
tea_and_sympathy-0.17.0-py3-none-any.whl 39.3 kB Dec 2, 2021 Without provenance	Python 3	none	any	Details

Total release size: 72.6 kB

Release files / tea_and_sympathy-0.17.0.tar.gz

Download URL	tea_and_sympathy-0.17.0.tar.gz
Size	33.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`94de49c49a1aecac75dfd155a13fdd6992d579b147806f3086c9e02202e6fd61`
BLAKE2b-256 checksum How to use checksums	`47ec2d668beab652a8ff8a0bab69b949944f98c95c57afdc71eca01b6272beb6`
Upload date	Dec 2, 2021
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 / tea_and_sympathy-0.17.0-py3-none-any.whl

Download URL	tea_and_sympathy-0.17.0-py3-none-any.whl
Size	39.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`40f6d3797cb54e5c488557222538a903562b36416b84f7840cd5495dd344d383`
BLAKE2b-256 checksum How to use checksums	`12781c1cf5ce149eef338a6ebfd0bd32a41d89a7d572da923f499968197b1f3a`
Upload date	Dec 2, 2021
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 tea-and-sympathy 0.17.0

Report project as malware

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.