Skip to content
Familiar
Install
DiscordManage subscriptionStart your free trialInstall 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
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.

Paste an API key, point Familiar at the Claude, ChatGPT, Gemini, or Grok subscription you already pay for, or run a model on your own machine. Every path reaches the same 220 tools; the difference is where the model runs and who you pay.

Built-in chat

Paste an API key and start talking to your game.

No server, no terminal, no config files. Live transcription, voice dictation, auto-pilot for NPC turns (D&D 5e), slash commands, and drag-and-drop attachments only work here. A Thinking control lets you set how hard the model reasons, dialled up for hard fights, down for quick lookups.

Chat (16 providers)

  • OpenRouter
  • Anthropic
  • OpenAI
  • Google (Gemini)
  • Groq
  • Mistral
  • Together AI
  • DeepSeek
  • xAI
  • Cohere
  • Perplexity
  • Fireworks AI
  • Cerebras
  • SambaNova
  • NanoGPT
  • Local / custom server

OpenRouter unlocks 300+ models on a single key. Local / custom server points the built-in chat at any OpenAI-compatible server you run, from its own Local AI settings tab.

Voice (6 providers)

  • ElevenLabs
  • Cartesia
  • OpenAI TTS
  • OpenRouter TTS
  • NanoGPT TTS
  • Custom TTS

Image (5 providers)

  • OpenAI (GPT Image)
  • fal.ai
  • Leonardo AI
  • OpenRouter
  • NanoGPT

Transcription (3 providers)

  • Gladia
  • Deepgram
  • AssemblyAI
Familiar's built-in chat settings in Foundry: the AI provider set to OpenRouter (one key, 300+ models), an API key field noting the key is stored locally in your browser and never sent to a Familiar server, plus a model picker, a Thinking control for reasoning effort, and a streaming toggle.

Use your subscription

Already paying for Claude or SuperGrok, on any ChatGPT plan including Free, or have a Google account? Put it to work.

Connect through the Model Context Protocol and the plan you already have drives the same table from your own client at no extra token cost: the monsters' turns when you ask, every attack and spell checked against the 5e rules. The module ships with an MCP Setup Wizard: pick your client's card and it hands you the exact text, a config block to paste or a single command, secret already in it. Every card also carries a Copy help prompt for any AI chat you already have, the free web ones included: it explains, you type. Best for long, multi-step chains. Your model and its reasoning effort are set in your own client, not here.

MCP clients (7 providers)

Read the MCP setup guide

Familiar's MCP and subscription setup in Foundry: seven client cards in four groups, Claude Desktop and Claude Code under an Anthropic subscription, Codex CLI and the ChatGPT desktop app (Codex tab) under a ChatGPT account, Antigravity CLI and Antigravity Editor under a Google account, and Grok Build under a SuperGrok subscription.

Run it local

Your own machine, no per-token bill.

The same built-in chat, pointed at a server you run. Pick a preset, check the URL it fills in, and flip Use for chat on. Your hosted provider stays saved for switching back.

Runners

  • Ollama
  • LM Studio
  • llama.cpp
  • LiteLLM
  • Any OpenAI-compatible server

Read the local guide

Familiar's Local AI settings tab in Foundry: the Use for chat switch, a preset dropdown set to LM Studio, the base URL http://localhost:1234/v1, an optional API key field, a model id field, and a streaming toggle.

The rest of your setup

Two more pieces, 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

Your keys, your cost.

Most paid AI modules for Foundry route through their own servers and ration you by the message. Run out mid-session? Too bad. Familiar never proxies or marks up anything: your API keys go straight from your browser to the provider, and with MCP your subscription handles it. No middleman, no per-turn meter.

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