HypeR Bot 文档

Appearance

快速开始 ​

HypeR Bot 十分易于配置，不要畏惧接下来的任何一行文字（doge）

配置OneBot实现 ​

HypeR Bot 是使用 OneBot v11 协议的机器人和机器人框架，因此，想要使用HypeR Bot，OneBot 实现是必须的。

推荐到 OneBot 实现如下：

  1. Lagrange.OneBot;
  2. OpenShamrock;
  3. LLOneBot;
  4. NapCat
  5. go-cqhttp

在以上实现中，OpenShamrock、LLOneBot、NapCat 以及 go-cqhttp 都有详细的文档，故在此不多做介绍（才不是我懒），因此以下提供针对 Lagrange.OneBot 的配置教程。

配置 Lagrange.OneBot ​

想要配置，当然要先下载。 Lagrange.OneBot 支持多种系统平台和架构，根据你的状况选择合适的即可。

下载完成后，解压（废话*1），找到名为 Lagrange.OneBot 的可执行文件，运行他。

欸！！！他为什么输出了两行日志就卡住了？！

不必心急，现在，关掉 Lagrange.OneBot 的窗口，看看你的文件目录：哇！多了一个叫appsettings.json的文件欸~

很好。这是 Lagrange.OneBot的配置文件，打开它，开始填写基本的配置吧（废话*2）。

咳咳

Lagrange.OneBot 的配置文件大致分为六部分，让我们一点点来。

第一部分是有关日志输出的设置，在一般情况下建议如下设置：

json
{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Information",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  }
}

这样，你可以看到基本的日志信息，也不会导致大量的“冗余日志”（意味深）。

接下来，跳过SignServerUrl和MusicSignServerUrl这两行，往下看。

第三部分：账户设置。

json
{
  "Account": {
    "Uin": 0,
    "Password": "",
    "Protocol": "Linux",
    "AutoReconnect": true,
    "GetOptimumServer": true
  }
}

由于 首次登录需要扫描二维码，因此并不建议调整这部分内容，尤其注意千万不要修改Protocol的值

Message和QrCode部分，默认即可。

接下来是关键的Implementations部分，这一部分是 OneBot 实现最重要的内容之一，具体的配置参考 OneBot v11 文档。如果你不想费劲取配置这部分，我为您提供一份可以完美配合 HypeR Bot 的配置：

json
{
  "Implementation": {
    "ForwardWebSocket": {
      "Host": "127.0.0.1",
      "Port": 5004,
      "HeartBeatInterval": 5000,
      "AccessToken": ""
    }
  }
}

好了，现在你已经完成了 Lagrange.OneBot 的基本配置，扫码登陆即可。接下来的部分会更简单。

配置 HypeR Bot ​

同样，先下载（废话*3

呃，这个是源码包，以后会有 release 的。

下载完成，解压，打开config.json。

json
{
  "owner": [
    2488529467
  ],
  "black_list": [
    3497623764
  ],
  "silents": [
    894446744
  ],
  "Connection": {
    "mode": "FWS",
    "host": "127.0.0.1",
    "port": 5004,
    "listener_host": "127.0.0.1",
    "listener_port": 5003,
    "retries": 5
  },
  "Log_level": "INFO",
  "protocol": "OneBot",
  "Others": {
    "Chat": {
      "Qwen": {
        "key": "sk-key"
      }
    },
    "uin": 3591992788
  }
}

一点点来。

  • owner部分：设置该机器人的所有者，支持多人。
  • black_list：将部分用户放进服务黑名单。这并不意味着该用户的消息不会被处理，而是被模块选择性的处理。
  • silents：静默运行的聊群，将会对模块上报，同样被模块选择性处理。
  • Connection：与 OneBot 实现对接的设置，使用以上配置文件的默认设置即可与以上上提供的 Lagrange.OneBot 配置文件完美搭配。
  • 剩下的别管了。

使用如下命令补全依赖：

python -m pip install -r requirements.txt

接下来，使用如下命令运行 HypeR Bot:

python main.py

看到 ℹ️ INFO 成功建立连接 的日志，即表明与 OneBot实现对接成功。enjoy it!

操作手册