familiar-vtt 2.5.22 → 2.8.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.
Files changed (3) hide show
  1. package/README.md +101 -69
  2. package/dist/mcp-package/index.mjs +84 -53
  3. package/package.json +15 -14
package/README.md CHANGED
@@ -4,31 +4,19 @@
4
4
 
5
5
  ### Your AI co-pilot for Foundry VTT
6
6
 
7
- **185 tools. 26 AI providers. Zero prep.**
7
+ **188 tools. 26 AI providers. Zero prep.**
8
8
 
9
- Run combat, set the mood, and voice your NPCs - all by talking to your AI.
9
+ Run combat, set the mood, and voice your NPCs, all by talking to your AI.
10
10
 
11
11
  [![Foundry v13+](https://img.shields.io/badge/Foundry-v13%2B-orange?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA1MTIgNTEyIj48cGF0aCBmaWxsPSIjZmZmIiBkPSJNMjU2IDhDMTE5LjA0MyA4IDggMTE5LjA4MyA4IDI1NmMwIDEzNi45OTcgMTExLjA0MyAyNDggMjQ4IDI0OHMyNDgtMTExLjAwMyAyNDgtMjQ4QzUwNCAxMTkuMDgzIDM5Mi45NTcgOCAyNTYgOHoiLz48L3N2Zz4=)](https://foundryvtt.com)
12
12
  [![npm](https://img.shields.io/npm/v/familiar-vtt?color=blue&label=npm)](https://www.npmjs.com/package/familiar-vtt)
13
- [![Discord](https://img.shields.io/discord/1361024685498564744?logo=discord&label=Discord&color=5865F2)](https://discord.gg/3633wB9yp)
13
+ [![Discord](https://img.shields.io/discord/1483457566594961419?logo=discord&label=Discord&color=5865F2)](https://discord.gg/pN6pEvYH)
14
14
  [![License](https://img.shields.io/badge/license-PolyForm%20Shield-lightgrey)](#license)
15
15
 
16
16
  [Installation](#installation) | [Connect Your AI](#connect-your-ai) | [Pricing](#pricing) | [FAQ](#faq) | [Roadmap](#roadmap)
17
17
 
18
18
  </div>
19
19
 
20
- ## The story behind Familiar
21
-
22
- I'm Ryan. Dad of two young kids, married to my favorite person, and perpetually short on free time.
23
-
24
- My wife and I play D&D together, just the two of us, 1-on-1 campaigns. It's our thing. But solo DMing is a lot. You're the storyteller, every NPC, the rules engine, the sound guy, and the atmosphere all at once. I'd be mid-monologue as a mysterious stranger and then have to break character to roll initiative, look up a spell range, adjust the lighting, and find that one tavern ambience track I swore I bookmarked. By the time I got back to the scene, the moment was gone.
25
-
26
- I wanted something that could handle the mechanical side of the table so I could stay in the story. Not a replacement DM, a co-pilot. Something I could say "roll initiative for the goblins, dim the torches, and start combat music" to, and it would just... do it. While I kept talking.
27
-
28
- So I started building. First it was a handful of tools to move tokens and roll dice. Then I added combat tracking. Then scene management. Then I thought "what if it could also generate NPC portraits on the fly?" and "what if it could voice the tavern keeper?" and that's basically how you end up with 185 tools across 24 domains and 26 AI providers.
29
-
30
- It started as a personal itch-scratcher for a dad who wanted to run better D&D games for his wife. It turns out a lot of GMs have the same itch.
31
-
32
20
  ## What can Familiar do?
33
21
 
34
22
  Ask your AI to do things that would normally take you minutes of clicking through menus:
@@ -41,9 +29,9 @@ Ask your AI to do things that would normally take you minutes of clicking throug
41
29
 
42
30
  > "Find a CR 3 werewolf in the compendium, drop it into the scene as a boss, and give it resistance to non-silvered weapons."
43
31
 
44
- > "We're done for tonight. Summarize what happened this session and save it."
32
+ > "We're done for tonight. Summarize what happened and save it."
45
33
 
46
- Familiar exposes **185 tools across 24 domains** through the Model Context Protocol. Five core bundles are always available; the rest load on demand when your AI needs them.
34
+ Familiar exposes **188 tools across 24 domains** through the Model Context Protocol. Tools load as your AI needs them. No upfront configuration.
47
35
 
48
36
  ### Highlights
49
37
 
@@ -53,44 +41,67 @@ Familiar exposes **185 tools across 24 domains** through the Model Context Proto
53
41
 
54
42
  **Combat & AI**
55
43
 
56
- 29 tools manage encounters end-to-end: initiative, attacks, spells, damage, conditions, death saves, and XP. The AI can pilot NPC turns using battlefield snapshots, scored movement with cover analysis, and full action resolution including multiattack and legendary actions.
44
+ 29 tools cover encounters end to end: initiative, attacks, spells, damage, conditions, death saves, and XP. NPCs make their own tactical decisions using battlefield snapshots, scored movement, and cover analysis.
57
45
 
58
46
  </td>
59
47
  <td width="33%" valign="top">
60
48
 
61
- **Voice & Image Generation**
49
+ **Auto-Pilot**
62
50
 
63
- Assign unique AI voices to NPCs and bring dialogue to life with multi-voice text-to-speech across four providers. Generate character portraits, item art, and battle map backgrounds on the fly.
51
+ Click "Run NPC" and walk away. Familiar plays every enemy turn in the encounter for you, with safety caps and optional turn-by-turn confirmation.
64
52
 
65
53
  </td>
66
54
  <td width="33%" valign="top">
67
55
 
68
- **Scenes & Canvas**
56
+ **Live Transcription**
69
57
 
70
- Create scenes, place tokens, draw walls and doors, set lighting and darkness, add weather effects, and configure trigger regions. Full control over tiles, drawings, ambient sounds, fog of war, and camera.
58
+ Speak instead of type. Familiar transcribes your session in real time across three providers, color-codes per speaker, and saves the transcript to a Foundry journal.
71
59
 
72
60
  </td>
73
61
  </tr>
74
62
  <tr>
75
63
  <td width="33%" valign="top">
76
64
 
65
+ **Scenes & Canvas**
66
+
67
+ Create scenes, place tokens, draw walls and doors, set lighting and darkness, add weather effects, and configure trigger regions. Full control over tiles, drawings, ambient sounds, fog of war, and camera.
68
+
69
+ </td>
70
+ <td width="33%" valign="top">
71
+
72
+ **Voice & Image Generation**
73
+
74
+ Assign unique AI voices to NPCs across four providers. Have the tavern keeper actually speak his lines, in his own voice. Generate character portraits, item art, and battle map backgrounds on the fly.
75
+
76
+ </td>
77
+ <td width="33%" valign="top">
78
+
77
79
  **Audio & Atmosphere**
78
80
 
79
- Play, stop, and manage playlists and individual tracks with volume and fade control. Cue battle music, build ambient soundscapes, or silence everything without touching Foundry's sidebar.
81
+ Play, stop, and crossfade playlists and individual tracks with volume and fade control. Cue battle music, build ambient soundscapes, or silence everything without touching Foundry's sidebar.
80
82
 
81
83
  </td>
84
+ </tr>
85
+ <tr>
82
86
  <td width="33%" valign="top">
83
87
 
84
88
  **Knowledge & Memory**
85
89
 
86
- Semantic search across all journals, characters, scenes, and items. A persistent memory bank stores important campaign facts that carry over between sessions, with full journal management for session notes and handouts.
90
+ Semantic search across every journal, character, scene, and item. A persistent memory bank stores campaign facts that carry over between sessions, plus a continuously-rewritten plot summary the GM can read later.
91
+
92
+ </td>
93
+ <td width="33%" valign="top">
94
+
95
+ **Multi-Session Chat**
96
+
97
+ Pin, archive, and switch between named campaign threads. Each thread persists as a Foundry journal entry with a full audit log, so you can return to any conversation later.
87
98
 
88
99
  </td>
89
100
  <td width="33%" valign="top">
90
101
 
91
102
  **Characters & Items**
92
103
 
93
- Inspect, create, update, and clone actors, inventory, spells, features, and active effects. Import from compendiums, apply custom buffs, and manage player ownership.
104
+ Build NPCs, manage party inventory, apply buffs, and clone monsters from any compendium. Active effects, ownership, and player permissions all wired up.
94
105
 
95
106
  </td>
96
107
  </tr>
@@ -104,7 +115,7 @@ Inspect, create, update, and clone actors, inventory, spells, features, and acti
104
115
  | **Scenes & Tokens** | 19 | Build scenes, place and move tokens, configure vision and movement |
105
116
  | **Canvas Environment** | 18 | Walls, lights, weather effects, fog of war, darkness levels |
106
117
  | **Combat & Initiative** | 17 | Start encounters, roll initiative, advance turns and rounds |
107
- | **Characters & Actors** | 14 | Create, inspect, update, and manage player characters and NPCs |
118
+ | **Characters & Actors** | 16 | Create, inspect, update, and manage player characters and NPCs |
108
119
  | **Audio & Playlists** | 14 | Play, stop, and crossfade music and ambient sound |
109
120
  | **Combat AI** | 12 | NPC tactical decisions, target selection, ability usage, positioning |
110
121
  | **Journals & Notes** | 10 | Create and edit journal entries, map pins, and handouts |
@@ -112,7 +123,7 @@ Inspect, create, update, and clone actors, inventory, spells, features, and acti
112
123
  | **Canvas Drawing** | 8 | Draw shapes, text, and freehand annotations on the canvas |
113
124
  | **Rollable Tables** | 7 | Create tables and roll on them for random encounters or loot |
114
125
  | **Macros** | 7 | Create, edit, and execute Foundry macros |
115
- | **World & System** | 6 | World info, system settings, time, pause, and user management |
126
+ | **World & System** | 7 | World info, system settings, time, pause, and user management |
116
127
  | **Items** | 6 | Create, update, delete, and search world-level items |
117
128
  | **Active Effects** | 5 | Apply, remove, and toggle buffs, debuffs, and status effects |
118
129
  | **Folders** | 5 | Organize documents into folder hierarchies |
@@ -128,17 +139,29 @@ Inspect, create, update, and clone actors, inventory, spells, features, and acti
128
139
 
129
140
  </details>
130
141
 
142
+ ## Pricing
143
+
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
+
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.
147
+
148
+ ### Your keys, your cost
149
+
150
+ Most AI tabletop tools lock you into their ecosystem. They charge per turn, per credit, or per token, and you're stuck with whatever model they picked for you. Run out of credits mid-session? Too bad.
151
+
152
+ Familiar works differently. You bring your own AI, whether that's an API key you already have or a subscription to Claude, ChatGPT/Codex, or Gemini. Familiar never proxies, meters, or marks up your usage. Your API keys go straight from your browser to the provider. With MCP, your existing subscription handles it. There's no middleman, no per-turn limits, and no credits that run out.
153
+
131
154
  ## Installation
132
155
 
133
156
  Install the Foundry module, pick a provider, and start talking to your game.
134
157
 
135
- If you want to connect an MCP client (Claude Desktop, Claude Code, 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, Gemini CLI, or ChatGPT), you also need the MCP server:
136
159
 
137
160
  ```sh
138
161
  npx familiar-vtt
139
162
  ```
140
163
 
141
- The **MCP Setup Wizard** in Module Settings > Familiar walks you through connecting your client step by step.
164
+ The **MCP Setup Wizard** in Module Settings → Familiar walks you through connecting your client step by step. No JSON editing.
142
165
 
143
166
  ### Compatibility
144
167
 
@@ -149,127 +172,138 @@ The **MCP Setup Wizard** in Module Settings > Familiar walks you through connect
149
172
 
150
173
  ## Connect your AI
151
174
 
152
- There are two ways to connect an AI to your game. Both give the AI the same tools, the difference is where the AI runs and how you pay.
175
+ There are two ways to connect an AI to your game. Both give the AI the same 188 tools. The difference is where the model runs and how you pay.
153
176
 
154
177
  ### Option 1: Built-in chat (API key)
155
178
 
156
- No server. No terminal. No config files. Just install the module, pick a provider, paste an API key, and start talking to your game.
179
+ No server. No terminal. No config files. Install the module, pick a provider, paste an API key, and start talking.
157
180
 
158
181
  Familiar connects directly to **26 AI providers** across four categories:
159
182
 
160
183
  | Category | Providers |
161
184
  |----------|-----------|
162
- | **Chat** (16) | OpenRouter, Anthropic, OpenAI, Google, Groq, Mistral, Together AI, DeepSeek, xAI, Cohere, Perplexity, Fireworks AI, Cerebras, SambaNova, Ollama (local), LM Studio (local) |
185
+ | **Chat** (16) | OpenRouter¹, Anthropic, OpenAI, Google, Groq, Mistral, Together AI, DeepSeek, xAI, Cohere, Perplexity, Fireworks AI, Cerebras, SambaNova, Ollama (local), LM Studio (local) |
163
186
  | **Voice** (4) | ElevenLabs, Cartesia, OpenAI TTS, PlayHT |
164
187
  | **Image** (3) | OpenAI (GPT Image), fal.ai, Leonardo AI |
165
188
  | **Transcription** (3) | Gladia, Deepgram, AssemblyAI |
166
189
 
167
- This is the right choice if you want the simplest setup, or if you want voice, images, and transcription alongside chat. It is also the only option that supports local models (Ollama, LM Studio) for fully offline play.
190
+ ¹ *OpenRouter unlocks 300+ models on a single key.*
191
+
192
+ This is the right choice if you want the simplest setup, or if you want voice, images, and live transcription alongside chat. It's also the only option that supports local models (Ollama, LM Studio) for fully offline play.
168
193
 
169
194
  ### Option 2: MCP (your existing subscription)
170
195
 
171
- Already paying for Claude, ChatGPT, or Gemini? Put that subscription to work. Connect them directly to Familiar through the [Model Context Protocol](https://modelcontextprotocol.io). Your subscription becomes a DM assistant at no extra API cost.
196
+ Already paying for Claude, ChatGPT/Codex, or Gemini? 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.
172
197
 
173
- Familiar supports four MCP clients out of the box:
198
+ Familiar supports five MCP clients out of the box:
174
199
 
175
200
  | Client | Transport | Setup |
176
201
  |--------|-----------|-------|
177
202
  | Claude Desktop | stdio | Add to `claude_desktop_config.json` |
178
203
  | Claude Code (CLI) | stdio | `claude mcp add familiar -- npx familiar-vtt` |
179
- | Gemini CLI | stdio | Add to MCP settings (free with Gemini 3.1 Pro) |
204
+ | Codex CLI | stdio | `codex mcp add familiar -- npx -y familiar-vtt` |
205
+ | Gemini CLI | stdio | Add to MCP settings |
180
206
  | ChatGPT | Streamable HTTP | Remote URL via Cloudflare tunnel |
181
207
 
182
- The MCP server ships as an npm package:
183
-
184
- ```bash
185
- npx familiar-vtt
186
- ```
187
-
188
- You do not need to configure each client by hand. The module includes a step-by-step **MCP Setup Wizard** (in Module Settings > Familiar) that detects your connected client and generates the exact config, just copy and paste.
208
+ 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. Copy and paste.
189
209
 
190
210
  ### Which should I pick?
191
211
 
192
212
  | I want to... | Use |
193
213
  |--------------|-----|
194
214
  | Get started in under a minute | **Built-in chat** with any API key |
195
- | Use my Claude/ChatGPT/Gemini subscription | **MCP** |
215
+ | Use my Claude/ChatGPT/Codex/Gemini subscription | **MCP** |
196
216
  | Run everything offline | **Built-in chat** with Ollama or LM Studio |
197
217
  | Have voice, images, and transcription | **Built-in chat** (MCP is text-only) |
198
218
  | Run complex multi-step tasks | **MCP** (external clients handle long chains better) |
199
219
 
200
- ### Your keys, your cost
220
+ ## Works with what you already have
201
221
 
202
- Most AI tabletop tools lock you into their ecosystem. They charge per turn, per credit, or per token, and you're stuck with whatever model they picked for you. Run out of credits mid-session? Too bad.
222
+ Familiar works best when there's already great content in your world. The Foundry community has spent years building incredible modules, battle maps, character sheets, compendium packs, and ready-to-play adventures. Familiar doesn't try to replace any of that. It reads what's already there and uses it.
203
223
 
204
- Familiar works differently. You bring your own AI, whether that is an API key you already have or a subscription to Claude, ChatGPT, or Gemini. Familiar never proxies, meters, or marks up your usage. Your API keys go straight from your browser to the provider. With MCP, your existing subscription handles it. There is no middleman, no per-turn limits, and no credits that run out.
224
+ Those compendium entries with pre-built monsters, spells, and items? The AI pulls from them instead of making things up. That beautifully lit dungeon map someone spent weeks on? The AI can place tokens on it, trigger the right music, and run the encounter. The more content your world has, the better Familiar gets.
205
225
 
206
- ## Works with what you already have
226
+ ## Why I built this
207
227
 
208
- Familiar works best when there is already great content in your world. The Foundry community has spent years building incredible modules, battle maps, character sheets, compendium packs, and ready-to-play adventures. Familiar does not try to replace any of that. It reads what is already there and uses it.
228
+ I'm Ryan. Dad of two young kids, married to my favorite person, with the free time you'd expect.
209
229
 
210
- Those compendium entries with pre-built monsters, spells, and items? The AI pulls from them instead of making things up. That beautifully lit dungeon map someone spent weeks on? The AI can place tokens on it, trigger the right music, and run the encounter. The more content your world has, the better Familiar gets.
230
+ My wife and I play D&D together, just the two of us, 1-on-1 campaigns. It's our thing. But solo DMing is a lot. You're the storyteller, every NPC, the rules engine, the sound guy, and the atmosphere all at once. Mid-monologue as a mysterious stranger, I'd have to break character to roll initiative, look up a spell range, adjust the lighting, and find that one tavern ambience track I swore I bookmarked. By the time I got back to the scene, the moment was gone.
211
231
 
212
- ## Pricing
232
+ I wanted something that could handle the mechanical side of the table so I could stay in the story. Not a replacement DM, a co-pilot. Something I could say "roll initiative for the goblins, dim the torches, and start combat music" to, and it would handle it. While I kept talking.
213
233
 
214
- **$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.
234
+ So I started building. First it was a handful of tools to move tokens and roll dice. Then I added combat tracking. Then scene management. Then "what if it could also generate NPC portraits on the fly?" and "what if it could voice the tavern keeper?" That's how you end up with 188 tools across 24 domains and 26 AI providers.
215
235
 
216
- 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, Gemini) through MCP or local models through Ollama.
236
+ It started as a personal itch-scratcher for a dad who wanted to run better D&D games for his wife. It turns out a lot of GMs have the same itch.
217
237
 
218
238
  ## FAQ
219
239
 
220
240
  <details>
221
241
  <summary><b>Does Familiar collect my data?</b></summary>
222
242
 
223
- No. There is no telemetry, no analytics, and no data collection of any kind. Familiar runs entirely inside your local Foundry instance. Your data only leaves your machine when you choose to send a message to an external AI provider. If you use local models through Ollama or LM Studio, nothing ever leaves your network.
243
+ No. There's no telemetry, no analytics, and no data collection of any kind. Familiar runs entirely inside your local Foundry instance. Your data only leaves your machine when you choose to send a message to an external AI provider. If you use local models through Ollama or LM Studio, nothing ever leaves your network.
224
244
 
225
245
  </details>
226
246
 
227
247
  <details>
228
248
  <summary><b>Can the AI break my world?</b></summary>
229
249
 
230
- Familiar sanitizes all document updates so the AI cannot change ownership, permissions, or internal IDs. Prototype pollution protection is built in, destructive operations require confirmation, and WebSocket connections use shared-secret authentication. That said, always keep backups of your world, that is good practice regardless.
250
+ Familiar sanitizes all document updates so the AI can't change ownership, permissions, or internal IDs. Prototype pollution protection is built in, destructive operations require confirmation, and WebSocket connections use shared-secret authentication. Always keep backups regardless. Good practice with or without AI.
251
+
252
+ </details>
253
+
254
+ <details>
255
+ <summary><b>What happens to my data if I cancel?</b></summary>
256
+
257
+ Everything stays in your Foundry world. Memory banks, knowledge base indexes, session transcripts, generated portraits, all of it lives in your local Foundry data directory, owned by your world. Cancelling stops Familiar from running new tool calls once the license check fails, but nothing the AI already created gets touched.
258
+
259
+ </details>
260
+
261
+ <details>
262
+ <summary><b>Does this work on The Forge or other hosted Foundry providers?</b></summary>
263
+
264
+ Built-in chat works anywhere Foundry runs, including The Forge. The module makes API calls directly from the browser. MCP mode is trickier: it needs a local MCP server alongside Foundry, so hosted providers without shell access can't run the server. Use built-in chat for hosted Foundry, MCP for self-hosted.
231
265
 
232
266
  </details>
233
267
 
234
268
  <details>
235
- <summary><b>What is the difference between MCP mode and built-in chat?</b></summary>
269
+ <summary><b>What's the difference between MCP mode and built-in chat?</b></summary>
236
270
 
237
- Built-in chat runs directly inside Foundry with no server required, it makes API calls straight to your AI provider and is the fastest way to get started. MCP mode connects Familiar to external clients like Claude Desktop, ChatGPT, or Gemini through a local server, which lets you use your existing subscriptions and is more powerful for complex multi-step tasks. Both modes have access to the same 185 tools.
271
+ 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.
238
272
 
239
273
  </details>
240
274
 
241
275
  <details>
242
276
  <summary><b>Which AI models work best?</b></summary>
243
277
 
244
- For the best experience: Claude Opus 4.6 or Sonnet 4.6 (Anthropic), GPT-5.4 (OpenAI), Gemini 3.1 Pro (Google), Grok 4 (xAI), Mistral 3 (Mistral), or DeepSeek V3.2 (DeepSeek).
278
+ For the best experience: Claude Opus 4.7 or Sonnet 4.6 (Anthropic), GPT-5.5 (OpenAI), Gemini 3.1 Pro (Google), Grok 4.3 (xAI), Mistral Large 3 (Mistral), or DeepSeek V3.2 (DeepSeek).
245
279
 
246
280
  </details>
247
281
 
248
282
  <details>
249
283
  <summary><b>Can I use this for solo play?</b></summary>
250
284
 
251
- Absolutely, solo and small-group play is one of the main use cases. I built Familiar for 1-on-1 D&D campaigns with my wife. The AI can run NPCs, manage encounters, describe scenes, and help with rulings so you can play without a dedicated DM.
285
+ Absolutely. Solo and small-group play is one of the main use cases. I built Familiar for 1-on-1 D&D campaigns with my wife. The AI can run NPCs, manage encounters, describe scenes, and help with rulings so you can play without a dedicated DM.
252
286
 
253
287
  </details>
254
288
 
255
289
  <details>
256
290
  <summary><b>Can I use Familiar as a player (not a GM)?</b></summary>
257
291
 
258
- Familiar requires GM permissions. It is designed as a GM tool that reads and modifies world data. Players can interact with it through the built-in chat if the GM enables it, but the module itself needs GM-level access to function.
292
+ Familiar requires GM permissions. It's designed as a GM tool that reads and modifies world data. Players can interact with it through the built-in chat if the GM enables it, but the module itself needs GM-level access to function.
259
293
 
260
294
  </details>
261
295
 
262
296
  <details>
263
297
  <summary><b>Does it work with game systems other than D&D 5e?</b></summary>
264
298
 
265
- Familiar is designed and tested for D&D 5e (2024 rules) on Foundry VTT. Basic features like dice rolling, scene management, and journal editing work with other systems, but system-specific tools (character creation, spell resolution, combat automation) are built around the dnd5e data model and are not officially supported elsewhere.
299
+ Familiar is designed and tested for D&D 5e (2024 rules). Basic features like dice rolling, scene management, and journal editing work with other systems, but system-specific tools (character creation, spell resolution, combat automation) are built around the dnd5e data model and won't work elsewhere without changes.
266
300
 
267
301
  </details>
268
302
 
269
303
  <details>
270
304
  <summary><b>Will Familiar conflict with my other Foundry modules?</b></summary>
271
305
 
272
- No. Familiar operates through its own namespaced flags and does not monkey-patch or override core Foundry functionality. It works alongside any other module you have installed.
306
+ No. Familiar operates through its own namespaced flags and doesn't monkey-patch or override core Foundry functionality. It works alongside any other module you have installed.
273
307
 
274
308
  </details>
275
309
 
@@ -279,11 +313,10 @@ Things I'm actively working toward. No promises on timelines.
279
313
 
280
314
  ### Module Integrations
281
315
 
282
- Let the AI control the most popular Foundry modules - automated rolls, visual effects, animations, loot, and more.
316
+ Let the AI control the most popular Foundry modules: automated rolls, visual effects, animations, loot, and more.
283
317
 
284
318
  | Module | What Familiar will do with it |
285
319
  |--------|-------------------------------|
286
- | Midi-QOL | Automated attack rolls, saving throws, and damage application |
287
320
  | Sequencer + JB2A | Orchestrate animation sequences and trigger spell effects |
288
321
  | Token Magic FX | Apply shader effects to tokens and tiles (fire auras, glowing shields) |
289
322
  | Item Piles | Create and manage loot drops, merchants, and treasure hoards |
@@ -306,15 +339,14 @@ Expanding beyond D&D 5e with full system-specific tools (character sheets, comba
306
339
 
307
340
  ### Improvements
308
341
 
309
- - **Combat AI**: smarter NPC tactics, group coordination, retreat behavior, morale
310
- - **Voice generation**: more natural NPC voices, emotion control, multi-voice conversations
311
- - **Built-in chat**: conversation memory across sessions, campaign knowledge base, auto-summarization
342
+ - **Combat AI**: retreat behavior, morale, group coordination beyond what shipped
343
+ - **Voice generation**: emotion control, more natural multi-voice conversations
312
344
  - **Image generation**: consistent character portraits across sessions, style presets
313
- - **MCP**: faster tool execution, better multi-step task handling, richer feedback to clients
345
+ - **MCP**: richer `notifications/message` feedback so external clients see tool progress in real time
314
346
 
315
347
  ## Feedback
316
348
 
317
- Join the [Discord](https://discord.gg/3633wB9yp) - bug reports, feature ideas, or just tell me about the weird thing the AI did to your goblin encounter.
349
+ Join the [Discord](https://discord.gg/pN6pEvYH) for bug reports, feature ideas, or just tell me about the weird thing the AI did to your goblin encounter.
318
350
 
319
351
  ## License
320
352