Skip to content
MisiteQPublic

About

No description, website, or topics provided.

Resources

Stars

11 stars

Watchers

0 watching

Forks

Latest commit

 

History

23 Commits

Folders and files

Repository files navigation

惬意阅读 QYRead

Version fnOS License

飞牛 fnOS 上的私人书库与阅读中心(FPK 原生应用):搜书、管书、看书一站搞定。所有书籍与数据仅保存在你的 NAS 本机,不上传任何第三方服务器。

本项目基于「落地长安 轻阅读」改造(搜索原作者开发的手机客户端,可以连接本系统,不过有些功能是不通用的),小说搜索下载模块整合了 zsyo/go-novel 的书源与爬虫逻辑,在此感谢两位作者的开源分享。

  • 当前版本:v0.1.30
  • 作者:Misite齊
  • 适用平台:fnOS x86 + arm64(依赖应用中心的 Node.js v22,最低系统版本 1.1.8)
  • 默认端口:8344(安装向导可改)
  • 默认账号:admin / admin123(登录后请及时修改)

✨ 功能

  • 📚 多格式书库:TXT / EPUB / MOBI / AZW3 / PDF / CBZ / CBR / CB7,拖拽批量导入,自动识别书名、作者、出版社;封面与作者自动补全(优先用书籍内嵌封面与自带信息,缺失时自动按书名在聚合书源网络搜索,只填空缺不覆盖已有数据);书架支持 大封面 / 中封面 / 小封面 / 详细列表 四种视图(详细列表显示作者、读到的章节与阅读进度),公共书库 + 个人书库、收藏夹、搜索排序、阅读统计
  • 🔍 小说搜索下载(整合 go-novel):聚合多个书源搜索小说,一键下载 EPUB / TXT 自动入库;下载文件夹可自由选择(默认你设置的书籍文件夹,选新文件夹会自动注册为个人书库);全局任务面板实时显示阶段与百分比,支持 暂停 / 继续 / 取消,刷新页面自动恢复,书源卡死的「幽灵任务」60 秒内自动判失败并清理;已下载文件支持另存、删除与打开所在文件夹
  • 📖 沉浸阅读:目录导航、仿真翻页 / 上下滚动、字体字号行距边距与多款主题随心设置(切换主题时非阅读区外壳背景同步),划线高亮、批注笔记,阅读进度自动保存
  • 🔊 听书:默认 Edge 在线语音(晓晓、云希等多种音色,无需下载模型),保留本地离线引擎入口
  • 🔈 阅读白噪音:阅读器内置白 / 粉 / 棕噪音、雨声、海浪、篝火 6 种背景音(WebAudio 实时合成,不含音频文件),可调节音量与播放速度(0.5~2 倍),按钮支持浮动呼吸动画与长按拖拽(松手吸附左右、位置持久化),仅阅读界面显示入口,退出阅读自动停止
  • 🔄 在线自动更新:关于页可检查 GitHub Release 新版本,下载安装包到 NAS(支持镜像加速与 SHA256 校验)并一键安装重启,可开启后台自动检查安装

📦 安装

方式一:FnDepot 应用源(推荐)

在飞牛 fnOS 上安装 FnDepot 客户端后,添加作者的应用源即可搜索「惬意阅读」一键安装 / 升级:

https://github.com/MisiteQ/FnDepot

方式二:手动安装 FPK

  1. 到 Releases 按 NAS 架构下载:qyread-0.1.30-x86.fpk(x86 机型)或 qyread-0.1.30-arm.fpk(arm64 机型)
  2. 飞牛 OS → 应用中心 → 左下角 手动安装 → 选择 fpk 文件
  3. 按安装向导完成配置:
    • 端口与管理员:应用端口(默认 8344)、管理员用户名与密码
    • 数据存储子目录:在所选应用数据存储空间中创建,默认 qyread,用于存放数据库与上传的书籍
    • 现有书籍文件夹(可选):填写 NAS 中已有书籍文件夹的绝对路径(如 /vol1/1000/书籍),安装后会自动注册为公共书库并递归导入;安装时仅授予读取权限,不会移动、修改或删除原文件。留空可稍后在应用内「书库管理」中添加
  4. 安装后从桌面打开 惬意阅读,或直接访问 http://<NAS_IP>:8344

⚠️ 请给书籍路径添加权限(重要):应用只能访问被授权的文件夹。安装完成后请到 fnOS 应用中心 → 惬意阅读 → 权限(存储空间访问权限) 中,把书籍所在的文件夹(安装时填写的现有书库路径、应用内新增的书库目录以及小说下载目录)逐一添加授权;未授权的路径会导致书籍无法导入 / 打开、下载与另存失败或书库显示为空。新增书库目录后如遇读写异常,请回到此处检查该路径是否已授权。

若「手动安装」入口被关闭,SSH 执行:appcenter-cli manual-install enable 卸载时可选择保留或删除书库数据;保留数据重装后阅读进度与书架继续可用。

🛠 从源码打包

需要安装 fnpack 命令行工具。

Windows(PowerShell 5+)

项目根目录提供一键双架构构建脚本,会自动递增补丁版本号、准备两份构建树、替换 arm64 原生模块:

# 打包前先在 Linux 环境(或 WSL / fnOS)安装服务端依赖(sqlite3 为 Linux 原生模块):
#   cd app/server && npm install --omit=dev
.\build.ps1                 # 自动 patch +1(0.1.30 → 0.1.31),同步 manifest / package.json / 前端 ?v=
.\build.ps1 -Version 0.2.0  # 指定版本号
.\build.ps1 -NoBump         # 不修改版本号,按 manifest 当前版本打包
# 产物:qyread-<版本>-x86.fpk 与 qyread-<版本>-arm.fpk

Linux / fnOS

cd app/server && npm install --omit=dev   # 安装依赖(含当前机器架构的 sqlite3 原生模块)
cd ../..
fnpack build --directory .                # x86 机产出 x86 包

arm64 包使用 build-assets/node_sqlite3-linux-arm64.node 预编译原生模块(随仓库携带,仅构建时使用,不会打入 x86 包)。 每次发布新版本前,除脚本自动递增版本号外,还需在 manifest 的 changelog 中补上当次更新内容(关于页会读取展示)。

📁 项目结构

manifest                飞牛应用清单(版本、显示名、端口、依赖、更新日志)
wizard/install          安装向导(端口 / 管理员 / 数据目录 / 现有书籍文件夹)
wizard/uninstall        卸载向导(保留或删除数据)
cmd/                    飞牛生命周期脚本(安装回调、启动、卸载清理等)
config/                 飞牛权限与资源声明(以 package 用户 qyread 运行)
app/ui/                 前端:编译后静态资源 + 明文外挂增强 enhancer.js
  index.html            前端入口
  assets/enhancer.js    壳层增强(书架视图、关于致谢、自动入架等,不侵入 React bundle)
app/server/             后端:Node.js + Express + SQLite
  server.js             HTTP 服务入口
  bootstrap-library.js  安装引导:注册向导选择的书籍文件夹并首次扫描
  novel-ui/             小说搜索下载独立页面(SSE 实时任务)
  routes/               API 路由(书籍、阅读器、小说下载、TTS、统计等)
  services/             小说爬虫 / 下载器 / 进度管理 / EPUB 生成等
  parsers/ utils/       格式解析器、扫描队列、文件监听、工具模块
  rules/                小说书源规则(JSON)
build-assets/           arm64 预编译原生模块(仅构建时使用)
build.ps1               Windows 双架构一键打包脚本

🔒 隐私与安全

  • 所有数据库、配置、书籍文件均保存在 NAS 本地(应用数据空间或你指定的书库文件夹)
  • JWT 密钥在首次启动时随机生成(应用数据目录 .secret),仓库中没有任何硬编码密钥
  • 小说搜索仅在你主动发起时访问第三方书源,搜索结果版权归原作者所有,本功能仅供学习交流,请支持正版

🙏 致谢

  • 落地长安「轻阅读」:书库管理与沉浸阅读的基础项目(原项目地址以原作者发布为准)
  • zsyo/go-novel:小说搜索书源与爬虫模块
  • 飞牛 fnOS 与 FnDepot

📋 版本历史

版本 内容
v0.1.30 修复小说下载全部失败(#3):部分书源搜索结果书籍链接为相对路径,未补全为绝对地址导致 Node fetch 抛「Failed to parse URL」,搜索提取与详情抓取双重补全后恢复;下载面板不再把超时判死的旧任务加回显示。新增阅读「上下边距」调节(#4):0~160px 可调,手机全屏阅读避开挖孔/刘海遮挡,三种翻页模式均生效
v0.1.29 修复 Edge TTS 听书第二次起必报错(Cannot read properties of undefined (reading 'voiceLocale')):msedge-tts 库 setMetadata 未传第三参数,首次朗读后 voiceLocale 已设值导致条件短路失效、转而访问 undefined 抛错;调用处补传空对象绕过,连续朗读恢复正常
v0.1.28 书架封面与作者自动补全:导入后优先提取 EPUB/MOBI/AZW3/漫画等文件的内嵌封面与自带作者;TXT 等无内嵌信息的书籍自动按书名在聚合书源网络搜索(书名严格匹配,避免张冠李戴),命中后下载封面并补全作者;只填写空缺字段(「佚名/未知」等占位视为缺失),绝不覆盖已有数据;打开书架即后台自动处理,补全后即时刷新,搜不到保持原样
v0.1.27 应用介绍新增「请给书籍路径添加权限」重要提示:安装后需到 fnOS 应用中心 → 惬意阅读 → 权限(存储空间访问权限)中,把现有书库 / 新增书库目录 / 小说下载目录逐一授权,避免书籍无法导入打开、下载另存失败或书库为空
v0.1.26 彻底移除已下线的「读后感」与「成就」残留代码:后端删除成就路由 / 读后感接口与相关建表逻辑,前端移除我的页成就入口、管理中心「成就配置」tab、书籍详情读后感按钮及成就提示弹窗(界面无变化,功能此前已下线);修复启动清理脚本长期静默失败(sqlite3 构造器用法错误 + 未设 busyTimeout 导致旧表从未被删除),旧版本残留的成就 / 读后感数据表在启动后正确清理;安装说明与应用描述同步更新
v0.1.24 修复 x86 机型可能因 sqlite3 原生模块为空 / 错架构导致书库数据库打不开:打包脚本对 x86 包同样强制覆盖为预编译 Linux x64 二进制(此前仅 arm 包替换);修复卸载维护脚本 drop-tables 在新版 sqlite3 下加载失败(require('sqlite3').Database 取法适配)
v0.1.23 修复 Node 22 环境下服务启动失败(ERR_INVALID_PACKAGE_CONFIG):send 依赖的 ms@2.1.3 包内 package.json 含尾随逗号、设备残留空 package.json,已替换为合法 ms 并兜底所有空 package.json;小说下载代理设置与悬浮按钮靠边缩进功能随本版本生效
v0.1.22 小说下载新增「代理设置」:下载源管理页顶部可开启 HTTP/HTTPS 代理(Clash、V2Ray 等本地代理)并填写地址,启用后搜索与下载请求自动经代理转发,支持保存与一键连通性测试;阅读器内悬浮按钮(小说搜索、白噪音)停靠边缘后自动缩进仅露约 6px,悬停 / 点击再滑出,不再遮挡正文
v0.1.21 修复在线更新「备份当前程序失败:Permission denied」:备份目录从 /vol1/@appcenter/qyread.bak(qyread 用户无上级 @appcenter 写权限)改放到应用数据目录下;关于页内容容器从 max-w-sm(384px) 加宽到 46rem(736px),并自动放宽被 max-w-* 类限制的父级容器,版面更舒展大方
v0.1.20 小说下载界面新增「下载源设置」管理页(第三个 tab),可在线管理 go-novel 兼容规则书源:浏览全部书源并按分类(普通 / 限流 / 不可搜索 / 代理)显示徽章,可视化编辑规则 JSON(含 search / book / toc / chapter / crawl 字段格式说明),支持新增、编辑、删除、跨分类移动书源,改动即时写回规则文件并重建搜索 / 下载索引
v0.1.19 优化已是最新版时「立即更新」的体验:按钮直接显示为「重新安装」,确认弹窗明确提示「当前已是最新版、重新安装同版本、版本不变、用于修复异常」,与升级场景措辞完全区分;修复潜在隐患——仅当磁盘上存在与目标版本号一致的安装包才直接安装(按版本精确匹配),残留旧版本包不会被误用导致意外降级,状态接口新增已下载包版本号
v0.1.18 修复发现新版本后「立即更新」点不动(原来必须先手动下载):改为一键完成「下载 → 安装 → 重启」,全程阶段提示、3 秒轮询后台进度、防重复点击;修复勾选「自动检查并安装更新」后不生效(原来要等 6 小时定时周期):勾选后立即在后台执行检查 / 下载 / 安装,服务启动 60 秒后也会先自动检查一次;手动与自动安装加并发锁互斥;服务自重启改为 bash cmd/main restart(多候选路径,不依赖脚本可执行位)
v0.1.17 关于页调整板块顺序(简介 → 作者 → 软件更新 → 致谢 → 版权,更新面板移至致谢之前);最新版本也允许下载安装包(支持重装),下载期间按钮显示「正在下载…」并防重复点击
v0.1.16 彻底根治更新面板「当前版本」读成其他应用版本号(2.9.6/2.9.7):当前版本改为读取随安装包一起部署的 server/package.json,不再依赖 fnOS 目录结构猜测 manifest 路径,并移除会读到其他应用 manifest 的危险兜底;更新面板新增 GitHub 项目地址与「GitHub 下载」入口;下载到 NAS / 立即更新按钮在不可用时置灰并显示原因,不再点击无反应
v0.1.15 根修复版本读取全链路:manifest version= 行去掉等号两边空格(兼容混淆 server.js 的 /^version=(.+)$/m 正则,不再回退到上游硬编码 v2.9.6);build.ps1 写版本号同步改为无空格格式;enhancer.js 新增 XMLHttpRequest 拦截覆盖 React bundle 使用 axios/XHR 的场景
v0.1.14 修复关于页当前版本读取错误(manifest 路径未用 TRIM_PKGHOME 导致找不到清单返回 0.0.0)及自动更新多项缺陷:版本正则锚定行首、manifest 路径多重验证 appname、HTTPS 跟随 302 重定向
v0.1.13 书架详细列表(作者 / 章节 / 进度)改为自动刷新,从阅读页返回书架或页面切回前台时即时更新;白噪音按钮增加浮动呼吸动画与长按拖拽(吸附左右、位置持久化)、播放速度调整(0.5~2 倍)、初始位置垂直居中;新增在线自动更新(关于页检查 / 下载 / 安装 GitHub Release,镜像加速 + SHA256 校验,可自动检查安装)
v0.1.12 紧急修复 v0.1.11 白噪音入口实际未显示(初始化变量缺失 + 音效容器选择器不匹配,功能从未挂载);详细列表作者 / 章节 / 进度改优先采用书架接口自带字段并与进度接口合并,兼容性增强
v0.1.11 修复安装 / 升级后偶发服务未自启动(启动脚本重写:脱离安装事务会话、端口探活失败自动重试、清理残留占用);修复书架详细列表作者 / 章节 / 进度偶发失效(冷启动竞态,改为等待书库数据就绪 + 空结果重试 + 防并发覆盖);新增阅读器白噪音背景音(6 种音效,仅阅读页显示,离开自动停止)
v0.1.10 彻底修复「我的」页点击顶部用户卡片仍跳转已下线的成就页并报 s.map is not a function(改用文本节点遍历定位 + document 捕获阶段常驻拦截,React 重渲染也能拦住),右侧箭头同步隐藏
v0.1.9 修复书架「详细列表」视图书籍信息不显示(文件名带 .epub/.txt 扩展名与页面显示名匹配失败);列表视图不再显示封面缩略图;移除调试日志
v0.1.5 下载任务支持暂停 / 继续 / 取消;书源卡死幽灵任务根治(60 秒无心跳判失败 + 刷新页面主动回收);详细列表补充作者 / 章节 / 进度;修复「我的」页用户卡片点击报错;关于页新增上游致谢;修复升级后 NAS 桌面图标不刷新
v0.1.4 修复「语音配置」点击报错;听书默认 Edge 在线引擎;关于页版本号自动同步;小说搜索显式下载按钮;阅读自动入架;书架四种视图正式可用
v0.1.3 书架四种视图切换;阅读器外壳主题跟随;默认端口改 8344;TTS 恢复;AI / 成就模块彻底移除;适配 x86 + arm64
v0.1.1 下载文件夹自由选择、全局实时下载任务面板、已下载文件另存 / 删除 / 打开文件夹;下线 AI 助手、成就与分享
v0.1.0 首个版本:多格式书库、沉浸阅读、小说搜索下载、批注笔记、读后感与阅读统计

📄 许可证

MIT License © 2026 Misite齊

About

No description, website, or topics provided.

Resources

Stars

11 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages