hunter-read/grimoire

这是什么？

核心功能

• 01根据文件夹结构，按游戏系统整理 PDF、地图、标记、音频和模型。
• 02对每个 PDF 的每一页做全文搜索，扫描书籍可通过 OCR 识别。
• 03逐页阅读器，支持书签、收藏，并提供 OPDS 订阅源供电子书阅读器使用。
• 04地图库配有 UVTT 编辑器，可绘制墙体、门和光源。
• 05提供角色标记编辑器和音效板，方便在牌桌上播放音频。
• 06支持战役跟踪、Markdown 笔记 Wiki，并可按角色限制内容访问。

适用场景

• 在牌局中用手机或平板搜索大量 RPG PDF。
• 在家用 NAS 或服务器上托管共享游戏资料库，无需依赖第三方服务。
• 把战役所需的地图、标记和讲义集中管理。
• 对玩家隐藏剧透书籍或模组，同时保留给主持人使用。

快速上手

1. 1

   按 README 的结构整理你的 library 文件夹

2. 2

   复制默认的 Docker Compose 文件并设置卷路径

   cp docs/docker/docker-compose.yml docker-compose.yml
3. 3

   使用 Docker Compose 启动容器

   docker compose up -d

使用前须知

• !采用 GPL-3.0 许可证，这是一种 copyleft 许可证，要求衍生作品以相同条款开源。
• !需要 Docker 以及一台用于自托管的机器，因此设置需要一定精力。

收录于专题

标签

常见问题

grimoire 是什么？

一款自托管的网页应用，把你的桌面角色扮演游戏 PDF、地图、素材、音频和模型整理成可搜索的统一资料库。 Grimoire 是一款自托管的桌面角色扮演游戏资料库管理工具。把 PDF 书籍、地图、角色标记、音频和 3D 模型所在的文件夹交给它，就会按游戏系统和分类整理，并支持对每本书的每一页做全文搜索，包括通过 OCR 识别的扫描页面。

grimoire 可以免费使用吗？用的什么许可证？

grimoire 以 GPL-3.0 许可证开源。用于商业产品前，请先确认许可证条款。

grimoire 还在维护吗？

活跃维护中。grimoire 最近一次提交是在 2026年11月6日。

grimoire 适合用来做什么？

在牌局中用手机或平板搜索大量 RPG PDF。 在家用 NAS 或服务器上托管共享游戏资料库，无需依赖第三方服务。 把战役所需的地图、标记和讲义集中管理。 对玩家隐藏剧透书籍或模组，同时保留给主持人使用。

grimoire 怎么安装和运行？

按 README 的结构整理你的 library 文件夹 复制默认的 Docker Compose 文件并设置卷路径: cp docs/docker/docker-compose.yml docker-compose.yml 使用 Docker Compose 启动容器: docker compose up -d

在哪里获取 grimoire？

源代码和安装说明在 GitHub 上：https://github.com/hunter-read/grimoire