Coffee Pub Blacksmith

Audience: everyone -- players, GMs, contributors, and developers building against the module.

Quality of life, gameplay frameworks, automation, and aesthetic improvements for D&D 5e on Foundry VTT, and the API hub of the Coffee Pub suite: the other Coffee Pub modules declare Blacksmith as a dependency and build on the surfaces documented here.

This page routes. Each section points at the document that answers the question rather than answering it here.

Building a module against Blacksmith

Start with the Core API. It covers declaring the dependency, getting the API object, the init and ready timing rules, registering your module, and a table routing every namespaced surface -- pins, chat cards, campaign context, compendiums, effects, statistics, sockets, GM notes, toasts, and tags -- to its own reference.

The sidebar lists every API document. The three most often needed after the core are the hook manager, sockets, and the window base.

Styling against Blacksmith

Design tokens are the variables to build on; components and patterns cover what is already built, and extending covers adding to it.

Working on Blacksmith itself

The architecture map is the entry point: bootstrap and lifecycle, the performance-critical designs, and the traps that have caught people before. Each subsystem then has its own architecture document, listed in the sidebar.

Known issues

Defects that are real and unfixed are in known issues.