Skip to main content

Foundry Familiar

An AI-powered magical assistant for your FoundryVTT campaigns.

🧙 What is Foundry Familiar?​

Foundry Familiar brings the power of artificial intelligence directly into your FoundryVTT interface. Like a magical familiar that has read all your campaign notes, this AI assistant can answer questions about your world, summarize journal entries, and help you manage your campaign more effectively.

⚠️ Early Alpha Status​

VERY LIMITED TESTING - Only tested with Ollama using the qwen3 model so far.

Other AI services (OpenAI, etc.) are completely untested. Not recommended for active games.

🎯 Perfect For​

Game Masters who want to:​

  • Quick Reference: Ask questions about your campaign without digging through notes
  • Session Prep: Get AI-generated summaries of previous sessions or story arcs
  • Creative Assistance: Brainstorm ideas with an AI that knows your world
  • Campaign Management: Keep track of storylines and character relationships

Key Benefits:​

  • 🎯 Context-Aware: The AI reads your actual journal entries and world content
  • 🔄 System Agnostic: Works with any game system in FoundryVTT
  • 🏠 Privacy Options: Use local AI models or cloud services - your choice
  • ⚡ Instant Access: Available directly in your FoundryVTT interface

🚀 Quick Start​

  1. Install: Download from GitHub releases
  2. Enable: Activate in your world's module settings
  3. Configure: Set up your AI service (Ollama recommended)
  4. Use: Start asking questions with /ask or JavaScript console

📋 Requirements​

  • Foundry VTT: v13 or higher
  • AI Service: Ollama (tested) or OpenAI-compatible endpoint (untested)
  • System Compatibility: Works with any game system

🏗️ Current Status​

✅ Working (Limited Testing)​

  • LLM integration with Ollama/qwen3
  • Basic settings configuration
  • Journal access and summarization
  • Chat commands and console API

🚧 In Development​

  • Enhanced tool system
  • Improved UI components
  • Better error handling
  • Wider AI service compatibility

🔗 Links​

Ready to add an AI assistant to your Foundry campaigns? Check out the Installation Guide to get started!