{"id":46796788,"url":"https://github.com/alexivenkov/foundry-api-bridge-module","last_synced_at":"2026-04-07T12:02:02.630Z","repository":{"id":323135634,"uuid":"1092231180","full_name":"alexivenkov/foundry-api-bridge-module","owner":"alexivenkov","description":"HTTP REST API bridge for Foundry VTT - enables external tools to access world data","archived":false,"fork":false,"pushed_at":"2026-04-02T07:41:22.000Z","size":357,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-04-03T08:27:57.323Z","etag":null,"topics":["api","dnd","dnd5e","foundry-module","foundry-vtt","foundryvtt","rest-api","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alexivenkov.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-08T08:39:45.000Z","updated_at":"2026-04-02T07:40:51.000Z","dependencies_parsed_at":"2025-11-08T11:11:43.887Z","dependency_job_id":null,"html_url":"https://github.com/alexivenkov/foundry-api-bridge-module","commit_stats":null,"previous_names":["alexivenkov/foundry-api-bridge-module"],"tags_count":50,"template":false,"template_full_name":null,"purl":"pkg:github/alexivenkov/foundry-api-bridge-module","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexivenkov%2Ffoundry-api-bridge-module","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexivenkov%2Ffoundry-api-bridge-module/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexivenkov%2Ffoundry-api-bridge-module/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexivenkov%2Ffoundry-api-bridge-module/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alexivenkov","download_url":"https://codeload.github.com/alexivenkov/foundry-api-bridge-module/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexivenkov%2Ffoundry-api-bridge-module/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31511785,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T03:10:19.677Z","status":"ssl_error","status_checked_at":"2026-04-07T03:10:13.982Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","dnd","dnd5e","foundry-module","foundry-vtt","foundryvtt","rest-api","typescript"],"created_at":"2026-03-10T04:34:08.139Z","updated_at":"2026-04-07T12:02:02.620Z","avatar_url":"https://github.com/alexivenkov.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Foundry API Bridge\n\nConnect your Foundry VTT world to [foundry-mcp.com](https://foundry-mcp.com) — a platform that lets AI assistants (Claude, ChatGPT, etc.) control Foundry VTT through the MCP protocol.\n\nThis module is the client-side component of [Foundry MCP](https://github.com/alexivenkov/foundry-mcp). It enables bidirectional communication between Foundry VTT and the Foundry MCP server:\n\n- **Outbound (REST)**: Periodically sends world data (journals, actors, scenes, items, compendia) to the server so AI has full context about your campaign\n- **Inbound (WebSocket)**: Receives commands from the server (dice rolls, combat management, journal editing, token manipulation, etc.) and executes them in Foundry\n\n## Installation\n\n### Install via Manifest URL (Recommended)\n\n1. In Foundry VTT, go to **Add-on Modules**\n2. Click **Install Module**\n3. Paste the manifest URL:\n   ```\n   https://raw.githubusercontent.com/alexivenkov/foundry-api-bridge-module/master/dist/module.json\n   ```\n4. Click **Install**\n5. Enable the module in your world\n\n### Manual Installation\n\n1. Download the latest release from [GitHub Releases](https://github.com/alexivenkov/foundry-api-bridge-module/releases)\n2. Extract to `Data/modules/foundry-api-bridge/`\n3. Restart Foundry VTT\n4. Enable the module in your world\n\n## Setup\n\n### 1. Get an API Key\n\n1. Go to [foundry-mcp.com/auth/patreon](https://foundry-mcp.com/auth/patreon)\n2. Sign in with your Patreon account\n3. Copy your API key (format: `pk_...`)\n\n### 2. Configure the Module\n\n1. Open your world as GM\n2. Go to **Game Settings → Configure Settings → Module Settings**\n3. Find **Foundry API Bridge** and fill in:\n\n| Setting | Value |\n|---------|-------|\n| **Server URL** | `https://foundry-mcp.com/api` |\n| **WebSocket URL** | `wss://foundry-mcp.com/ws` |\n| **API Key** | Your `pk_...` key from step 1 |\n\n4. Save and reload the world\n\n### 3. Advanced Configuration (Optional)\n\nClick **Configure** next to the module name to access additional settings:\n\n| Setting | Default | Description |\n|---------|---------|-------------|\n| Update Interval | 5000 ms | How often world data is sent to the server |\n| World Data Endpoint | `/update` | REST endpoint for world data |\n| Compendium Endpoint | `/update-compendium` | REST endpoint for compendium data |\n| Collect World Data | Enabled | Toggle world data collection |\n| Periodic Updates | Enabled | Toggle periodic data sync |\n| Auto-load Compendium | Enabled | Automatically send selected compendia on startup |\n| Compendium Selection | — | Choose which compendium packs to sync |\n\n## How It Works\n\nOnce configured, the module:\n\n1. **Syncs world data** — Periodically sends your world's journals, actors, scenes, and items to the Foundry MCP server via REST API\n2. **Listens for commands** — Maintains a WebSocket connection to receive and execute commands from the server\n3. **Shows connection status** — Displays notifications when the WebSocket connection is established or lost\n\nThe AI assistant connected through MCP can then:\n- Read your campaign data for context\n- Roll dice and skill checks\n- Create and edit journal entries\n- Manage combat encounters and initiative\n- Place and move tokens on scenes\n- Manage actor items and effects\n\n## Compatibility\n\n| Foundry VTT Version | Status |\n|---------------------|--------|\n| v13 (Build 350) | Verified |\n| v12 | Verified |\n| v11 | Minimum supported |\n\n## Links\n\n- [Foundry MCP Platform](https://foundry-mcp.com) — The server-side platform\n- [Foundry MCP Server Repository](https://github.com/alexivenkov/foundry-mcp) — Server source code\n- [Patreon](https://foundry-mcp.com/auth/patreon) — Get your API key\n- [Report Issues](https://github.com/alexivenkov/foundry-api-bridge-module/issues)\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexivenkov%2Ffoundry-api-bridge-module","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexivenkov%2Ffoundry-api-bridge-module","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexivenkov%2Ffoundry-api-bridge-module/lists"}