简介 | 咸鱼Bot

# 简介

咸鱼Bot是运行于Node.js (opens new window)，使用TypeScript (opens new window)编写的自用HTTP API框架。

因为并没有人使用所以更新比较随心所欲，经过多次重写，现在已是较为完善(自认为)的Bot框架。

# 快速开始

运行咸鱼Bot需要Node.js环境，和HTTP API客户端，请先安装。

注意事项

咸鱼Bot的API与事件根据go-cqhttp (opens new window)编写，与其它的HTTP API客户端不一定兼容，所以不推荐使用其它HTTP API客户端。
目前仅支持websocket链接。

# 安装

npm install xianyu-robot
# yarn add xianyu-robot

# 使用

推荐使用TypeScript开发以获得更好的代码提示

import App from 'xianyu-robot'

const app = new App()
app.start()

# App

除start方法外，其它方法可连续调用，如：

app
  .admin(10001)
  .plugin(PluginA)
  .plugin(PluginB)
  .white[10001]
  .start()

# 设置管理员

app.admin(10001)

# 添加不输出事件日志的群

app.noLog([10001])

# 添加禁用内置指令的群

app.noSysComm([10001])

# 添加群黑/白名单

设置后插件和命令将会对列表中的群号无效/有效，黑名单和白名单不能同时使用，后调用的将会失效。

app.black([10001])
// app.white([10001])

# 载入插件

app.plugin(PluginName, PluginOption)

插件可使用类插件或者函数插件，简单功能可使用函数插件 接收参数为Bot类，如使用函数插件实现复读

app.plugin(bot => {
    bot.Event.on('message.group', e => {
        bot.Api.sendGroupMsg(e.group_id, e.message)
    })
})

# 启动Bot

启动方法，请在最后调用该方法有3个参数，均为可选属性，分别为：

WS设置
是否开启debug（若为true则所有API方法将不会真正调用）
是否显示事件日志（若为false则不会显示事件日志）

以下为默认属性

app.start({
  wss: false, // 是否使用wss
  accessToken: '', // API的访问token
  host: '127.0.0.1', // 客户端地址
  port: 6700, // 客服端端口
  reconnection: true, // 是否连线错误时自动重连
  reconnectionAttempts: 1000, // 连续连线失败的次数不超过这个值
  reconnectionDelay: 1000 // 重复连线的延迟时间, 单位: ms
}, false, true)

该方法为异步函数，可使用then在Bot完全启动后执行某方法

app.start()
  .then(bot => {
    console.log('Bot已启动')
  })

插件 →