# TheCrazyGM
> Storycraft for Dice & Delvers: Worldbuilding, open-licensed rules (Pathfinder 1e & D&D 5e), table tools, and machine-readable OGL/SRD reference.

TheCrazyGM is an open tabletop RPG knowledge base, compendium, and toolset for players and Game Masters. Built on licensed Open Game Content (OGL 1.0a and CC-BY-4.0), it provides reference materials, reverse dependency graphs, and clean API/markdown access for humans and AI agents.

This file is the front door: the endpoints to try first. [`/llms-full.txt`](/llms-full.txt) is the full manual (every Forge tool and payload, all list filters, the Worlds and Groups write surface).

## Start here

- [API Root](/api/v1/): links to every section; one hop confirms the response shape.
- [Systems](/api/v1/systems/): the systems on the site (`pf1e`, `dnd5e`) and which have a Forge. `dnd5e` is a library-only reference.
- [OpenAPI 3.0 Schema](/api/v1/schema/), [Swagger](/api/v1/docs/), [ReDoc](/api/v1/redoc/): the machine-readable contract.
- [Sitemap Index](/sitemap.xml): every system and entry.

## Every response has the same shape

- Success: `{"ok": true, "data": <list or record>, "meta": {...}}`. Lists put pagination (`count`, `page`, `page_size`, `next`, `previous`) in `meta`; add `?count_only=true` for just the count.
- Error: `{"ok": false, "error": {"code": "not_found", "detail": "..."}}`. Branch on `ok` or the HTTP status.
- Throttled: HTTP `429` with a `Retry-After` header (seconds). Back off for that long.
- The system is part of the URL for the public library, as in `/api/v1/pf1e/spells/`, not a query parameter.
- D&D 5e compendium records include a per-record `attribution` object with CC BY 4.0 links, exact cited-edition statements, the site's existing disclaimer pointer, and a factual change note; see `/llms-full.txt` for its fields.

## Key endpoints (no authentication)

- Search or list any content type: `GET /api/v1/<system>/<type>/?q=`, where `<type>` is, for example, `spells`, `feats`, `traits`, `classes`, `archetypes`, `races`, `skills`, `items`, `equipment` or `monsters` (not every type exists in both systems; `/api/v1/systems/` and `/llms-full.txt` list them). One record: `/api/v1/<system>/<type>/<slug>/`.
- Bestiary search: `GET /api/v1/<system>/monsters/?q=&cr_min=&cr_max=&monster_type=&environment=`. Each result's `id` is usable as `monster_id` in encounters.
- Books: [`/api/v1/pf1e/sources/`](/api/v1/pf1e/sources/) lists verified Pathfinder 1e books; `/api/v1/pf1e/sources/<slug>/` is one book with its Section 15 text.
- Publishers: [`/api/v1/publishers/`](/api/v1/publishers/).
- Public Worlds: [`/api/v1/worlds/`](/api/v1/worlds/) lists public campaign settings (`?q=`, `?system=`); `/api/v1/worlds/<slug>/` is one.
- Pricing: [`/api/v1/pricing/`](/api/v1/pricing/).
- Any compendium page as Markdown: send `Accept: text/markdown` or add `?format=md` (e.g. `/ogl/pf1e/spells/fireball/?format=md`, `/ogl/dnd5e/spells/`).

## With an API key

Create a personal key at `/account/keys/` and send `Authorization: Bearer cgm_...`. A key carries scopes:

- `profile:read`: who you are (`GET /api/v1/me/`).
- `worlds:read`, `worlds:write`: your Worlds, `/api/v1/me/worlds/`. Creating a World needs a power gem.
- `groups:write` (reads use `worlds:read`): your Player Groups, `/api/v1/me/groups/`. Groups are free.
- `forge:read`, `forge:write`: your homebrew, `/api/v1/me/forge/<type>/?system=pf1e` (monsters, spells, items, feats, traits, classes, encounters, and more).

Table accounts and above can mint the Worlds and Groups scopes; founders and staff also get the wallet and Forge scopes.

## Where the depth is

[`/llms-full.txt`](/llms-full.txt) covers the Forge write payloads, shared list filters, the source registry, character and monster build shapes, Worlds and Groups (members, content links, roles, the dice channel) and a typical agent workflow.

## Licensing & Provenance

- [OGL 1.0a Education Hub](/legal/ogl-1-0a/): Section 15 chain explanation, Open Game Content designation, and license guide.
- [Creative Commons CC-BY-4.0 Notice](/legal/cc-by-4-0/): Creative Commons attribution and terms.
- [Publishing Guide](/publish/): authoring and publishing OGL 1.0a homebrew with verifiable Section 15 provenance.
- [Legal Hub](/legal/): Terms of service, privacy policy, and acceptable use.