Skip to content

KroMiose/nonebot_plugin_dice_narrator

Repository files navigation

NoneBotPluginLogo

NoneBotPluginText

✨ 一只可爱的 AI 掷骰姬! ✨
💬 技术交流/答疑/讨论 -> :加入插件交流群-636925153 🗨️
pypi python python

Dice Narrator - AI 掷骰姬

已实现功能列表

  • 基础检定: [Command: 检定]

如果你有好的想法,欢迎提出 issue 或者 PR。

安装

nb plugin install nonebot-plugin-dice-narrator

配置

插件配置文件路径: ./configs/nonebot_plugin_dice_narrator/config.dev.yaml (启动一次服务后生成),请根据以下说明修改配置。

OPENAI_API_KEYS: # OpenAI API Key (可填多个*必须)
  - sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxx
  - sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxx
  - sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxx
OPENAI_BASE_URL: https://api.openai.com/v1 # OpenAI API Base URL
CHAT_MODEL: gpt-3.5-turbo # 使用的聊天模型
FORBIDDEN_USERS: # 禁止交互的用户列表
  - 123456
DIFFICULTY_DICE_MAX: 20 # 检定难度最大值 (即骰子面数)
OPENAI_PROXY: null # OpenAI 使用的代理
FORBIDDEN_WORDS: # 屏蔽词列表
  - xxxxxx
FILTER_WORDS: # 过滤词列表
  - xxxxxx
FILTER_PLACEHOLDER: "[数据删除]" # 过滤词替换占位符

使用

向 Bot 发送 检定 任务描述 (需要指令前缀),Bot 会根据其描述指定一个检定难度,并给出结果。

例如:

example case

注意: 你可以检定任意内容的文本,但不是所有文本都能得到良好的反馈,建议内容文本为一段可执行的任务,同时可以附上一些简要的任务背景概况;避免使用疑问句、无意义短句等意义不明的语句。

开发指南

如果你想为 Dice Narrator 贡献代码,可以参考以下步骤:

0. 开发准备

如果你希望你的代码被合并到主分支发布,请先提交 issue 或进群讨论说明你的想法,避免重复劳动或功能冲突。

1. 克隆代码

建议先 fork 项目到自己的仓库,然后再克隆自己仓库的代码。

git clone https://github.com/KroMiose/nonebot_plugin_dice_narrator.git # 这里的地址请改成自己的仓库地址

2. 安装开发环境依赖

poetry install

3. 运行项目

nb run --reload

🤝 贡献列表

感谢以下开发者对本项目做出的贡献

About

一只可爱的AI掷骰姬

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages