Repository navigation
ForgeBook v1.0.0
ForgeBook v1.0.0 — first public release
AI-grounded item + mod documentation inside Minecraft. Hold an unfamiliar item, ask what it does, get a cited answer without leaving the game.
Features
/forgebook item— held-item or argument-form AI lookup with source citation/forgebook ask— single-turn chat from the command line- In-inventory docked chat UI (left-pinned panel) with per-session conversation and loading/error states
- Grounded tool-using agent loop with mod-docs scraping, web search, and CurseForge enrichment
- Claude provider by default; OpenAI + Ollama are selectable stubs for future contributions
- Safety: server-side-only API keys, SSRF-safe fetcher, per-player rate limiting, OP-only default, kill switch, audit logging
Install
Drop forgebook-1.0.0.jar into your Forge 1.20.1-47.4.18 mods/ folder on both client and server.
Server owners: on first start a config/forgebook-server.toml file is generated. Edit it to set ai_api_key = "sk-ant-..." (get one from console.anthropic.com), then either restart or run /forgebook reload in-game as an OP.
Full setup guide: docs/BUILD-AND-INSTALL.md.
Compatibility
Tested clean against JEI, REI, Embeddium, Oculus, Jade, Mouse Tweaks, Quark, Inventory HUD+ — see docs/COMPATIBILITY.md.
Requirements
- Minecraft 1.20.1
- Forge 1.20.1-47.4.18 or newer 47.x
- Java 17
- Anthropic API key (server-side; console.anthropic.com)
License
MIT. See LICENSE and THIRD_PARTY_NOTICES.md.
— Nick Doxa