Skip to main content

Chronicler

Chronicler banner

CI PyPI version

Chronicler is an AI agent that turns tabletop RPG session recordings into a living Obsidian campaign vault. Feed it session PDFs or transcripts, and it extracts NPCs, locations, factions, plot threads, and key events — then writes linked notes you can actually use at the table.

macOS only. The Obsidian integration depends on the macOS desktop app.

Install

pip install chronicler-ttrpg

Then run the setup wizard:

chronicler config init
chronicler init

See docs/installation.md for prerequisites and a step-by-step walkthrough.

Quick Start

# Add your player characters
chronicler party add --player "Alice" --character "Nyra" --class "Wizard"

# Ingest a session
chronicler ingest --session 1 /path/to/session-01.pdf

# Review the vault
chronicler review
chronicler ask

The Quick Start guide walks through your first session end-to-end.

Documentation

Guide Contents
Installation Prerequisites, install options, initial config
Quick Start First session walkthrough
Command Reference Every command, flag, and example
Configuration All settings and environment variables
Workflows Backlog processing, active campaign, knowledge import
Troubleshooting Common errors and fixes
Development Dev environment, tests, contributing

License

GNU AGPL v3 or later — see LICENSE.

Release files for chronicler-ttrpg 0.1.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 chronicler-ttrpg 0.1.0
File Size Uploaded
chronicler_ttrpg-0.1.0.tar.gz 6.8 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for chronicler-ttrpg 0.1.0
File Interpreter ABI Platform
chronicler_ttrpg-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size:6.9 MB

Release files / chronicler_ttrpg-0.1.0.tar.gz

Download URL chronicler_ttrpg-0.1.0.tar.gz
Size 6.8 MB
Tags Source
SHA-256 checksum
How to use checksums
d83b28d8642124a2d3f41f4c024884b42da4abe00feba0d2ac4169c496c4dabc
BLAKE2b-256 checksum
How to use checksums
3b03de69678577cb4700b2621ba75c636e9416817c9c31efd06f570847cdc89f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 19, 2026.

Transparency log

Release files / chronicler_ttrpg-0.1.0-py3-none-any.whl

Download URL chronicler_ttrpg-0.1.0-py3-none-any.whl
Size 92.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fddf2a409f0f0db464cf31520a99f668cff6cead09c81cc9683a28ca14e4fb30
BLAKE2b-256 checksum
How to use checksums
c9c319715561a33cf975cd170d59b2796357014110393cc5e40d97723357c633
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 19, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

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