NYXBot

项目创建于：2023-08-26

1. 下载OneBot 客户端

2. 配置客户端链接方式为 反向Websocket模式 填写链接

     ws://你服务器IP地址:端口号/ws/shiro
     
     ws://localhost:8080/ws/shiro

   • 以上链接为默认配置，若你使用了其他端口或域名，请自行修改
   • 你可以在web页面的配置中修改链接地址
     1. 在 web页面配置中选择 配置 -> 配置服务
     2. 在弹出的窗口中配置端口号与地址
     3. 点击确定按钮
     4. 之后重启NyxBot程序即可

3. 设置消息上报格式为 CQ码

4. 安装Java21 Oracle 或 Open Jdk 21

5. 下载NyxBot

6. 打开命令行工具，跳转到 "NyxBot.jar" 所存放的目录 启动命令 java -jar NyxBot.jar

7. 如若8080端口被占用或你想要使用别的端口可在启动命令后方添加参数.

   选择其中一个启动 NyxBot.jar
   java -Dserver.port = 8080 -jar NyxBot.jar
   
   java -jar NyxBot.jar --server.port = 8080

8. 详细部署文档

9. 云服务器推荐

1. 正常启动程序后会自动打开浏览器并跳转到 配置页面 http://localhost:8080
2. 在web页面登录 初始账号密码请查看控制台输出日志
3. 默认是配置是黑名单模式
   • 当添加白名单之后,只有白名单中的群才能使用机器人
   • 当添加黑名单之后,黑名单中的群不能使用机器人
4. 所有的配置都可以在web页面进行修改
5. 发送报错日志需在启动参数末尾上添加 --debug 参数

   •   # 如下启动命令
       java -jar NyxBot.jar --debug

   • Docker 平台添加 DEBUG = true 环境变量

OneBot协议客户端

• Shiro OneBot 协议Sdk
• RapidOcr-Java OCR 文字识别