semvec/pypi-packages huggingface dataset:
toa-days 1.0.0
A tool to generate per-day stats for the DnD campaign Tomb of Annihilation.
License: MIT
Requires Python: >=3.8,<4.0

# Tomb of Annhillation Days

<p align="center">
    <i>A tool to generate per-day stats for the DnD campaign Tomb of Annihilation.</i>
    <br><br>
    <a href="https://github.com/psf/black">
        <img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg">
    </a>
    <a href="https://github.com/Nadock/toa_days/actions/workflows/pr_checks.yml">
        <img alt="Code Quality" src="https://github.com/Nadock/toa_days/actions/workflows/pr_checks.yml/badge.svg">
    </a>
    <a href="https://pypi.org/project/toa_days/">
        <img alt="PyPi" src="https://img.shields.io/pypi/v/toa_days">
    </a>
</p>

## Installation

Either, install from PyPi via:

```bash
$> pip install toa_days
```

or, clone the repo and use [Poetry] to install dependencies locally:

```bash
$> git clone git@github.com:Nadock/toa_days.git
$> cd ./toa_days
$> poetry shell
$> poetry install
```

## Usage

Running the CLI direcly will generate a single days worth of encounters as per the
random encounters table on page 194 and 195 of Tomb of Annihilation. See the `--help`
text for more options.

![CLI Screenshot](./img/cli_screenshot.png)

## Raw data

The raw data used for the encounter generation is available as JSON in
[:/toa_days/encounters.json](https://github.com/Nadock/toa_days/blob/main/toa_days/encounters.json).

The weather conditions are homebrew as there is not table provided in the source book.
The source book does contain detail on what mechanical effect `Heavy Rain` and
`Tropical Storm` have on the game (see page 11), the other weather conditions are
included for flavour only. The weather rolls use the following table:

| Condition      | d12 Result |
| -------------- | ---------- |
| Clear          | 1 - 2      |
| Light Rain     | 3 - 7      |
| Heavy Rain     | 8 - 11     |
| Tropical Storm | 12         |