HypeR Core

适配OneBot v11协议，目标多协议、功能模块化、易于扩展、高效的QQ机器人及框架

概览

HypeR Core 是一个适配OneBot协议的机器人框架，旨在提供一个简洁、高效、可扩展的机器人运行结构。

点我跳转详细文档 (English)

先前项目

使用 hytil 快速开始

---

🚧 该功能为老旧项目 HypeR Bot 设计，尚不适用于 HypeR Core，并且可能在以后被移除。

---

hytil 于 HypeR Bot 0.81.0 版本加入，是一个支持您快速配置完整 HypeR Bot 的实用工具。

安装 HypeR Bot

pip install hyper_bot

使用 hytil

$ python -m hytil
usage: hytil.py [-h] [-v] [-i] [-p PATH]

HypeR Bot Utils 版本 0.0.1

options:
  -h, --help            show this help message and exit
  -v, --version         显示版本信息
  -i, --install         安装完整的HypeR Bot到本地
  -p PATH, --path PATH  指定操作路径

在开始前，确认一个空文件夹，该文件夹将用于安装 HypeR Bot。

$ mkdir bot
$ ls
bot ...

现在，使用如下命令将完整的 HypeR Bot 下载到本地：

python -m hytil -i -p ./bot

下载完成后，您将会收到运行 main.py 的提示，此时，请您进入安装目录，在该目录下执行python main.py，配置文件 config.json 将随后创建，请根据下方指引编辑配置文件。

配置文件

config.json:

{
  "protocol": "OneBot",
  "owner": [],
  "black_list": [],
  "silents": [],
  "connection": {
    "mode": "FWS",
    "ob_auto_startup": false,
    "ob_exec": "./Lagrange.OneBot/Lagrange.OneBot",
    "ob_startup_path": "./Lagrange.OneBot/",
    "host": "127.0.0.1",
    "port": 5004
  },
  "log_level": "INFO",
  "log_use_nf": true,
  "uin": 0,
  "max_workers": 25,
  "others": {
    ...
  }
}

其中：

• owner：机器人主人的QQ号，填写在这个列表中的QQ号所发送的消息会被标记is_owner = True；
• black_list：黑名单，填写在这个列表中的QQ号所发送的的消息会被标记 blocked = True；
• connection：连接信息，包括主机地址、端口以及自动启动OneBot实现的配置；
• log_level：日志等级，可选值为DEBUG、TRACE、INFO、WARNING、ERROR、CRITICAL；
• others：其他配置项，允许开发者自行定义；
• log_use_nf：是否为日志输出启用NerdFont;
• protocol：适配的协议，目前仅支持OneBot.

关于该项目中使用的 ucfgr / cfgr

ucfgr 是本人早年间开发的配置文件管理器，但是我似乎一直都忘了公开他...

该项目设计为支持类型注解，允许一次读取、处处获取，并且无需多次定义就可以自由切换文件格式，支持文件自动创建。

目前设计支持 YAML 和 JSON 格式。

The universal config file manager for python

环境

本人开发和测试均在Python 3.11.7环境进行，其他版本未经测试，理论上支持 Python 3.9 及以上版本。

所需的第三方库陈列在requirements.txt中，使用pip install -r requirements.txt即可。

requirements_optional.txt中包含部分模块所需的其他依赖，可视情况安装。