| Name | botc-tokens JSON |
| Version |
2024.12.22
JSON |
| download |
| home_page | None |
| Summary | A collection of command line utilities for creating, updating, and grouping tokens for Blood on the Clocktower. |
| upload_time | 2024-12-22 17:39:55 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Token Tools for Blood on the Clocktower
A simple fan-made utility to help create custom tokens for the game Blood on the Clocktower.
## Installation
To use this tool, you will need to have Python 3 installed on your computer. You can download it from the
[official website](https://www.python.org/downloads/).
Once you have Python installed, you can install these scripts using `pip`:
```bash
pip install botc_tokens
```
or manually by cloning this repository and running the following command in the root folder:
```bash
pip install .
```
We use [Wand](https://docs.wand-py.org/en/0.6.13/) to handle image manipulation, which requires the
[ImageMagick](https://imagemagick.org/index.php) library to be installed on your system. Check the
[wand install guide](https://docs.wand-py.org/en/0.6.13/guide/install.html) for details on how to get
that set up.
## Usage
**For a full walkthrough and for more component packages, see the
[example repository](https://github.com/Tsubashi/botc_tokens-Examples).**
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](https://script.bloodontheclocktower.com/).
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](https://wiki.bloodontheclocktower.com/). 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](https://github.com/Tsubashi/botc_tokens-Examples) for an example of the format.
```bash
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](https://github.com/Tsubashi/botc_tokens-Examples)
for an example of the expected structure.
```bash
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](https://script.bloodontheclocktower.com/).
```bash
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](https://bloodontheclocktower.com/buy). It is absolutely worth it!
Raw data
{
"_id": null,
"home_page": null,
"name": "botc-tokens",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/95/e3/7b454814615df23adfffb7f4898e077411a73383e17f16435f2990178638/botc_tokens-2024.12.22.tar.gz",
"platform": null,
"description": "# Token Tools for Blood on the Clocktower\nA simple fan-made utility to help create custom tokens for the game Blood on the Clocktower.\n\n\n\n## Installation\nTo use this tool, you will need to have Python 3 installed on your computer. You can download it from the\n[official website](https://www.python.org/downloads/).\n\nOnce you have Python installed, you can install these scripts using `pip`:\n```bash\npip install botc_tokens\n```\nor manually by cloning this repository and running the following command in the root folder:\n```bash\npip install .\n```\n\nWe use [Wand](https://docs.wand-py.org/en/0.6.13/) to handle image manipulation, which requires the \n[ImageMagick](https://imagemagick.org/index.php) library to be installed on your system. Check the \n[wand install guide](https://docs.wand-py.org/en/0.6.13/guide/install.html) for details on how to get\nthat set up.\n\n## Usage\n**For a full walkthrough and for more component packages, see the \n[example repository](https://github.com/Tsubashi/botc_tokens-Examples).**\n\nThe main script is run through its entrypoint `botc_tokens`. For example, you might use the `update` command to download\nthe latest assets from the web, and then the `create` command to generate the tokens, followed by a `group` command to \norganize them into a single printable sheet using a json file from the [official script tool](https://script.bloodontheclocktower.com/). \nYou can use the `--help` flag to see the available commands and options.\n\n### Updating from the web\nIf you want to create experimental tokens for your in-person games, you can use the `update` command to download the\ncurrent list from the [official wiki](https://wiki.bloodontheclocktower.com/). This is an incremental update, so it \nwill only download assets that are not already present in the local folder. We highly recommend double-checking the\nresulting entries, especially the reminder token section. While the utility does its best to guess, it isn't perfect.\nIf you already know the reminder tokens, you can create a JSON file for the utility to use. See the \n[example repository](https://github.com/Tsubashi/botc_tokens-Examples) for an example of the format.\n```bash\nbotc_tokens update --output-dir /path/to/inputs --reminders /path/to/reminders.json\n```\n\n### Creating tokens\nOnce you have your role info, whether from the `update` command or from your own creation, you can use the `create`\ncommand to generate the tokens. This will create a folder with the role name and a subfolder for each token type. If you\nwould like to customize the appearance of the tokens, you can use the `--component-dir` option to specify where to\nfind your custom components. Check the [example repository](https://github.com/Tsubashi/botc_tokens-Examples) \nfor an example of the expected structure.\n```bash\nbotc_tokens create /path/to/inputs -o /path/to/tokens --components /path/to/components\n```\n\n### Grouping tokens\nOnce you have created your token images, you can use the `group` command to organize the tokens into a single \nprintable sheet. This command can take a directory or a JSON file with desired role grouping, which follows the\nformatting of the [official script tool](https://script.bloodontheclocktower.com/).\n\n```bash\nbotc_tokens group /path/to/script.json --token-dir /path/to/tokens --output-dir /path/to/printables\n```\n\n## And that's it!\nYou can now print your tokens and use them in your games. Remember, this is a fan-made utility and is not\naffiliated 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\nfans who want to make the game more accessible to everyone. Please support the creators by \n[buying the game](https://bloodontheclocktower.com/buy). It is absolutely worth it!\n",
"bugtrack_url": null,
"license": null,
"summary": "A collection of command line utilities for creating, updating, and grouping tokens for Blood on the Clocktower.",
"version": "2024.12.22",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a1aa8a35d4573d9d3a8b2d12751042ecb001d0f34be38a0577a2bd4c65e21a29",
"md5": "b53c755a71a00be50e01ae01c6980364",
"sha256": "49362de20b1fbda3eeaa4499dbe965f81e1354ac7586eb6367ca23f86f9e0dab"
},
"downloads": -1,
"filename": "botc_tokens-2024.12.22-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b53c755a71a00be50e01ae01c6980364",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 2644460,
"upload_time": "2024-12-22T17:39:52",
"upload_time_iso_8601": "2024-12-22T17:39:52.957415Z",
"url": "https://files.pythonhosted.org/packages/a1/aa/8a35d4573d9d3a8b2d12751042ecb001d0f34be38a0577a2bd4c65e21a29/botc_tokens-2024.12.22-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "95e37b454814615df23adfffb7f4898e077411a73383e17f16435f2990178638",
"md5": "37f36cf98d9405b24fe7df2e616db671",
"sha256": "b7a5a26dde0d35b82dfb6d2fda0795d2d280e25302ad2ea713fe3ea90acd939e"
},
"downloads": -1,
"filename": "botc_tokens-2024.12.22.tar.gz",
"has_sig": false,
"md5_digest": "37f36cf98d9405b24fe7df2e616db671",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 2656373,
"upload_time": "2024-12-22T17:39:55",
"upload_time_iso_8601": "2024-12-22T17:39:55.394218Z",
"url": "https://files.pythonhosted.org/packages/95/e3/7b454814615df23adfffb7f4898e077411a73383e17f16435f2990178638/botc_tokens-2024.12.22.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-22 17:39:55",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "botc-tokens"
}
