falconku/diceframe repository overview

⁠DiceFrame

A self-hostable AI tabletop RPG platform. Ships with DND 5e and COC (Call of Cthulhu) rule templates, and supports custom rules.

一个可自部署的 AI 跑团桌面。内置 DND 5e 和 COC（克苏鲁的呼唤）规则模板，也支持自定义规则。

⁠Features / 功能

• WebUI: Create games, character management, lorebook, rule editor, log replay / 创建游戏、角色管理、世界书、规则编辑、日志回看
• Multiplayer table: Invite links, SSE real-time sync, GM forced advance / 多人桌：邀请链接、SSE 实时同步、GM 强制推进
• Dice & state: d20 (DND 5e) and d100 (COC) checks, HP, sanity, gold, items, XP, death/revive / 骰子与状态：d20（DND 5e）和 d100（COC）检定，HP、理智、金币、物品、经验、死亡/复活
• Lorebook: NPCs, locations, items, events, puzzles, factions; injected into context by keywords / 世界书：NPC、地点、物品、事件、谜题、势力，按关键词注入上下文
• Memory & summary: Compress long campaign history; optional embedding semantic recall / 记忆与摘要：长团压缩历史，可选 embedding 语义召回
• AI generation: World, rule, character, lorebook entries / AI 生成：世界、规则、角色、世界书条目
• QQ / NapCat plugin: Bind group chat to web session / QQ / NapCat 插件：群聊绑定网页对局
• Docker: Out-of-the-box, data mounted to data/ / Docker：开箱即用，数据挂载到 data/
• Bilingual (zh/en): Full UI + rule/world template localization / 双语（中/英）：全界面 + 规则/世界模板本地化

⁠Quick Start / 快速开始

docker pull falconku/diceframe:latest
docker run -d --name diceframe -p 18000:18000 -v ./data:/app/data falconku/diceframe:latest

• -p 18000:18000: WebUI port; change the host side before the colon / WebUI 端口，冒号前可改成宿主机其他端口
• -v ./data:/app/data: Mount runtime data to host ./data (saves, config, lorebook DB); survives container deletion / 运行数据映射到宿主机 ./data 目录，包括存档、配置、世界书数据库，删容器不丢数据
• Container port fixed at 18000, not recommended to change / 容器内端口固定 18000，不建议修改

Open http://localhost:18000⁠ and configure API base URL, model name, and API key in Settings.

打开 http://localhost:18000⁠ ，在设置页配置 API 地址、模型名和 API Key。

⁠Links / 链接

• Website: https://diceframe.com/⁠
• GitHub: https://github.com/diceframe/diceframe⁠
• Releases: https://github.com/diceframe/diceframe/releases⁠
• Docs: https://github.com/diceframe/diceframe/tree/main/docs⁠

⁠License

AGPL-3.0