finlater / weread.koplugin

# WeRead KOReader Plugin
> **免责声明**：本项目仅供个人学习和技术研究使用，不得用于商业用途。使用本项目所产生的一切后果（包括但不限于账号封禁、数据丢失等）由使用者自行承担，项目作者概不负责。请遵守微信读书的用户协议和相关法律法规。
在 KOReader 上阅读微信读书中的书籍、公众号文章的插件。支持同步进度同步，阅读时长同步和统计，查看书评、划线和想法。让Kindle、Kobo等封闭系统设备也能体验微信读书！
## 安装
> ⚠️ 建议使用 **KOReader 2026.03 或更高版本**。旧版本可能无法正常加载或使用插件，例如「工具」菜单中找不到「微信读书」。详见 #14。
1. 前往 GitHub Releases 下载最新的 `weread.koplugin-vX.Y.Z.zip` 安装包。
2. 解压安装包，得到 `weread.koplugin` 文件夹。
3. 将该文件夹复制到 KOReader 的 `plugins` 目录：
 [code] 
4. 重启 KOReader，在菜单中找到：
 [code] 
后续更新插件可在 **微信读书 → 设置 → 更新管理** 菜单中在线更新。
## 登录与认证
插件只支持微信扫码登录，扫码前需要先为账号开通微信读书 Skill：
1. 手机打开**微信读书 App**。
2. 进入 **我 → 设置 → 微信读书 Skill**。
3. 点击 **获取 API Key**，确认已经生成个人官方 API Key。
4. 在 KOReader 打开 **工具 → 微信读书 → 微信扫码登录**。
5. 使用微信扫码并在手机端确认；若手机显示四位验证码，请在 KOReader 中输入。
## 功能
| 主菜单 | 书架 | 公众号 |
|:---:|:---:|:---:|
| | | |
| 阅读时间上报 | 阅读统计 | 阅读进度同步 |
|:---:|:---:|:---:|
| | | |
| 多选章节下载 | 章节预下载 | 下载全书 |
|:---:|:---:|:---:|
| | | |
| 书籍详情 | 书评 | 划线和想法 |
|:---:|:---:|:---:|
| | | |
| 搜索书籍 | 快捷菜单 | 设置 |
|:---:|:---:|:---:|
| | | |
## SimpleUI / Zen_UI 集成
插件提供统一的“微信读书书架”入口并支持集成到 SimpleUI和 ZenUI的快捷按钮中。(需要安装最新版 SimpleUI 和 ZenUI插件)。
- **SimpleUI**：进入 `快捷操作` 新建操作，类型选择 `插件 → 微信读书`，再把该操作加入底部栏即可。如需使用本项目图标，将 `icons/weread-w-book.svg` 或 `icons/weread-ink.png` 复制到 SimpleUI 的自定义图标目录`koreader/setting/simpleui/sui_icons`后，在快捷操作中选中它。
- **Zen_UI 底栏**：进入 `控件 → 按钮 → ➕ → 插件 → 微信读书`，点击后直接打开微信读书书架。注册时会把 `weread-w-book.svg` 同步到 KOReader 用户图标目录，供 ZenUI 自动匹配或手动选择；不会自动修改、添加或启用 Tab。
- **Zen_UI 首页**：进入 `主页 → 小组件`，启用“微信读书”组件。组件默认关闭，可由用户自行排序。
原生 KOReader 的 “工具 → 微信读书” 菜单保持不变。
| SimpleUI | Zen_UI |
|:------------------------------------------------:|:------------------------------------------:|
| | |
## 菜单结构
 [code] 
## 贡献
欢迎提交 issue 和 PR。提交前请阅读 CONTRIBUTING.md。
XPointer 外部标注层仍是实验性功能，测试步骤和限制见
原型说明。
## 许可证
本项目代码采用 GNU Affero General Public License v3.0，SPDX 标识为 `AGPL-3.0-only`，与 KOReader 使用的许可证保持一致。
修改、整合或再分发本项目时，必须遵守 AGPL-3.0，保留版权和许可证声明，并按许可证要求将本项目代码或其衍生作品开源。
`fonts/NotoEmoji-Regular.ttf` 是第三方字体，采用 SIL Open Font License 1.1，不适用本项目的 AGPL-3.0。
Copyright © 2026 finlater and contributors.
## 项目推荐
| 插件 | 简介 |
|------|-----------------------------------------------------|
| kindlebtcontroller.koplugin | 蓝牙手柄/遥控器控制 Kindle —— 翻页、调节亮度、章节跳转等 20+ 操作，按键完全可自定义。 |
| one.koplugin | 在 KOReader 上离线阅读「ONE · 一个」每日更新：一图、一文、一问答。 |