# 1yeshu

**Repository Path**: eersoft/1yeshu

## Basic Information

- **Project Name**: 1yeshu
- **Description**: 一叶书，一款简单轻便的TXT小说阅读器
- **Primary Language**: Rust
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://www.eersoft.top
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 3
- **Created**: 2025-11-16
- **Last Updated**: 2026-05-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 一叶书 (1yeshu)

一款基于 Rust + Tauri 开发的**桌面简易轻便的 Txt 小说阅读器**，专为高效阅读和处理超大文本文件而设计。

## 🌟 核心亮点

- 📚 **专为小说阅读优化**：智能章节识别、快速章节导航，让阅读更流畅
- 🚀 **超大文件支持**：使用内存映射技术，**实测可打开超过 5GB 的 txt 文件**，轻松处理 GB 级别的文本
- 💡 **轻量简洁**：界面清爽，操作简单，专注于阅读体验
- ⚡ **性能卓越**：基于 Rust 开发，启动快速，运行流畅

## 📥 下载可执行版

[【点击此处下载最新版 Windows 可执行文件】](https://wwab.lanzouw.com/b0sy9feof)  
下载密码：**clmf**

## ✨ 主要特性

### 📖 核心功能

- ✅ **超大文件支持**: 使用内存映射技术，**实测可打开超过 5GB 的 txt 文件**，无需担心文件大小限制
- ✅ **智能章节识别**: 自动识别小说章节，支持多种识别策略（严格模式、特殊部分识别、格式一致性检测、上下文分析、长度识别）
- ✅ **章节导航**: 快速跳转到上一章/下一章（Ctrl+B / Ctrl+N），支持章节列表侧边栏，轻松浏览整本小说
- ✅ **全文搜索**: 支持向前/向后搜索（Ctrl+F），实时高亮显示搜索结果，快速定位内容
- ✅ **历史记录**: 自动记录最近打开的文件，支持位置记忆和快速访问，下次打开自动恢复阅读位置
- ✅ **多编码支持**: 自动检测和手动切换多种编码格式（UTF-8、GBK、GB18030、Big5、Shift-JIS、EUC-JP、EUC-KR 等），完美支持各种文本文件

### 🎨 界面定制

- ✅ **10种精美主题**: 纯白、深色、深灰绿、米黄、绿色终端、蓝色终端、绿色护眼、复古典雅、中国风、Office-Word
- ✅ **自定义字体**: 支持字体大小（8-48pt）和字体族设置，打造个性化阅读体验
- ✅ **自定义颜色**: 可自定义文本颜色和背景颜色（覆盖主题设置），满足不同阅读习惯
- ✅ **行号显示**: 可选的行号显示功能，方便定位和引用
- ✅ **状态栏**: 显示文件信息、当前位置、章节信息等，随时了解阅读进度

### ⚙️ 高级功能

- ✅ **自动去除空行**: 自动去除连续的空行，让阅读更清爽
- ✅ **平滑滚动**: 支持平滑滚动效果，滚动速度可调，阅读更舒适
- ✅ **自动分章节**: 对于无章节标记的大文件，可按字数自动分章节，方便阅读
- ✅ **虚拟滚动**: 超大章节列表使用虚拟滚动，性能优化，即使有数万章节也能流畅操作
- ✅ **全局快捷键（老板键）**: 支持自定义全局快捷键，默认 Alt+Q 隐藏窗口，Alt+S 显示窗口，方便随时阅读

### 📁 文件支持

支持多种文本文件格式，不仅仅是 txt：
- 文本文件: txt, text
- 日志文件: log
- 配置文件: ini, cfg, conf, config
- 标记语言: md, markdown, rst
- 数据格式: json, xml, yaml, yml, toml, csv, tsv
- Web相关: html, htm, css, js, ts, jsx, tsx
- 编程语言: c, cpp, cc, cxx, h, hpp, java, py, pyw, rs, rust, go, php, rb, ruby, pl, pm, sh, bash, zsh, bat, cmd, ps1
- 数据库: sql
- 其他: svg, gitignore, env, properties

## 🚀 快速开始

### 系统要求

- Windows 10 或更高版本
- Microsoft Edge WebView2 Runtime（通常已预装，如未安装会自动提示）

### 使用方式

1. **打开文件**：
   - 菜单栏：文件 → 打开... (Ctrl+O)
   - 拖放：直接将文件拖放到窗口
   - 命令行：双击文件或通过命令行参数打开

2. **开始阅读**：
   - 使用鼠标滚轮或方向键滚动阅读
   - 使用章节导航快速跳转（Ctrl+B / Ctrl+N）
   - 使用搜索功能查找内容（Ctrl+F）

3. **个性化设置**：
   - 在"设置"菜单中调整字体、颜色、主题等
   - 在"主题"菜单中切换不同的阅读主题

## 📖 使用指南

### 打开文件
- **菜单栏**: 文件 → 打开... (Ctrl+O)
- **拖放**: 直接将文件拖放到窗口
- **命令行**: 双击文件或通过命令行参数打开

### 搜索功能
- **菜单栏**: 查看 → 查找... (Ctrl+F)
- 支持向前/向后搜索
- 实时高亮显示搜索结果
- 点击搜索结果可跳转到对应位置

### 章节导航
- **上一章**: 查看 → 上一章 (Ctrl+B)
- **下一章**: 查看 → 下一章 (Ctrl+N)
- **章节列表**: 查看 → 章节列表（显示章节侧边栏）
- 点击章节列表中的章节可快速跳转

### 编码设置
- **菜单栏**: 编码
- 自动检测当前文件的编码格式
- 手动切换编码格式（UTF-8、GBK、GB18030、Big5 等）

### 主题切换
- **菜单栏**: 主题
- 可选择 10 种内置主题
- 当前选中的主题会有标记显示

### 设置选项
- **菜单栏**: 设置 → 设置...
- **显示设置**: 字体大小、字体族、行号显示、状态栏显示
- **操作设置**: 滚动速度、平滑滚动
- **章节识别设置**: 识别策略、自动分章节、段落最大字数
- **颜色设置**: 自定义文本颜色和背景颜色
- **快捷键设置**: 自定义全局快捷键（老板键）

### 历史记录
- **菜单栏**: 文件 → 历史记录
- 自动记录最近打开的文件
- 支持位置记忆（记住上次阅读位置）
- 可清除历史记录

## 📂 配置文件位置

### Windows
- **配置文件**: `%APPDATA%\一叶书\config.json`
- **历史记录**: `%APPDATA%\一叶书\history.json`

### Linux/macOS
- **配置文件**: `~/.config/一叶书/config.json`
- **历史记录**: `~/.config/一叶书/history.json`

## 🛠️ 开发者指南

### 系统要求
- Windows 10 或更高版本
- Rust (最新稳定版)
- Node.js (用于 Tauri CLI，可选)

### 安装 Tauri CLI

**重要**：项目使用 Tauri v1.5，必须安装对应版本的 CLI。

#### 使用 Cargo 安装（推荐）

```bash
# 卸载旧版本（如果已安装）
cargo uninstall tauri-cli

# 安装 Tauri CLI v1.5
cargo install tauri-cli --version "^1.5"
```

**注意**：如果遇到权限错误，请以管理员身份运行 PowerShell。

#### 使用 npm 安装（需要 Node.js）

```bash
npm uninstall -g @tauri-apps/cli
npm install -g @tauri-apps/cli@^1.5.0
```

#### 验证安装

```bash
cargo tauri --version
```

应该显示 `tauri-cli 1.5.x` 或 `tauri-cli 1.6.x`（1.6 也兼容 1.5 项目）

### 构建项目

```bash
# 开发模式运行（在项目根目录）
cargo tauri dev

# 构建发布版本
cargo tauri build
```

**注意**: 项目使用 Tauri v1.5，请确保安装对应版本的 CLI。

## 🛠️ 技术栈

### 后端
- **语言**: Rust (Edition 2021)
- **框架**: Tauri 1.5
- **核心依赖**:
  - `memmap2`: 内存映射技术，支持超大文件处理（5GB+）
  - `encoding_rs`: 多编码支持
  - `chardetng`: 自动编码检测
  - `serde/serde_json`: 配置序列化
  - `parking_lot`: 高性能读写锁
  - `regex`: 正则表达式支持（章节识别）
  - `rayon`: 并行处理支持
  - `global-hotkey`: 全局快捷键支持

### 前端
- **技术**: HTML + CSS + JavaScript
- **特性**: 
  - 虚拟滚动优化大列表性能
  - CSS 变量实现主题系统
  - 响应式布局

## 📝 版本信息

当前版本: **1.3.2**

### 更新记录

**V1.3.2**
- 添加了章节末尾导航按钮功能，可在章节末尾显示【上一章】【下一章】按钮
- 添加了滚动到底部自动载入下一章节功能，支持提示和自动切换
- 优化了平滑滚动在边界处的处理，修复了滚动到底部时的抖动问题
- 修复了设置持久化保存问题，确保配置正确保存和加载

**V1.3.1**
- 添加了老板键功能，可以自定义快捷键。默认 Alt+Q 隐藏，Alt+S 显示
- 添加了新主题 Office-Word
- 关于窗口匹配了主题

**V1.3.0**
- 优化了阅读进度记录
- 修复了其他小问题

## 📄 许可证

本项目由 Eersoft 开发。

官网: http://www.eersoft.top

## 🤝 贡献

欢迎提交 Issue 和 Pull Request！

1. Fork 本仓库
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 开启 Pull Request

## 📋 开发计划

- [ ] 支持书签功能

## 🙏 致谢

感谢所有为本项目做出贡献的开发者！

---

**一叶书** - 让阅读更简单，让文本更清晰。