开源项目最佳实践教程：Assistant AI Helper Plugin for KOReader

1. 项目介绍

Assistant AI Helper Plugin for KOReader 是一个功能强大的插件，它允许用户在阅读时与人工智能语言模型（如 Claude、GPT-4、Gemini、DeepSeek、Ollama 等）进行交互。用户可以高亮文本并针对其提出问题，获取翻译、摘要、解释等内容，而不必离开书籍。该插件最初是从 AskGPT 项目分叉而来，并经过 WindSurf 修改。

2. 项目快速启动

获取 API 密钥

在使用前，您需要从所选的 AI 服务提供商那里获取 API 密钥：

• Claude/Anthropic: 访问 console.anthropic.com，注册或登录账户，然后创建新的 API 密钥。
• OpenAI: 访问 platform.openai.com，注册或登录账户，然后在 API 密钥部分创建新的密钥。
• Gemini: 访问 aistudio.google.com，注册或登录账户，然后获取 API 密钥。
• OpenRouter: 访问 openrouter.ai/，注册或登录账户，然后在 API 密钥部分创建新的密钥。
• DeepSeek: 访问 platform.deepseek.com，注册或登录账户，然后在 API 密钥部分创建新的密钥。
• Ollama: 不使用 API 密钥，但需要一个占位符 API 密钥值（例如："ollama"）。

安装插件

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. 将 configuration.lua.sample 复制为 configuration.lua（不要修改样本文件）。

2. 编辑 configuration.lua 文件，如下设置：

   • 在 provider 中设置您选择的 AI 提供商。
   • 在 provider_settings 中设置您的 API 密钥。
   • 在 features 部分确保语言设置正确（最初设置为 "Turkish"）。

3. 应用案例和最佳实践

• 提问: 高亮文本并使用插件提问，获取关于文本的深入解释。
• 翻译: 高亮文本并快速将其翻译成所需语言。
• 摘要: 阅读长篇文章时，使用插件生成摘要，节省时间。
• 自定义提示: 创建自定义提示以满足特定需求，例如，创建一个用于生成代码注释的提示。

4. 典型生态项目

• 开源社区: 在开源社区中，可以使用 Assistant AI Helper Plugin for KOReader 来帮助理解复杂的技术文档或代码。
• 教育: 教育工作者可以将该插件用于教学，帮助学生学习复杂的科学概念。
• 研究: 研究人员可以利用插件进行文献综述，快速理解新领域的关键概念。