feat: add Journal server documentation to DocDialog

Introduce a new documentation set for Journal server functionality,
including a dropdown selector in the DocDialog to switch between
"directives" and "journal" documentation modes.
This commit is contained in:
2026-07-07 23:57:31 +08:00
parent 1ef41f04fc
commit c10b088fb1
5 changed files with 265 additions and 6 deletions
+62
View File
@@ -0,0 +1,62 @@
---
tag: journal-gm
icon: 🎭
title: 主持人指南
description: 作为 GM 创建会话、管理玩家、使用动态表单和消息类型。
syntax: '点击导航栏 📋 图标打开 Journal 面板'
props:
- name: 会话管理
type:
desc: 创建、切换、删除会话;通过邀请链接添加玩家
- name: 消息类型
type:
desc: 发送叙述、掷骰、表单等多种消息类型
- name: 动态表单
type:
desc: 创建自定义表单收集玩家输入
---
## 快速开始
1. 点击顶部导航栏的 📋 按钮打开 Journal 面板
2. 输入你的名字,选择"主持人"角色,点击"加入"
3. 连接成功后,你可以创建新会话或选择已有会话
## 会话管理
作为 GM,你可以管理多个会话:
- **创建会话**:点击标题下方的会话名称 → 下拉菜单 → "+ 新建会话"
- **切换会话**:点击会话名称,从下拉列表中选择
- **邀请玩家**:点击玩家标签旁的 "+ 邀请",输入玩家名字,复制链接发送给玩家
玩家通过邀请链接加入后会自动以玩家身份连接。
## 消息类型
Journal 支持多种消息类型,通过输入框上方的标签切换:
- **叙述**:普通的文字描述,用于推进剧情
- **掷骰**:发送掷骰结果,可附带公式
- **表单**:创建动态表单,收集玩家选择或输入
## 动态表单
表单消息允许你创建交互式问卷:
- 添加文本输入、选择框、复选框等字段
- 玩家提交后,GM 可以看到汇总结果
- 适用于投票、决策、角色创建等场景
## 撤回消息
GM 可以撤回自己发送的最新消息,点击消息旁的撤回按钮即可。
## 连接状态
- 🟢 绿色:已连接
- 🟡 黄色闪烁:连接中
- 🔴 红色:连接错误
- ⚪ 灰色:未连接
断开连接可点击标题栏的 ⏻ 按钮。
+66
View File
@@ -0,0 +1,66 @@
---
tag: journal-player
icon: 🎲
title: 玩家指南
description: 作为玩家加入 GM 的会话,查看消息、提交表单、参与互动。
syntax: '通过 GM 发送的邀请链接加入'
props:
- name: 加入方式
type:
desc: 点击邀请链接自动加入,或手动输入名字和角色
- name: 查看消息
type:
desc: 实时查看 GM 和其他玩家的消息
- name: 提交表单
type:
desc: 填写 GM 发送的动态表单并提交
---
## 加入会话
有两种方式加入 GM 的会话:
### 通过邀请链接(推荐)
GM 会发送一个包含 `?session=xxx&player=你的名字&autojoin=1` 的链接。
点击链接即可自动加入,无需手动输入任何信息。
### 手动加入
1. 点击顶部导航栏的 📋 按钮打开 Journal 面板
2. 输入你的名字
3. 选择"玩家"角色
4. 点击"加入"
## 查看消息
连接成功后,你可以在面板中看到:
- GM 发送的叙述消息
- 掷骰结果
- 其他玩家的消息
- 动态表单
消息实时更新,无需刷新页面。
## 填写表单
当 GM 发送动态表单时:
1. 表单会显示在消息流中
2. 根据表单类型填写(文本、选择、复选框等)
3. 点击提交按钮发送你的回答
GM 可以看到所有玩家的提交结果。
## 角色标识
- 你的名字旁会显示蓝色"player"标签
- 观察者显示灰色"observer"标签
- GM 不显示角色标签
## 注意事项
- 玩家无法创建或切换会话
- 玩家无法撤回消息
- 断开连接后重新加入会保留之前的消息记录