moyu-ghost 1.0.0 → 1.0.1

package/README.md

@@ -1,169 +1,61 @@
-# VS-Ghost 使用文档
+# moyu-ghost
 
-`vs-ghost` 是一个运行在 VS Code 终端中的隐蔽阅读器。  
-它会把小说内容伪装成前端构建日志输出，适合在终端环境中阅读 `.txt` / `.epub` 书籍。
+`moyu-ghost` 是一个终端小说阅读器，输出风格伪装为前端构建日志，适合在命令行中阅读 `.txt` / `.epub` 文件。
 
-## 1. 功能概览
+## 环境要求
 
-- 伪装输出：正文以构建日志形式输出，穿插噪声日志。
-- 自动翻页为主：支持按阅读速度自动滚动。
-- 手动调位：保留上下方向键快速调整当前位置。
-- 目录解析与跳转：`.epub` 解析真实目录（nav/NCX），`.txt` 按章节标题规则生成伪目录。
-- 老板键：`Ctrl + C` 触发伪构建崩溃并快速刷屏退出。
-- 进度记忆：自动保存阅读位置与速度，下次继续。
+- Node.js 18+
+- npm 9+
 
-## 2. 环境要求
-
-- Node.js 18+（推荐 LTS，已在 Node 24 环境验证）
-- Windows / macOS / Linux 终端均可（推荐 VS Code Integrated Terminal）
-
-## 3. 安装与启动
-
-1. 安装依赖：
+## 安装
 
 ```bash
-npm install
+npm i -g moyu-ghost
 ```
 
-2. 初始化数据目录（建议先执行）：
-
-```bash
-npm run init
-```
+## 快速开始
 
-3. 放入小说文件到 `logs_data` 目录（支持 `.txt` / `.epub`）。
-默认目录：
-- Windows：`C:\Users\<用户名>\.vs-ghost\logs_data`
-- macOS/Linux：`~/.vs-ghost/logs_data`
-
-可选：你也可以设置环境变量 `VS_GHOST_HOME` 自定义根目录，程序会使用 `<VS_GHOST_HOME>/logs_data`。
-
-4. 启动：
+1. 初始化数据目录：
 
 ```bash
-npm start
+moyu-ghost-init
 ```
 
-5. 启动后输入书籍序号，回车确认。
-
-## 4. 键位说明
-
-| 按键 | 功能 | 说明 |
-| --- | --- | --- |
-| `a` | 自动翻页开关 | 主阅读模式，开/关自动滚动 |
-| `Down Arrow` | 下一行 | 手动向前调位 |
-| `Up Arrow` | 上一行 | 手动回退调位（会输出重处理警告） |
-| `[` / `-` / `Left Arrow` | 降速 | 自动翻页速度降低 |
-| `]` / `=` / `Right Arrow` | 加速 | 自动翻页速度提高 |
-| `t` | 打开目录 | 打印目录并进入跳转输入模式 |
-| `Ctrl + C` | 老板键 | 触发伪构建错误 + 50 行堆栈后退出 |
-| `Esc` | 正常退出 | 直接退出程序（不触发伪崩溃） |
-
-## 5. 自动翻页规则
-
-- 速度单位：`han-chars/s`（每秒汉字数）。
-- 默认速度：`10 han-chars/s`。
-- 可调范围：`4 ~ 60 han-chars/s`。
-- 计速只统计汉字，不统计空格、英文标点和符号。
-- 最小翻页间隔：`500ms`（防止短句滚动过快）。
-- 最大翻页间隔：`7000ms`（防止长句停留过久）。
-
-## 6. 目录（TOC）跳转
-
-按 `t` 后会打印目录，并提示输入跳转参数。
-
-支持两种输入方式：
-
-- 输入章节号（推荐）：例如 `105`
-- 输入目录序号：例如 `#105` 或 `i105`
-
-优先级规则：
-
-- 纯数字优先按“章节号”匹配。
-- 若没有匹配章节号，再按“目录序号”匹配。
-
-示例：
-
-- 输入 `105` -> 优先跳转到 `第105章 ...`
-- 输入 `#105` -> 强制跳到 TOC 第 105 项
-
-## 7. 进度与配置保存
-
-程序会在数据目录根路径写入 `.ghost-session.json`（默认在 `~/.vs-ghost/.ghost-session.json`），按书籍保存：
+2. 把小说文件放进数据目录（支持 `.txt`、`.epub`）。
 
-- `index`：当前阅读位置
-- `autoCharsPerSecond`：自动翻页速度
-- `updatedAt`：更新时间
+3. 启动阅读器：
 
-重启后会自动续读。  
-如果你想恢复默认速度，可删除对应书籍会话项或删除整个 `.ghost-session.json`。
-
-## 8. 目录结构
-
-```text
-.
-├─ index.js           # 主程序入口（交互、状态、自动翻页、TOC 跳转）
-├─ parser.js          # 文本/EPUB 解析与 TOC 生成
-├─ logger.js          # 伪装日志输出
-└─ 需求文档.md         # 产品需求文档
-```
-
-运行时数据目录（默认）：
-
-```text
-~/.vs-ghost/
-├─ logs_data/          # 书籍目录（.txt/.epub）
-└─ .ghost-session.json # 进度与速度持久化
+```bash
+moyu-ghost
 ```
 
-## 9. 常见问题
+## 命令
 
-1. 为什么我改了默认速度，启动后还是旧速度？
-- 因为会话文件保存了历史速度。删除 `~/.vs-ghost/.ghost-session.json`（或你自定义 `VS_GHOST_HOME` 下对应文件）即可。
+- `moyu-ghost`：启动阅读器
+- `moyu-ghost-init`：初始化数据目录
 
-2. 为什么 `105` 有时不是 TOC 第 105 项？
-- 设计如此：纯数字优先当作“章节号”。要强制按 TOC 序号，请用 `#105`。
+兼容旧命令（可选）：
+- `vs-ghost`
+- `vs-ghost-init`
 
-3. 为什么有些 TXT 没有目录？
-- TXT 目录是规则识别（如 `第xx章`、`Chapter x`）。如果原文无明显标题，目录可能较少或为空。
+## 可选配置
 
-## 10. 打包与跨电脑使用
+可通过环境变量自定义数据目录根路径：
 
-### A. 本机打包
+- 变量名：`VS_GHOST_HOME`
+- 目录结构：`<VS_GHOST_HOME>/logs_data`
 
-在项目根目录执行：
+PowerShell 示例：
 
-```bash
-npm pack
+```powershell
+$env:VS_GHOST_HOME = "D:\\my-vs-ghost"
+moyu-ghost-init
+moyu-ghost
 ```
 
-会生成一个压缩包，例如：`vs-ghost-1.0.0.tgz`。
-
-### B. 在另一台电脑安装
-
-把 `.tgz` 文件拷贝到目标电脑后执行：
+## 卸载
 
 ```bash
-npm install -g ./vs-ghost-1.0.0.tgz
+npm uninstall -g moyu-ghost
 ```
 
-安装后可用命令：
-
-- `vs-ghost-init`：创建数据目录并打印实际路径
-- `vs-ghost`：启动阅读器
-
-### C. 推荐使用流程（另一台电脑）
-
-1. `vs-ghost-init`
-2. 把小说放到命令输出的 `data path`
-3. `vs-ghost`
-
-### D. 可选：自定义数据目录
-
-设置环境变量 `VS_GHOST_HOME` 后，`vs-ghost` 与 `vs-ghost-init` 都会使用该目录：
-
-PowerShell:
-
-```powershell
-$env:VS_GHOST_HOME = "D:\\my-vs-ghost"
-```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "moyu-ghost",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Stealth CLI reader disguised as frontend build logs.",
   "type": "module",
   "main": "index.js",