Skip to content
Familiar
Install
DiscordInstall in Foundry

Step 1 of 2

Install Familiar in Foundry VTT

Familiar is in the official Foundry package directory. Search for it, install it from The Forge's Bazaar, or paste the manifest URL. All three install the current release; the first and last use Foundry's own Install Module dialog.

Recommended

Foundry's package browser

  1. In Foundry, open Configuration then Add-on Modules.
  2. Click Install Module.
  3. Search "Familiar", then click Install.
  4. Enable Familiar in your world, then paste your licence key and click Activate.
Recommended on The Forge

The Forge Bazaar

Hosted on forge-vtt.com? Install from the Bazaar instead of the Foundry dialog.

  1. On The Forge, open the Bazaar, then Modules.
  2. Search "Familiar", then click Install.
  3. Enable Familiar in your world, then paste your licence key and click Activate.
Alternative

Manifest URL

If you would rather paste it in, the manifest URL installs the same release from the same dialog.

  1. Paste the URL into the Manifest URL field at the bottom of the same dialog.
  2. Click Install.
  3. Enable Familiar in your world, then paste your licence key and click Activate.
Manifest URL: https://github.com/Ryanjansen92/familiar-releases/releases/latest/download/module.json

Compatibility

Foundry VTT
v13, v14
Game System
D&D 5e (2024 rules): full support, rules engine included. Every other system: everything except refereeing combat, with your characters read as your own system stores them. See what it does on your game system
Node.js
22 or newer, for the MCP path only. The built-in chat needs nothing but Foundry.
See the Install Module dialog
Foundry's Install Module dialog, with the package search box at the top and the Manifest URL field at the bottom.

Step 2 of 2

Connect the AI you already use.

Each route has its own tab in Familiar's settings: Chat for your own API key, MCP / Subs for your Claude, ChatGPT, Gemini, Grok or Muse Code account, and Local / Custom for a model on your own machine.

  • Built-in chat, your key

    Paste an API key into the Chat tab, pick a model, and talk to your world from a window inside Foundry. Live transcription, dictation and Auto-Pilot only run here.

    Which model to pick

  • MCP, your subscription

    Pick your client's card in the setup wizard and it hands you the exact text, a config block or a single command.

    • Claude Desktop
    • Claude Code
    • Codex CLI
    • ChatGPT desktop app (Codex tab)
    • Antigravity CLI
    • Antigravity Editor
    • Grok Build CLI
    • Muse Code
    How MCP connects
Familiar's MCP and subscription setup in Foundry: eight client cards in five groups, Claude Desktop and Claude Code under an Anthropic subscription with Claude Code's dot lit green, Codex CLI and the ChatGPT desktop app (Codex tab) under a ChatGPT account, Antigravity CLI and Antigravity Editor under a free Google account, Grok Build under a SuperGrok subscription, and Muse Code under a Meta account.

The AI bill stays with your provider: a key bills at list price, a subscription covers the AI side, and Familiar takes a cut of neither. Voice, images and music bill their own keys on both paths.

Every provider and client that connects

The rest of your setup

Two more pieces, only if your table uses them, and neither one is a model. One is where your prep lives, the other is where Foundry itself does.

  • Your Obsidian vault

    Prep stays where you write it. Install Obsidian's community Local REST API plugin, point the Notes tab at your vault or at only the folders you name, and Familiar reads and searches those notes mid-session. It never writes back.

    Read the Obsidian guide

  • Hosted Foundry

    The Forge, another host, or a box under your desk. Familiar calls your AI from the browser, so whatever runs on your own computer stays reachable and the host never sits in the path. Hosted play does set a few conditions on the MCP side.

    What hosted play needs

Installed and connected? Ask it something.

Open Familiar's chat in your world and ask what it sees: it reads the scene your party is standing in and answers from there. The long version of this page, with the Foundry versions and what to type first, is the setup guide.

Stuck on a step? I'm Ryan, I built Familiar, and the Discord is where I answer setup questions myself.

Read the setup guideJoin the Discord