🛸 初次上手
Koodo Reader 是干什么的？
Koodo Reader 是一个开源免费的电子书阅读器，支持多达15种主流电子书格式， 内置笔记，高亮，翻译功能，助力高效书籍阅读和学习。
如何实现不同设备之间的数据同步?
我的数据存在哪里?
Koodo Reader 是一个本地优先的电子书阅读器， 您所有的数据都默认保存在您的本机：
- 客户端：您可以前往设置-通用，找到修改存储位置的选项，然后点击选项旁的定位按钮，就会跳转到您的图书库位置
- 网页版：如果您使用 Chrome，Edge等 Chromium类浏览器访问网页版，首次访问时您会看到一个选择数据存储位置的对话框，您可以选择将数据保存您指定的本地文件夹或者保存在浏览器缓存中。如果您使用的是其他浏览器，默认只会保存在浏览器缓存中。（安全提示：如果您的数据保存在浏览器缓存中，当缓存超过一定大小，就会触发系统自动清理，可能导致您的数据丢失，建议您及时备份数据，或者升级专业版将您的数据同步到网盘、WebDAV、对象存储、Docker等）
- 移动版：您的数据保存在系统为 Koodo Reader 分配的应用数据文件夹中，您通常无法直接访问这个文件夹。如果您需要清理缓存或清除全部数据，可以前往设置，滑动到最底部
如何与开发者取得联系?
Koodo Reader 未来的开发计划?
开发版和稳定版有什么区别?
Koodo Reader 从1.3.0开始分为稳定版和开发版。稳定版是开发版经过多个版本更新后功能稳定，bug 较少的版本，更适合普通用户。开发版一般功能更多，稳定版的 bug 也能得到及时修复，但可能会存在一些未知的 bug。普通用户只会接收到稳定版的更新，如果您要使用开发版，请前往：Koodo Reader - 下载
如何下载开发版？
如何开启摸鱼模式？
- 摸鱼模式可以隐藏图书窗口的边框并使背景透明，和其他软件放在一起无法分辨。开启之后，图书窗口将不能移动，按F12可以切换摸鱼模式和普通模式。注意：开启在主窗口打开图书后，将不能开启摸鱼模式。
- 首先打开一个空白 Word 文档。根据自己的需要，在右侧菜单中把阅读背景、翻页按钮、菜单按钮隐藏，开启单页模式或滚动模式，将图书窗口摆放到屏幕中间，调整好长宽后，按F12 键开启摸鱼模式。这样图书窗口就可以完全隐藏在 Word 中。
如何开启仿生阅读功能？
由于仿生阅读潜在的专利风险，我们不再内置仿生阅读功能，但您仍然通过安装仿生阅读字体的方式开启仿生阅读功能，您可以前往 Born2Root/Fast-Font: This font provides faster reading through facilitating the reading process by guiding the eyes through text with artificial fixation points. 下载该字体，然后将字体安装到系统中或者导入 App 中，然后从字体列表中切换该字体，即可开启仿生阅读
如何导入外部字体？
Koodo Reader使用的都是操作系统已经安装的字体，您可以双击字体文件，将字体安装到操作系统，然后重启 Koodo Reader，就可以在字体列表中看到您的字体了
Windows 系统不同安装包的区别
- 安装版：安装过程中可以选择软件的安装位置和权限，并创建快捷方式
- 便携版：无需安装双击直接运行，但启动时间较长
- 绿色版：由用户自己解压到指定位置，双击解压后的exe文件运行软件，运行速度和安装版一样快
快捷键操作指南
- 下一页：下方向键，右方向键或空格键
- 上一页：上方向键或左方向键
- 一键隐藏阅读器（老板键）：Tab 键
- 切换摸鱼模式和普通模式：F12 键
- 进入和退出全屏模式：F11键
⚙️ 解决办法
Linux 系统无法使用 TTS
Linux 上导入图书没有任何反应
由于部分三方库依赖特定版本的glbc，如果您的设备上没有安装对应版本glbc就可能发生这个问题，首先请打开控制台，从错误信息中获取您系统缺失的glbc版本。然后参考这里的回答安装对应版本的glbc: How can I get glibc 2.35 on Ubuntu 20.04? - Ask Ubuntu
Linux 上软件出现闪屏现象
整个问题常见于 Wayland加英伟达显卡，由显卡驱动导致的，解决办法是在软件启动命令后面加上 --enable-features=UseOzonePlatform --ozone-platform=wayland
Linux 上无法运行 AppImage 安装包
请在运行命令后面加上 —no-sandbox
macOS 提示 Koodo Reader 已损坏，无法打开
在 macOS 系统中，如果出现"文件已损坏"或"无法打开应用程序"的提示，这是因为应用程序没有开发者签名所导致的安全限制，可通过以下步骤解决：
- 打开"系统偏好设置" > "安全性与隐私" > "通用"，点击"仍要打开"按钮（如果显示）
- 如果上述方法无效，请打开终端(Terminal)，输入以下命令：
sudo xattr -c /Applications/Koodo\ Reader.app
- 输入管理员密码后，再次尝试打开应用程序
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 部署：请访问：使用 Docker 版
- 使用 Vercel、Netlify 之类的静态网站部署服务：Fork 本项目到自己的Github账号下，使用Github 注册 Vercel，依次点击 Overview → New Project →import 你 Fork 的 koodo-reader 仓库 → Deploy，等待几分钟就自动部署完成了
如何配合群晖的webdav实现数据备份？
- 下载webdav套件，启用http，将想要用来保存备份文件的共享文件夹的用户权限改成可读写，在Koodo的服务器地址中填写 http://[你的群晖ip或域名]:[webdav的端口号默认是5005]/[你用来保存备份文件的共享文件夹名称]，用户名和密码填你的群晖用户名和密码
- 仅支持英文文件夹路径
软件许可声明
- 本项目采用 AGPL-v3.0 开源协议。这意味着，如果您使用了本项目中的任何代码，则你必须将你的项目也以同样的协议开源。除此之外，您还必须在分发时以及软件中的显著位置，明确表示你的项目是基于 Koodo Reader 开发的，并链接到本项目 GitHub 仓库。
- 我们不提供商用授权。如果您需要商用，但不想开源您的代码，推荐您使用 foliate.js johnfactotum/foliate-js: Render e-books in the browser
- 本项目所依赖的开源库绝大多数采用MIT，Apache 2.0，BSD，ISC，CC0-1.0 ，仅 7zz-wasm 采用了LGPL，未依赖任何采用 GPL 和 AGPL 的开源库。完整列表见以下链接：
隐私保护声明
- Koodo Reader是一个本地阅读器，不需要注册账号即可使用，我们不会收集和上传您的阅读数据和隐私数据。
- Koodo Reader 不使用任何类似 Google Analytics 的服务
- 当软件启动后，会向我们的云端发送检查更新请求，请求中会包含您的系统语言信息，用于返回对应语言的更新日志。您可以在设置中关闭检查更新
Koodo Reader 有很多方面还不完善，欢迎您通过问题反馈和功能建议的方式，帮助 Koodo Reader 变得更好。