跳到主要内容

快速开始

本指南将帮助你快速设置并运行 Knowlith 插件的核心功能。

1. 安装插件​

  • 将下载的 Knowlith-x.x.x.jar 文件放入服务器的 plugins 文件夹。
  • 重启服务器。插件会自动生成配置文件。

2. 配置 API 密钥​

  • 打开 plugins/Knowlith/modules/llm.yml 和 plugins/Knowlith/modules/embedding.yml。
  • 找到 apiKey 字段，填入你的 AI 提供商（如 SiliconFlow）的 API 密钥。
    • 推荐: 使用环境变量 ${ENV_VAR_NAME} 并设置对应的环境变量。
  • 保存文件。

3. （可选）准备知识库内容​

  • 如果你想使用 QA 功能，请准备一些 Markdown (.md) 或纯文本 (.txt) 文件，包含你希望 AI 学习的知识。
  • 将这些文件放入服务器的一个文件夹中，例如 plugins/Knowlith/docs/my_knowledge。

4. 配置知识库（如果需要）​

  • 打开 plugins/Knowlith/modules/knowledge.yml。
  • 修改或添加一个知识库配置，确保 sources 下的 path 指向你存放知识文件的文件夹（例如 ./docs/my_knowledge）。
  • 保存文件。

5. 重载插件并嵌入知识库​

  • 在服务器控制台或游戏内（需要权限）执行命令：/kl reload
  • 如果你配置了知识库，请在游戏内执行命令：/knowledge manage
  • 在打开的界面中，找到你的知识库，右键点击它，然后确认嵌入。等待处理完成。

6. 开始使用！​

  • AI 聊天: /aichat open
  • 知识库问答 (QA): /qa ask [你的问题]

现在你可以开始体验 Knowlith 插件的 AI 功能了！更详细的配置和命令请参考其他文档页面。