AIReadest

AIReadest 是一个基于 Readest 演进出来的独立阅读器项目，目标是在保留本地优先阅读体验的前提下，提供可自托管、可自带 API 的联网能力。

目前项目重点放在这几类能力上：

• WebDAV 同步：适配私有云、自建 WebDAV、NAS、坚果云、Nextcloud 等场景
• AI 翻译：允许用户配置自己的 OpenAI-compatible API
• Ask AI：提供独立悬浮式 AI 对话，而不是依赖官方会员服务
• 本地优先：尽量避免把阅读能力绑定到账号、订阅或官方云

相关项目：

• Readest: https://github.com/readest/readest
• AIReadest: https://github.com/XuanYu-github/AIReadest

本项目遵循 AGPL-3.0 许可证发布，并保留上游项目与第三方组件的版权和许可证声明。

项目定位

AIReadest 不是原版 Readest 的官方版本，也不是 Readest 的镜像仓库，而是一个继续沿着“本地阅读 + 自托管同步 + 自带 API 的 AI 能力”方向发展的独立项目。

这个项目的核心思路是：

1. 阅读器本体应当尽量独立可用
2. 联网功能应优先支持用户自己的服务和自己的密钥
3. 新增能力不应依赖官方会员体系才能使用

当前功能

阅读能力

• EPUB / PDF / FB2 / MOBI / CBZ 等常见格式阅读
• 批注、书签、阅读进度、目录导航
• 桌面端与移动端多平台支持

WebDAV

• 书籍文件同步
• 封面同步
• 配置同步
• 笔记同步
• 手动同步入口
• 面向私有 WebDAV 场景的使用方式

AI 翻译

• 可在设置页中启用 AI 翻译
• 支持自定义 baseUrl、apiKey、model
• 面向 OpenAI-compatible 接口
• 适合接入自建中转、第三方兼容网关或自己的模型服务

Ask AI

• 阅读器顶栏提供 Ask AI 入口
• 选中文本工具中提供 Ask AI 入口
• 独立悬浮对话框
• 可基于当前选中文本提问
• 本地会话持久化
• 支持 OpenAI-compatible 与 Ollama

与上游方向的差异

相较于原版 Readest / 其他衍生版本，AIReadest 当前更关注这些方向：

• 保留本地阅读体验
• 强化 WebDAV 同步
• 引入可由用户自行配置的 AI 翻译与 AI 对话
• 尽量不依赖登录、订阅和官方托管服务

已知状态

当前仓库已经完成的主要工作包括：

• AI 翻译基础链路接入
• Ask AI 最小可用链路接入
• fixed-layout 阅读场景下的若干空指针/空对象崩溃保护
• 应用图标已更新为新的 SVG 源并重新生成 Tauri 资源

后续仍会继续完善，例如：

• Ask AI 的截图/附件能力
• 更完整的 AI 会话体验
• 更多同步与恢复细节
• 更多阅读器稳定性修复

使用说明

WebDAV

1. 打开应用设置中的 WebDAV 入口
2. 填写服务地址、用户名、密码和远程目录
3. 测试连接并保存
4. 按需执行同步

建议为 AIReadest 使用单独远程目录，例如 /AIReadest，避免与其他程序混用。

AI 翻译

1. 打开设置中的 AI Translation
2. 启用功能
3. 填写 Base URL、API Key、Model
4. 保存后即可在阅读流程中使用

Ask AI

1. 打开设置中的 AI
2. 启用 Ask AI
3. 选择 Ollama 或 OpenAI Compatible
4. 填写对应配置后测试连接
5. 回到阅读器，从顶栏或选中文本入口打开 Ask AI

仓库说明

• 主仓库用于承载 AIReadest 应用本体
• 部分上游能力通过 submodule 方式引用
• 构建产物、缓存目录和本地敏感配置不应直接提交到公开仓库

隐私与配置提醒

请不要把以下内容提交到公开仓库：

• .env
• .env.local
• 私有 API Key
• 各类本地测试配置

如果你是此仓库的二次修改者，也建议继续保持这一约定。

版权与许可

• 上游项目版权归原作者与各自贡献者所有
• AIReadest 的新增与修改部分版权归对应贡献者所有
• 许可证文本见 LICENSE
• 额外归属说明见 NOTICE.md
• 第三方依赖继续遵循各自许可证

如果你分发修改后的版本，请继续保留上游版权、许可证文本和第三方许可证声明。