Skip to content

Commit 1c3f1a3

Browse files
committed
doc: 更新了更完整的README和更多预览图片
1 parent 5792833 commit 1c3f1a3

4 files changed

Lines changed: 104 additions & 30 deletions

File tree

README.md

Lines changed: 104 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -11,57 +11,65 @@ UI 风格参考 VSCode。
1111

1212
示例日志处理效果:
1313

14-
![preview](./docs/preview.png)
14+
![preview-1](./docs/preview-1.png)
15+
![preview-2](./docs/preview-2.png)
16+
![preview-3](./docs/preview-2.png)
17+
18+
---
1519

1620
## Features
1721

18-
- 日志导入(多来源适配)
19-
- 自动分块与结构化解析
20-
- 消息编辑与内容修改
21-
- 撤销 / 重做
22-
- 拖拽重排
23-
- 身份管理(角色/账号区分)
24-
- 自定义规则染色
25-
- 消息搜索与过滤
26-
- 导出模板自定义
27-
- 导出预览
28-
- 本地存储(项目保存 / 恢复)
29-
- 多格式导出:
30-
- TXT
31-
- HTML
32-
- DOCX
22+
### 核心功能
3323

34-
---
24+
- **日志导入**:支持多来源适配导入
25+
- **自动分块与结构化解析**:智能识别日志结构,自动拆分为文档/场景/消息
26+
- **消息编辑**:支持内容修改、双击编辑、批量操作
27+
- **撤销 / 重做**:完整的历史记录管理
28+
- **拖拽重排**:支持消息级和场景级的拖拽排序
29+
- **身份管理**:角色与账号的区分管理,支持批量改名和角色分配
30+
- **自定义规则染色**:灵活的高亮规则配置,支持优先级、多条件筛选
31+
- **消息搜索与过滤**:支持全文搜索和高级筛选
32+
- **导出模板自定义**:自由定义输出格式,支持占位符语法
33+
- **导出预览**:导出效果预览
34+
- **本地存储**:项目保存/恢复,支持多版本管理
35+
- **分屏模式**:支持单/双视图并排编辑
36+
- **多格式导出**:TXT、HTML、DOC、DOCX
3537

36-
## Enhancements over existing log highlighters
38+
### 增强特性
3739

38-
在常见日志染色工具的基础上,本项目做了一些结构化与可控性方面的增强
40+
在常见日志染色工具的基础上,本项目做了以下结构化与可控性方面的增强
3941

4042
- 支持消息级排序与拖拽重排
41-
- 支持按场景 / 分幕对日志进行结构化整理
42-
- 提供基础统计功能(消息数量、选中范围等)
43+
- 支持按文档/场景对日志进行结构化整理
4344
- 支持自定义染色规则(而非固定规则)
4445
- 染色范围可配置(仅名称 / 仅内容 / 全部)
4546
- 支持自定义导出模板(控制最终输出结构)
4647
- 支持本地快照保存与恢复
4748

48-
这些能力使日志不仅可以“染色”,还可以进行结构化编辑与再组织。
49-
5049
---
5150

5251
## Tech Stack
5352

54-
- Vue 3
55-
- Vite
56-
- TypeScript
53+
- **框架**:Vue 3(Composition API)
54+
- **构建工具**:Vite
55+
- **语言**:TypeScript
56+
- **图标库**:Lucide Vue
5757

5858
---
5959

6060
## Getting Started
6161

62+
### 安装与运行
63+
6264
```bash
65+
# 安装依赖
6366
npm install
67+
68+
# 启动开发服务器
6469
npm run dev
70+
71+
# 构建生产版本
72+
npm run build
6573
```
6674

6775
---
@@ -77,12 +85,78 @@ npm run dev
7785

7886
---
7987

80-
## Roadmap
88+
## 核心功能详解
89+
90+
### 身份管理
91+
92+
提供两种管理模式:
93+
94+
- **按角色名**:以 `playerName` 为维度聚合
95+
- **按账号**:以 `account` 为维度聚合
96+
97+
支持批量改名、角色分配(玩家/NPC/主持人/骰子/观众)和自定义染色。
98+
99+
### 染色规则
100+
101+
- **系统规则**:自动为每个身份生成基础规则
102+
- **自定义规则**:支持多条件筛选
103+
- **优先级**:数字越大越优先,高优先级覆盖低优先级
104+
- **染色范围**:可配置仅名称、仅内容或全部
105+
- **选区绑定**:可将当前选中的消息直接绑定到规则
106+
107+
### 导出模板
108+
109+
支持自定义占位符语法:
110+
111+
| 占位符 | 说明 |
112+
| --------------- | -------- |
113+
| `{{ name }}` | 角色名 |
114+
| `{{ account }}` | 账号 |
115+
| `{{ content }}` | 消息内容 |
116+
| `{{ time }}` | 时间 |
117+
| `\t` | 制表符 |
118+
| `\n` | 换行符 |
119+
120+
可配置项:
121+
122+
- 文件后缀
123+
- 消息分隔符
124+
- 幕间分隔符
125+
- 场景分隔符
126+
- 消息布局模板
127+
128+
### 快捷键
129+
130+
| 快捷键 | 功能 |
131+
| ------------------ | -------------- |
132+
| `Ctrl + A` | 全选 |
133+
| `Esc` | 取消选择 |
134+
| `Ctrl + C` | 复制 |
135+
| `Ctrl + V` | 粘贴 |
136+
| `Ctrl + Z` | 撤销 |
137+
| `Ctrl + Y` | 重做 |
138+
| `Ctrl + E` | 合并选中消息 |
139+
| `Ctrl + ↑/↓` | 选中上/下一条 |
140+
| `Ctrl + D` | 选中相同发言人 |
141+
| `Ctrl + /` | 切换 OOC 标记 |
142+
| `Ctrl + \` | 切换指令标记 |
143+
| `Ctrl + Backspace` | 删除选中消息 |
144+
| `Ctrl + S` | 保存到本地 |
145+
| `Ctrl + P` | 导出预览 |
146+
| `Ctrl + B` | 切换左侧边栏 |
147+
| `Ctrl + I` | 切换右侧边栏 |
148+
| `Ctrl + K` | 打开帮助文档 |
149+
150+
---
151+
152+
## 本地存储
81153

82-
计划中的改进方向
154+
项目支持将当前工作状态保存到浏览器本地存储(localStorage),包括
83155

84-
- 更完善的焦点管理(键盘操作与编辑状态一致性)
85-
- 多窗口 / 多视图支持(提升复杂日志的编辑效率)
156+
- 所有文档、场景、消息数据
157+
- 染色规则配置
158+
- 导出模板配置
159+
- UI 偏好设置
86160

87161
---
88162

docs/preview-1.png

414 KB
Loading

docs/preview-2.png

619 KB
Loading

docs/preview-3.png

683 KB
Loading

0 commit comments

Comments
 (0)