How It Works
Get Started with Loremaster
From installation to your first AI-enhanced session, here's everything you need to know.
Step 1: Quick Start (Hosted)
The Easy Path
The hosted version is the simplest way to get started. No server setup, no API keys to manage — just subscribe and play.
A. Get Foundry VTT Hosting
If you don't already have Foundry VTT, we recommend The Forge — a fully managed hosting service that handles everything for you. Alternatively, you can run your own Foundry VTT server.
B. Join Our Patreon
Subscribe to Loremaster on Patreon to get access to the hosted proxy server. Choose a tier based on your usage:
- Basic ($5/mo): 500K tokens — casual play, 1-2 sessions/month
- Pro ($15/mo): 2M tokens — regular weekly sessions
- Premium ($30/mo): 5M tokens — professional GMs
Once subscribed, you'll receive the hosted server URL in the Patreon welcome message.
C. Install the Module
- In Foundry VTT, go to Add-on Modules → Install Module
- Paste this manifest URL:
https://github.com/digitsu/loremaster-foundry/releases/latest/download/module.json - Click Install, then enable the module in your world
D. Configure the Module
- Open Module Settings → Loremaster
- Enter the Proxy Server URL from your Patreon welcome message:
Example (WebSocket URL):
wss://proxy.loremastervtt.com - Enter your Patreon email for authentication
- That's it! You're ready to play.
Alternative: Self-Hosted Setup
Run Your Own Proxy Server
For users who want full control or unlimited usage, you can self-host the proxy server with a one-time license purchase.
Requirements
- Self-hosted license ($25 one-time)
- Your own Claude API key from Anthropic
- Node.js environment (local machine, VPS, or Docker)
Module Installation Options
Git Clone (For Developers)
Navigate to your Foundry modules directory and clone:
git clone https://github.com/digitsu/loremaster-foundry.git loremaster Module paths by platform:
- Windows:
%LOCALAPPDATA%\FoundryVTT\Data\modules - macOS:
~/Library/Application Support/FoundryVTT/Data/modules - Linux:
~/.local/share/FoundryVTT/Data/modules
Manual Download
- Download from GitHub Releases
- Extract to your Foundry
Data/modules/loremasterdirectory - Restart Foundry VTT and enable the module
Module Settings
- Enter your self-hosted proxy URL (e.g.,
wss://localhost:3000) - Enter your Claude API Key
- Enter your License Key from Gumroad
See the GitHub repository for detailed self-hosting documentation.
Step 2: Basic Usage
Start Chatting
Once configured, using Loremaster is as simple as typing in Foundry's chat.
Chat Commands
@lm The party enters the ancient ruins. What do they see? Send a public message to Loremaster
@lm! What's the guard captain's secret motivation? Private GM chat - only you see the response
[GM RULING: The door is magically sealed] Override AI with your ruling
Message Batching
When multiple players send messages, Loremaster can collect them before responding:
- Timer Mode: Automatically waits for configured duration
- Manual Mode: GM sends keyword (default: "send") to trigger response
Step 3: Advanced Features
Level Up Your Sessions
Once you're comfortable with basic chat, explore Loremaster's advanced capabilities.
Upload Adventure PDFs
- Open Loremaster's Content Manager from the scene controls
- Click Upload PDF
- Select your adventure PDF and choose a category
- Wait for processing (usually under a minute)
- Select the adventure as "Active" to focus the AI
Generate GM Prep Scripts
- Upload an adventure PDF
- Click Generate Prep Script
- Wait 1-2 minutes for generation
- Find the script in your Foundry journals
- Edit and customize as needed
Manage House Rules
When the AI flags a rules discrepancy:
- Review both interpretations (PDF vs Foundry)
- Choose your ruling
- Select whether it's session-only or persistent
- The ruling is saved to a journal entry
Monitor Usage
Open the Usage Monitor to track:
- Total tokens used (all-time and session)
- Breakdown by feature type
- Prompt caching efficiency
- Progress toward your monthly limit
Tips for Success
Be Specific
The more context you give, the better the AI responds. "The rogue searches the desk" works better than just "search".
Use Private Mode
Use @lm! to brainstorm or ask questions without players seeing. Great for improvising.
Embrace Iteration
Don't settle for the first response. Use Iterate to refine until you get exactly what you want.
Set House Rules Early
When you notice a discrepancy, set a persistent house rule immediately. Consistency builds trust.
Upload Core Rules
Upload your system's core rulebook for better mechanical accuracy, not just adventures.
Monitor Usage
Check the usage monitor occasionally. Prompt caching can save significant tokens over time.