Install Familiar and create your first module.

Install

Install the alpha.

The campaign, module, rules, artifact, and print workflows are working. Public installers still need signing, notarization, and automated release packaging.

Collaborator source build

You will need Node.js 22 or newer, pnpm 10, Git, and access to the private source repository.

cd the-familiar-codex
pnpm install
pnpm dev:desktop

The development command starts the renderer and Electron shell together. Keep the terminal open while using the source build.

Agent access

Sign in to Codex.

Familiar does not include model usage. It connects to codex app-server, so the desktop app uses the same threads, approvals, questions, plans, and tool events as Codex.

Campaigns

Choose your campaign folder.

A Familiar campaign is a normal local folder. Start empty or use a folder with existing Markdown, images, PDFs, rules references, and notes. Familiar stores runtime state in .familiar/codex/; the campaign material remains readable outside the app.

my-campaign/
├── campaign.md
├── characters/
├── locations/
├── sessions/
├── artifacts/
├── modules/
└── .familiar/
    └── codex/

Your first conversation

1. 1

   Create a campaign or select an existing one from the left rail.

2. 2

   Start a conversation and describe the outcome you need, not only the prose you want.

3. 3

   Mention relevant party details, canon, intended session length, and rules system.

4. 4

   Let Familiar ask questions when a missing choice would materially change the result.

Module workflow

Use the staged module workflow.

Use this workflow when you want a complete adventure rather than a brainstorm. The desktop app and direct Codex use follow the same sequence.

1. 01
   Brief

   Familiar turns the request, party, canon, constraints, and desired output into a bounded ModuleBrief.

2. 02
   Hooks

   The agent develops three to five genuinely different directions instead of disguising one idea several ways.

3. 03
   Selection

   The run stops. You choose the direction worth making canon before the full draft begins.

4. 04
   Draft

   Codex writes the complete adventure inside the campaign workspace using the selected hook.

5. 05
   Evaluate

   Deterministic checks and a judge inspect continuity, table usability, rules references, and completeness.

6. 06
   Materialize

   One focused rewrite is allowed when needed, then Familiar creates linked artifacts, a bundle, and print outputs.

Write a better starting request

Create a one-session mystery for four level-3 characters.
Use the people and unresolved debts in this campaign.
Keep the threat intimate, include one social confrontation,
one dangerous location, and a player-facing handout.
Pause so I can choose the hook before drafting.

Files and ownership

Familiar saves editable files alongside the thread.

Familiar can split a completed module into linked artifacts such as NPCs, locations, encounters, secrets, and handouts. The module bundle remains native ModuleBundleV1, so other Familiar tools can read it without flattening the underlying files.

Printing

Review the PDFs before checkout.

The print flow renders the module, checks page count and trim requirements, produces separate cover and interior PDFs, and opens a private proof page. Nothing is sent to print until checkout is complete.

1. 1

   Review the interior PDF page by page and inspect the full cover spread.

2. 2

   Request a live price based on format, page count, destination, and shipping method.

3. 3

   Pay through Familiar’s branded Stripe Checkout.

4. 4

   Familiar submits the approved files to Lulu and keeps the private order page updated.

Architecture

What runs locally and what uses the web.

Troubleshooting

Fix common setup and order issues.