familiar-vtt 2.9.0 → 2.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -14
- package/dist/mcp-package/index.mjs +66 -66
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -143,7 +143,7 @@ Build NPCs, manage party inventory, apply buffs, and clone monsters from any com
|
|
|
143
143
|
|
|
144
144
|
**$3/month** with a **free 1-month trial** so you can try everything before you commit. All features are available during the trial, no restrictions.
|
|
145
145
|
|
|
146
|
-
Familiar itself costs $3/month. AI provider costs are separate and depend on your usage and chosen provider. A typical D&D session runs roughly **$0.50–$3** in API costs depending on the model, or **$0** if you use a subscription (Claude, ChatGPT/Codex, Gemini) through MCP or local models through Ollama.
|
|
146
|
+
Familiar itself costs $3/month. AI provider costs are separate and depend on your usage and chosen provider. A typical D&D session runs roughly **$0.50–$3** in API costs depending on the model, or **$0** if you use a subscription (Claude, ChatGPT/Codex, Antigravity/Gemini) through MCP or local models through Ollama.
|
|
147
147
|
|
|
148
148
|
### Your keys, your cost
|
|
149
149
|
|
|
@@ -155,7 +155,7 @@ Familiar works differently. You bring your own AI, whether that's an API key you
|
|
|
155
155
|
|
|
156
156
|
Install the Foundry module, pick a provider, and start talking to your game.
|
|
157
157
|
|
|
158
|
-
If you want to connect an MCP client (Claude Desktop, Claude Code, Codex CLI, Gemini CLI, or ChatGPT), you also need the MCP server:
|
|
158
|
+
If you want to connect an MCP client (Claude Desktop, Claude Code, Codex CLI / Desktop, Antigravity CLI / Editor, Gemini CLI, or ChatGPT), you also need the MCP server:
|
|
159
159
|
|
|
160
160
|
```sh
|
|
161
161
|
npx familiar-vtt
|
|
@@ -193,18 +193,22 @@ This is the right choice if you want the simplest setup, or if you want voice, i
|
|
|
193
193
|
|
|
194
194
|
### Option 2: MCP (your existing subscription)
|
|
195
195
|
|
|
196
|
-
Already paying for Claude, ChatGPT/Codex, or
|
|
196
|
+
Already paying for Claude, ChatGPT/Codex, Gemini, or have a Google account for Antigravity? Put that subscription to work. Connect it directly to Familiar through the [Model Context Protocol](https://modelcontextprotocol.io). Your subscription becomes a DM assistant at no extra API cost.
|
|
197
197
|
|
|
198
|
-
Familiar supports
|
|
198
|
+
Familiar supports eight MCP clients out of the box:
|
|
199
199
|
|
|
200
|
-
| Client | Transport | Setup |
|
|
201
|
-
|
|
202
|
-
| Claude Desktop | stdio | Add to `claude_desktop_config.json` with `env: { FAMILIAR_WS_SECRET }` |
|
|
203
|
-
| Claude Code (CLI) | stdio | `claude mcp add --env FAMILIAR_WS_SECRET=… familiar -- npx familiar-vtt` |
|
|
204
|
-
| Codex CLI | stdio | `codex mcp add familiar --env FAMILIAR_WS_SECRET=… -- npx -y familiar-vtt` |
|
|
205
|
-
| Codex Desktop | stdio | Add `[mcp_servers.familiar]` block to `~/.codex/config.toml` (shared with CLI / IDE) |
|
|
206
|
-
|
|
|
207
|
-
|
|
|
200
|
+
| Client | Subscription | Transport | Setup |
|
|
201
|
+
|--------|-------------|-----------|-------|
|
|
202
|
+
| Claude Desktop | Anthropic Pro / Max / Team | stdio | Add to `claude_desktop_config.json` with `env: { FAMILIAR_WS_SECRET }` |
|
|
203
|
+
| Claude Code (CLI) | Anthropic Pro / Max / Team | stdio | `claude mcp add --env FAMILIAR_WS_SECRET=… familiar -- npx familiar-vtt` |
|
|
204
|
+
| Codex CLI | ChatGPT Plus / Pro / Team | stdio | `codex mcp add familiar --env FAMILIAR_WS_SECRET=… -- npx -y familiar-vtt` |
|
|
205
|
+
| Codex Desktop | ChatGPT Plus / Pro / Team | stdio | Add `[mcp_servers.familiar]` block to `~/.codex/config.toml` (shared with CLI / IDE) |
|
|
206
|
+
| Antigravity CLI (`agy`) | Google free / Pro / Ultra | stdio | Generates `~/.gemini/config/mcp_config.json`; sign in via `agy` → Google OAuth |
|
|
207
|
+
| Antigravity Editor | Google free / Pro / Ultra | stdio | Add to `~/.gemini/antigravity/mcp_config.json` (desktop IDE; separate install from CLI) |
|
|
208
|
+
| Gemini CLI ¹ | Google | stdio | Add to MCP settings with the `env` block |
|
|
209
|
+
| ChatGPT | ChatGPT Plus / Pro / Team | Streamable HTTP | Remote URL via Cloudflare tunnel |
|
|
210
|
+
|
|
211
|
+
¹ *Gemini CLI is deprecated by Google on 2026-06-18 — use Antigravity CLI instead.*
|
|
208
212
|
|
|
209
213
|
You don't need to configure each client by hand. The **MCP Setup Wizard** in Module Settings → Familiar detects your connected client and generates the exact config — including the auto-generated `FAMILIAR_WS_SECRET` baked in. Copy and paste.
|
|
210
214
|
|
|
@@ -213,7 +217,7 @@ You don't need to configure each client by hand. The **MCP Setup Wizard** in Mod
|
|
|
213
217
|
| I want to... | Use |
|
|
214
218
|
|--------------|-----|
|
|
215
219
|
| Get started in under a minute | **Built-in chat** with any API key |
|
|
216
|
-
| Use my Claude/ChatGPT/Codex/Gemini subscription | **MCP** |
|
|
220
|
+
| Use my Claude / ChatGPT / Codex / Gemini / Antigravity subscription | **MCP** |
|
|
217
221
|
| Run everything offline | **Built-in chat** with Ollama or LM Studio |
|
|
218
222
|
| Have voice, images, and transcription | **Built-in chat** (MCP is text-only) |
|
|
219
223
|
| Run complex multi-step tasks | **MCP** (external clients handle long chains better) |
|
|
@@ -269,7 +273,7 @@ Built-in chat works anywhere Foundry runs, including The Forge. The module makes
|
|
|
269
273
|
<details>
|
|
270
274
|
<summary><b>What's the difference between MCP mode and built-in chat?</b></summary>
|
|
271
275
|
|
|
272
|
-
Built-in chat runs inside Foundry with no extra server. The fastest way to start. MCP connects Familiar to external clients (Claude Desktop, Codex CLI, ChatGPT, Gemini) through a local server, letting you use existing subscriptions and handling complex multi-step tasks better. Both have access to the same 188 tools.
|
|
276
|
+
Built-in chat runs inside Foundry with no extra server. The fastest way to start. MCP connects Familiar to external clients (Claude Desktop, Codex CLI / Desktop, Antigravity CLI / Editor, ChatGPT, Gemini) through a local server, letting you use existing subscriptions and handling complex multi-step tasks better. Both have access to the same 188 tools.
|
|
273
277
|
|
|
274
278
|
</details>
|
|
275
279
|
|