# read-tts

**Repository Path**: sprouting/read-tts

## Basic Information

- **Project Name**: read-tts
- **Description**: 本地看书、阅读、听书软件
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-27
- **Last Updated**: 2026-08-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 悦读 · read-tts

基于 **Electron + electron-vite + Vue 3 + Pinia + TypeScript** 的本地电子书阅读与语音朗读（TTS）桌面应用，整体为**亮色现代风格**。

## 功能

- **书架首页**：左侧图标导航（书架 / 阅读历史 / 设置），右侧展示书籍卡片（封面、书名、作者、分类、进度、收藏），支持搜索与分类筛选。
- **阅读页**：进入书籍后沉浸式阅读，支持章节切换、字号 / 行距 / 正文宽度 / 页面主题（纸白 · 羊皮纸 · 护眼绿）实时调整。
- **语音朗读**：基于浏览器 `speechSynthesis`（Web Speech API）的真实朗读，可逐句播放 / 暂停 / 上一句 / 下一句，朗读高亮当前段落。
- **阅读记录**：阅读进度、最近阅读列表自动持久化到 `settings.json`（绿色软件风格，位于应用目录）。
- **设置弹窗**：阅读偏好 + 语音朗读（语速 / 音调 / 音色）+ 关于，配置即时保存。

> 当前书籍与章节正文为**伪数据**，见 `src/renderer/stores/libraryStore.ts`，方便后续接入真实书源 / 本地文件。

## 技术栈

- [electron-vite](https://electron-vite.org/) 2.x（主进程 / 预加载 / 渲染进程三端构建）
- Vue 3（`<script setup>`）+ Vue Router（memory history）+ Pinia
- TypeScript strict

## 快速开始

```bash
npm install
npm run dev
```

其他命令：

```bash
npm run build       # 构建（输出到 out/）
npm run preview     # 预览构建产物
npm run typecheck   # 类型检查（web + node）
```

## 目录结构

```
src/
  main/index.ts        # Electron 主进程：窗口创建、窗口控制 IPC、设置持久化
  preload/index.ts     # contextBridge 暴露 window.electronAPI
  renderer/
    index.html         # 入口 HTML（亮色主题）
    main.ts            # Vue 应用入口
    App.vue            # 根组件：自定义标题栏 + 路由视图 + 全局亮色样式
    router/index.ts    # 路由：/ 首页，/reader/:id 阅读页
    stores/
      libraryStore.ts  # 书架伪数据、章节生成、筛选/进度/收藏
      settingsStore.ts # 全局设置读写（settings.json）
    views/
      Home.vue         # 首页：左侧导航 + 书架 / 阅读历史
      Reader.vue       # 阅读页：正文渲染 + TTS 逐句朗读
    components/
      layout/TitleBar.vue        # 无边框窗口自定义标题栏
      settings/SettingsDialog.vue# 设置弹窗（阅读偏好 / 语音朗读 / 关于）
    types/index.ts     # Book、AppSettings 等类型
resources/icon.png     # 应用图标（窗口 / 任务栏）
```

## 配置说明

全局配置保存在应用目录下的 `settings.json`（开发态为项目根目录，打包后为 exe 所在目录，可随程序拷贝）。已被 `.gitignore` 忽略。

## 常见问题

- **启动崩溃 `Cannot read properties of undefined (reading 'on')`**：部分环境（如某些 IDE / CI）预设了 `ELECTRON_RUN_AS_NODE=1`，会让 `electron.exe` 以纯 Node 模式运行。项目已在 `electron.vite.config.ts` 中自动移除该变量，若仍有问题可手动执行 `unset ELECTRON_RUN_AS_NODE && npm run dev`。
- **朗读无声音 / 音色列表为空**：语音由系统 TTS 引擎提供，请确认系统已安装中文语音包。