Dungeon Weaver

AI-assisted campaign prep workspace for tabletop DMs.
面向桌游 DM 的 AI 辅助备团工作台。

Dungeon Weaver combines guided chat, structured worldbuilding, and map-oriented planning into one desktop-first workflow.
Dungeon Weaver 将对话引导、结构化世界观整理与地图规划结合在同一个桌面优先工作流中。

---

Why This Project / 这个项目解决什么问题

EN

Preparing a campaign usually means jumping between notes, maps, and fragmented ideas.
Dungeon Weaver helps you go from concept to playable session with a clear step-by-step flow.

中文

备团经常需要在笔记、地图和零散灵感之间反复切换。
Dungeon Weaver 旨在把「想法」快速落成「可开团内容」，并提供清晰的分步流程。

---

Highlights / 核心亮点

• AI Co-Pilot for DMs: brainstorm setting, factions, plot hooks, and NPC drafts
  DM AI 副驾：辅助生成世界设定、势力关系、剧情钩子与 NPC 草案
• Structured Workspace: top progress flow + chat + live preview
  结构化工作台：顶部进度 + 左侧对话 + 右侧实时预览
• Desktop-First: runs locally with Electron for stable offline-style workflow
  桌面优先：基于 Electron 本地运行，适合沉浸式备团
• Map Training Pipeline (Optional): supports dataset labeling and JSONL export
  可选训练管线：支持地图命令标注与 JSONL 导出

---

Screens and Flow / 页面与流程

1. Welcome: choose DM / Player entry (player side is reserved)
   欢迎页：选择主持人 / 玩家入口（玩家侧目前预留）
2. Campaign Setup: create new campaign or connect existing files
   战役入口：新建战役或接入已有资料
3. Main Interface: iterate with AI while keeping structured output visible
   主界面：与 AI 协作迭代，同时保持结构化结果可见

---

Quick Start / 快速开始

Requirements / 环境要求

• Node.js 18+
• npm 9+

Install / 安装

npm install

Web Dev / 浏览器开发

npm run dev

Desktop Dev / 桌面开发

npm run electron:dev

Build / 构建

npm run build

Desktop Package / 桌面打包

npm run electron:build

---

Tech Stack / 技术栈

• React 19 + Vite 7
• Electron 34
• Tailwind CSS 4
• Framer Motion
• React Router

---

Repo Structure / 仓库结构

src/        React app source / 前端源码
electron/   Electron main & preload / 桌面进程代码
scripts/    Tooling scripts / 工具脚本
training/   Dataset pipeline / 数据集流水线

---

Open Source & License / 开源与许可证

Recommended strategy / 推荐方案

• Code license: use MIT for the repository code (LICENSE)
  代码许可证：仓库代码使用 MIT（放在 LICENSE）
• Rule content compliance: if bundling or redistributing SRD/Open5e-derived text/data, keep separate OGL documentation
  规则内容合规：若打包或再分发 SRD/Open5e 衍生文本/数据，需单独维护 OGL 文档
• Keep legal details in LEGAL.md and add OGL-1.0a.txt when needed
  法律细节保留在 LEGAL.md，必要时加入 OGL-1.0a.txt

This project is not affiliated with Wizards of the Coast.
本项目与 Wizards of the Coast 无官方关联。

---

Contributing / 参与贡献

Issues and pull requests are welcome.
欢迎提交 Issue 与 PR。

Priority contribution areas / 优先方向：

• DM workflow UX
• map tooling
• AI prompt quality
• desktop stability

---

Status / 当前状态

Active prototype in progress.
持续迭代中的原型阶段项目。