Skip to content

快速开始

安装方式

  1. 通过 NB-CLI 安装(推荐)
bash
nb plugin install nonebot-plugin-suggarchat

如果使用以下方法需要在你机器人项目根目录的pyproject.toml中的plugins列表做如下修改:

toml
plugins=['nonebot_plugin_suggarchat']
#添加"nonebot_plugin_suggarchat"
  1. 通过 pip 安装 确保已安装 Python(版本>=3.10)。 打开命令行工具,执行以下命令来安装插件:
bash
pip install nonebot-plugin-suggarchat
  1. 通过 UV 安装
bash
uv add nonebot_plugin_suggarchat

初次配置

  • 配置文件路径: 将在插件启动输出,为config.toml。 主要说明: 对于部署一个简单的聊天机器人,你只需要在configdefault_preset表填写api_key,base_url,model;并将enable的值改为 true。我们提供了一个即配即用的部署方式。

    支持使用${变量名}或者作为环境变量占位符

提示词设置

提示词位于在控制台打印的 config 文件夹,分别为group_prompts目录与private_prompts,内文件格式为提示词.txt,分别对应群聊和私聊的提示词,您可以使用指令切换或者在配置文件修改,默认会生成 default.txt,您通常只需要修改 default.txt 即可。

文件位置

如果您无法找到配置文件目录,可以在机器人根目录执行nb localstore即可获取到当前的存储位置。

数据库配置

3.4.0开始,我们使用了nonebot-plugin-orm来存储数据,抛弃了原有的JSON存储(考虑到太原始以及文件数量过多导致inode可能耗尽的问题),因此需要配置数据库连接。

通常来说,您可以使用pip install nonebot-plugin-orm[default]来获得一个使用SQLite的即插即用配置。

如果您需要配置MYSQL等,请安装对应的可选依赖,参考SQLAlchemy的连接地址配置,本文档不过多介绍。

MIT License 发布 ,角色设定/提示词内容使用 CC-BY-NC-SA-4.0 协议授权