Skip to main content

A collection of command line utilities for creating, updating, and grouping tokens for Blood on the Clocktower.

Project description

Token Tools for Blood on the Clocktower

A simple fan-made utility to help create custom tokens for the game Blood on the Clocktower.

An example of tokens made by this utility

Installation

To use this tool, you will need to have Python 3 installed on your computer. You can download it from the official website.

Once you have Python installed, you can install these scripts using pip:

pip install botc_tokens

or manually by cloning this repository and running the following command in the root folder:

pip install .

We use Wand to handle image manipulation, which requires the ImageMagick library to be installed on your system. Check the wand install guide for details on how to get that set up.

Note for Apple Silicon: When running on Apple Silicon, Wand will not auto-detect the ImageMagick installation. You will need to set the MAGICK_HOME environment variable to your homebrew root, like so:

export MAGICK_HOME=/opt/homebrew/

Usage

For a full walkthrough and for more component packages, see the example repository.

The main script is run through its entrypoint botc_tokens. For example, you might use the update command to download the latest assets from the web, and then the create command to generate the tokens, followed by a group command to organize them into a single printable sheet using a json file from the official script tool. You can use the --help flag to see the available commands and options.

Updating from the web

If you want to create experimental tokens for your in-person games, you can use the update command to download the current list from the official wiki. This is an incremental update, so it will only download assets that are not already present in the local folder. We highly recommend double-checking the resulting entries, especially the reminder token section. While the utility does its best to guess, it isn't perfect. If you already know the reminder tokens, you can create a JSON file for the utility to use. See the example repository for an example of the format.

botc_tokens update --output-dir /path/to/inputs --reminders /path/to/reminders.json

Creating tokens

Once you have your role info, whether from the update command or from your own creation, you can use the create command to generate the tokens. This will create a folder with the role name and a subfolder for each token type. If you would like to customize the appearance of the tokens, you can use the --component-dir option to specify where to find your custom components. Check the example repository for an example of the expected structure.

botc_tokens create /path/to/inputs -o /path/to/tokens --components /path/to/components

Grouping tokens

Once you have created your token images, you can use the group command to organize the tokens into a single printable sheet. This command can take a directory or a JSON file with desired role grouping, which follows the formatting of the official script tool.

botc_tokens group /path/to/script.json --token-dir /path/to/tokens --output-dir /path/to/printables

And that's it!

You can now print your tokens and use them in your games. Remember, this is a fan-made utility and is not affiliated with the official game in any way. We do not own the rights to the game, and we do not claim to. We are just fans who want to make the game more accessible to everyone. Please support the creators by buying the game. It is absolutely worth it!

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

botc_tokens-2025.2.23.tar.gz (2.7 MB view details)

Uploaded Source

Built Distribution

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

botc_tokens-2025.2.23-py3-none-any.whl (2.6 MB view details)

Uploaded Python 3

File details

Details for the file botc_tokens-2025.2.23.tar.gz.

File metadata

  • Download URL: botc_tokens-2025.2.23.tar.gz
  • Upload date:
  • Size: 2.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for botc_tokens-2025.2.23.tar.gz
Algorithm Hash digest
SHA256 fc2556e6d7d5c15ee9db66ee17d1b007221fbbe00adfaa923d2ac5fc49af4930
MD5 cee047533e899cf761066be3731e9694
BLAKE2b-256 9057dae3f117700a850292b18cec8964643f1bbc7992f03cbd5afe0c47b08663

See more details on using hashes here.

File details

Details for the file botc_tokens-2025.2.23-py3-none-any.whl.

File metadata

File hashes

Hashes for botc_tokens-2025.2.23-py3-none-any.whl
Algorithm Hash digest
SHA256 02c765c7504ed291179d69b961ee23653ef62a859e966b3c8464572402b92756
MD5 1e0aa782e3c19e95be519720e4f599b0
BLAKE2b-256 6d2f7fe14d584e09486da8fc4e4329f56e6378b5047975b567cbfda139c5ae3e

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