Skip to content

API reference

One page per module, each rendering that module's public (importable) surface:

The pipeline

  • osrforge — osr-forge: convert tabletop adventure module PDFs into playable osrlib adventures (5 symbols)
  • osrforge.assemble — Stage 6: assembly — overrides application, the Adventure build, validation, report production, artifact writing (12 symbols)
  • osrforge.check — The playability lint and smoke delve: findings = check(workdir) (3 symbols)
  • osrforge.cli — The osrforge console script: convert, rerun, assemble, check, report, preview, and estimate (3 symbols)
  • osrforge.content — Stage 2: the content pass — per-level batched extraction of keyed areas (7 symbols)
  • osrforge.convert — The end-to-end conversion and its resume: preprocess → survey → content → monsters → mapread → assemble (7 symbols)
  • osrforge.errors — The osr-forge exception hierarchy (11 symbols)
  • osrforge.estimate — Cost estimation: preprocess only, then pure arithmetic — a rough token/cost estimate with no model call (8 symbols)
  • osrforge.evals — Eval scoring: truth-file models, alignment, and the pinned metric families (39 symbols)
  • osrforge.geometry — Stage 5: deterministic geometry synthesis from the extracted room graph, map proposals reconciled (6 symbols)
  • osrforge.mapread — Stage 4: the map-reading pass — one request per surveyed level over its printed map pages (6 symbols)
  • osrforge.monsters — Stage 3: monster resolution — extracted names against osrlib's shipped catalog, plus the stat-block pass (18 symbols)
  • osrforge.overrides — Overrides application: the human correction channel, applied inside assembly (10 symbols)
  • osrforge.pages — The shared interleaved text-plus-image request-part builder (2 symbols)
  • osrforge.preprocess — Stage 0: deterministic PDF preprocessing (1 symbols)
  • osrforge.previews — The deterministic SVG level renderer and the previews index page (4 symbols)
  • osrforge.reconcile — Deterministic reconciliation of prose edge facts with map proposals, plus the shared entrance selection (6 symbols)
  • osrforge.settings — Pipeline settings (1 symbols)
  • osrforge.statblocks — Shared structural parsing of printed stat-block lines — AC, Hit Dice, and class-level notations (4 symbols)
  • osrforge.survey — Stage 1: the survey pass — one structured-output request over the whole module, or chunked page windows (18 symbols)
  • osrforge.tracing.fivefoot — The 5-foot conversion: a panel read in 5-foot squares becomes 10-foot cells (3 symbols)
  • osrforge.tracing.images — The map images: each image a map page embeds, at the resolution the PDF stores it at (4 symbols)
  • osrforge.tracing.overlay — The overlay renderer: a panel's reading drawn over its map image (2 symbols)
  • osrforge.tracing.registration — Grid registration: the fit of the printed grid to each region of a map image, and the alignment of two halves (16 symbols)
  • osrforge.tracing.score — The scorer: how far a trace is from its answer key, one family of numbers at a time (19 symbols)
  • osrforge.tracing.stage — The tracing stage's entry point and its two provider roles (2 symbols)
  • osrforge.tracing.synthetic — The synthetic maps: pictures drawn from known levels, so their answers are exact (9 symbols)
  • osrforge.tracing.truth — The geometry truth format: what a map shows, and the levels and areas made from it (46 symbols)
  • osrforge.versioning — Artifact schema versioning for osr-forge's own artifacts (2 symbols)
  • osrforge.workdir — The per-module working directory: layout paths, run.json I/O, and the artifact writer (4 symbols)

Contracts

Providers