assistant.koplugin 的安装和配置教程

项目基础介绍

assistant.koplugin 是一个开源项目，旨在为 KOReader 提供一个 AI 助手插件，允许用户在阅读时与 AI 语言模型（如 Claude、GPT-4、Gemini、DeepSeek、Ollama 等）互动。通过高亮文本，用户可以提出问题、获取翻译、摘要、解释等，而无需离开阅读的书籍。

本项目主要使用 Lua 编程语言开发。

项目使用的关键技术和框架

本项目使用了以下关键技术和框架：

• KOReader: 一个开源电子书阅读器，支持多种设备和操作系统。
• AI 语言模型: 支持多种 AI 语言模型，如 Anthropic 的 Claude、OpenAI 的 GPT 模型等。
• API 接口: 与 AI 语言模型进行交互的接口。

安装和配置准备工作

在开始安装前，请确保以下准备工作已经完成：

1. 确保您的设备上已经安装了 KOReader。
2. 获取您所需 AI 服务提供商的 API 密钥。

安装步骤

方法一：使用最新版本

1. 克隆仓库到本地：

   git clone https://github.com/omer-faruq/assistant.koplugin.git
   

2. 将克隆的仓库重命名为 assistant.koplugin 并复制到 KOReader 的插件目录：

   • 对于 Kobo 设备：.adds/koreader/plugins/
   • 对于 Kindle 设备：koreader/plugins/
   • 对于 PocketBook 设备：applications/koreader/plugins/
   • 对于 Android 设备：koreader/plugins/

3. 根据需要创建或修改 configuration.lua 文件。

方法二：使用稳定版本

1. 从 GitHub 下载一个稳定版本的发布文件。
2. 解压下载的文件，将 assistant.koplugin 目录复制到 KOReader 的插件目录。
3. 根据需要创建或修改 configuration.lua 文件。

配置步骤

1. 将 configuration.lua.sample 文件复制为 configuration.lua（不要修改样本文件）。

2. 编辑 configuration.lua 文件，进行以下设置：

   • 在 provider 字段中设置您选择的 AI 提供商。
   • 在 provider_settings 字段中设置您的 API 密钥。
   • 确保 features 部分的语言设置与您的需要相符。

3. 保存 configuration.lua 文件。

完成以上步骤后，您就可以在 KOReader 中使用 assistant.koplugin 插件了。