🚀 初次上手
Koodo Reader 是干什么的？
- Koodo Reader 是一个开源免费的电子书阅读器，支持多达15种主流电子书格式， 内置笔记，高亮，翻译功能，助力高效书籍阅读和学习。
如何实现不同电脑之间的数据同步?
- 同步是借助第三方网盘实现的。不同电脑上的 Koodo Reader 共用网盘中的同一文件夹作为数据存储位置，当你在其中一台电脑上点击同步按钮，Koodo Reader 中的数据会被复制到这个文件夹。其他电脑上的 Koodo Reader 就可以从这个文件夹中获取数据并覆盖到 Koodo Reader 中，从而实现数据同步。
- 手把手教程：
- 保证两台电脑上的同步文件夹都存在，且文件夹下没有任何文件
- 在其中一台电脑导入图书，前往设置把数据存储位置修改为同步文件夹，点击同步按钮
- 在另一台电脑上，等待同步数据下载完成，打开 Koodo Reader，前往设置把数据存储位置修改为同步文件夹，退出并重新打开 Koodo Reader。
- 此时数据已同步到另一台电脑上，今后在任意一台电脑上做出修改，点击同步按钮后，再在另一台电脑上打开 Koodo Reader，点击同步按钮，即可实现同步
我的数据存在哪里?
- 您所有的数据都保存在了您的本机，我们不会上传您的任何数据，您也只能在导入图书的电脑上访问这些数据。
- 客户端：您所有的数据包括图书和各种配置数据都存储在一个单独文件夹，不同操作系统这个路径都不同，您可以在设置→修改存储位置中找到 koodo-reader 这个文件夹。删除这个文件夹会完全删除所有数据
- 网页版：你所有的数据都作为缓存临时保存在浏览器中，除你之外的任何人都无法接触到这些数据，你也只能在导入图书的浏览器中访问这些数据。清除浏览器缓存会导致数据丢失。
如何与开发者取得联系?
- 请访问以下链接，了解如何和我们取得联系
Koodo Reader 未来的开发计划?
请访问此链接了解 Koodo Reader 的开发计划：https://koodoreader.com/zh/roadmap
开发版和稳定版有什么区别?
- Koodo Reader 从1.3.0开始分为稳定版和开发版。稳定版是开发版经过多个版本更新后功能稳定，bug 较少的版本，更适合普通用户。开发版一般功能更多，稳定版的 bug 也能得到及时修复，但可能会存在一些未知的 bug。普通用户只会接收到稳定版的更新，要使用开发版只能前往 Github Release 下载。
如何下载开发版？
- 您可以前往 Github Release 下载最新开发版：https://github.com/koodo-reader/koodo-reader/releases
如何开启摸鱼模式？
- 摸鱼模式可以隐藏图书窗口的边框并使背景透明，和其他软件放在一起无法分辨。开启之后，图书窗口将不能移动，按F12可以切换摸鱼模式和普通模式。注意：开启在主窗口打开图书后，将不能开启摸鱼模式。
- 首先打开一个空白 Word 文档。根据自己的需要，在右侧菜单中把阅读背景、翻页按钮、菜单按钮隐藏，开启单页模式或滚动模式，将图书窗口摆放到屏幕中间，调整好长宽后，按F12 键开启摸鱼模式。这样图书窗口就可以完全隐藏在 Word 中。
Windows 系统不同安装包的区别
- 安装版：安装过程中可以选择软件的安装位置和权限，并创建快捷方式
- 便携版：无需安装双击直接运行，但启动时间较长
- 绿色版：由用户自己解压到指定位置，双击解压后的exe文件运行软件，运行速度和安装版一样快
快捷键操作指南
- 下一页：下方向键，右方向键或空格键
- 上一页：上方向键或左方向键
- 一键隐藏阅读器（老板键）：Tab 键
- 切换摸鱼模式和普通模式：F12 键
- 进入和退出全屏模式：F11键
🗂 解决办法
Linux 系统无法使用 TTS
macOS 提示 Koodo Reader 已损坏，无法打开
txt 格式图书出现了乱码
- Koodo Reader 已经支持了大部分文本编码的txt，如果还是存在乱码问题，请参考一下做法
- 首先请确定电子书在其他文本编辑器是否存在乱码问题
- 如果不存在乱码，请将文件另存为utf-8编码的文件，然后再导入 Koodo Reader
图书内容一片空白，软件失去响应
- 图书本身有问题：请检查该图书是否能被其他阅读器打开
- 图书体积太大：电脑性能或者内存不足，导致打开图书耗时太长
使用Google Drive 同步盘进行数据同步后，部分PDF图书提示图书不存在
- Google Drive 会自动识别出PDF文件，然后给文件加上后缀名，导致 Koodo Reader 无法找到原文件，手动再删除掉后缀名可以修复
🤝 更多
如何部署网页版
- 使用 Nginx 或 Apache 部署：首先需要您下载项目到本地，安装好 node 和 yarn 的环境，在项目根目录下，打开命令行工具，输入 yarn，等待依赖安装完毕之后，输入 yarn build，完成之后，会在根目录下生成 build 文件夹，里面包含用于网页版部署的文件，然后您可以使用宝塔之类的工具，把 build 文件夹下的文件上传到网站的根目录。
- 使用 docker 部署：前往Dockerhub 搜索关键词 koodo，选择一个下载数多或最近更新的镜像拉取到服务器中，进行部署。
- 使用 Vercel、Netlify 之类的静态网站部署服务：Fork 本项目到自己的Github账号下，使用Github 注册 Vercel，依次点击 Overview → New Project →import 你 Fork 的 koodo-reader 仓库 → Deploy，等待几分钟就自动部署完成了
如何配合群晖的webdav实现数据备份？
- 下载webdav套件，启用http，将想要用来保存备份文件的共享文件夹的用户权限改成可读写，在Koodo的服务器地址中填写 http://[你的群晖ip或域名]:[webdav的端口号默认是5005]/[你用来保存备份文件的共享文件夹名称]，用户名和密码填你的群晖用户名和密码
- 仅支持英文文件夹路径
网页版（Docker版）使用说明
- Koodo Reader 只是一个本地阅读器，你所有的数据都只会保存在本机，网页版的数据作为缓存临时保存在了浏览器中，清理缓存会导致数据丢失
- 推荐使用 Chrome 和 Chromium 类浏览器访问，火狐、Safari、IE 等浏览器可能存在 UI 和功能上的 bug，开发者没有精力去专门适配这些浏览器
软件许可声明
- 本项目采用 AGPL-v3.0 开源协议。这意味着，如果您使用了本项目中的任何代码，则你必须将你的项目也以同样的协议开源。除此之外，您还必须在分发时以及软件中的显著位置，明确表示你的项目是基于 Koodo Reader 开发的，并链接到本项目 GitHub 仓库。
- 本项目所依赖的开源库绝大多数采用MIT，Apache 2.0，BSD，ISC，CC0-1.0 ，仅 7zz-wasm 采用了LGPL，未依赖任何采用 GPL 和 AGPL 的开源库。完整列表见以下链接：
隐私保护声明
- Koodo Reader是一个本地阅读器，不需要注册账号即可使用，我们不会收集和上传您的阅读数据和隐私数据。
- 出于隐私保护考虑，从1.5.2版开始，Koodo Reader 不再内置任何类似 Google Analytics 之类的服务
- 需要您注意的是，当软件启动后，会向我们的远程服务器发送检查更新请求，请求中会包含您的系统语言信息，用于返回对应语言的更新日志。您可以在设置中关闭检查更新
Koodo Reader 有很多方面还不完善，欢迎您通过问题反馈和功能建议的方式，帮助 Koodo Reader 变得更好。