Skip to main content

Local-first CLI for turning tabletop RPG session exports into an Obsidian campaign vault

Project description

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.

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

chronicler_ttrpg-0.1.0.tar.gz (6.8 MB view details)

Uploaded Source

Built Distribution

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

chronicler_ttrpg-0.1.0-py3-none-any.whl (92.2 kB view details)

Uploaded Python 3

File details

Details for the file chronicler_ttrpg-0.1.0.tar.gz.

File metadata

  • Download URL: chronicler_ttrpg-0.1.0.tar.gz
  • Upload date:
  • Size: 6.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for chronicler_ttrpg-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d83b28d8642124a2d3f41f4c024884b42da4abe00feba0d2ac4169c496c4dabc
MD5 e69f060c9636f9d4bdeda6dacbe7da0d
BLAKE2b-256 3b03de69678577cb4700b2621ba75c636e9416817c9c31efd06f570847cdc89f

See more details on using hashes here.

Provenance

The following attestation bundles were made for chronicler_ttrpg-0.1.0.tar.gz:

Publisher: ci.yml on ScottSucksAtProgramming/chronicler

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file chronicler_ttrpg-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for chronicler_ttrpg-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fddf2a409f0f0db464cf31520a99f668cff6cead09c81cc9683a28ca14e4fb30
MD5 e0367f2299c5bac27b752a8070566073
BLAKE2b-256 c9c319715561a33cf975cd170d59b2796357014110393cc5e40d97723357c633

See more details on using hashes here.

Provenance

The following attestation bundles were made for chronicler_ttrpg-0.1.0-py3-none-any.whl:

Publisher: ci.yml on ScottSucksAtProgramming/chronicler

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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