mewbot
TypeScript icon, indicating that this package has built-in type declarations

1.0.5-beta3 • Public • Published

mewbot

mewbot是一个面向Mew Online的Node.js库,能让您更轻松地与Mew的API交互,搭建自己的bot。包含客户端实现MewClient与bot业务框架实现MewBot

MewClient是Mew的客户端实现,特点:

  • 💬简单易用的且稳定的消息监听(WebSocket API封装、消息解析、事件分发、断线重连)
  • 🔌bot所需的HTTP API,覆盖范围包括据点、话题/节点、想法、评论、消息、情绪、媒体等等
  • 📜API文档

MewBot实现了基础bot业务,特点:

  • 🏠灵活的部署配置,功能可单独拆分至具体话题/节点,并在不同的话题/节点可以有不同的表现
  • 💡支持多种响应模式,@bot模式、回复模式、指令模式及混搭
  • 🔗异步消息处理与易扩展的回复链
  • 🧊防刷屏与指令冷却机制

您可以根据需求,选用MewClient来轻松快速地实现与Mew的交互、在此基础上开发您的bot框架;或选用MewBot来省去繁杂的基础业务实现工作,直接构建一个具有丰富功能的bot。

🔗示例bot | 🔗nana

快速上手

安装

使用npm或yarn:

npm i mewbot

并确保您的工程使用ESM,例如:

package.json

{
  ...
  "type": "module",
  ...
}

tsconfig.json

{
    "compilerOptions": {
        "target": "ES2020",
        "module": "ES2020",
        "moduleResolution": "Node",
        ...
    },
    ...
}

使用MewClient

getting-started.js

import { logger, LogLevel, MewClient } from "mewbot";

// 订阅据点ID: '不是机器人'
const subcriptionNodes = ['100554577263091712'];
// 监听话题/节点ID: '🍄'
const listenTopics = ['219353468583456768'];

// 创建MewClient并监听'message_create'事件
const client = new MewClient();
client.on('message_create', async (data) => {
    console.log('接收到消息:');
    console.dir(data);
    // 如果监听话题中收到了含有🍅的消息,则回复🥕
    if (listenTopics.indexOf(data.topic_id) != -1) {
        if (data.content && data.content.indexOf('🍅') != -1)
            await client.sendTextMessage(data.topic_id, '🥕🥕🥕!');
    }
});

// 设置授权Token
client.setToken('你的Token');

// 开启连接
client.connect({ subcriptionNodes });

// 调整日志等级,打印所有日志(可选)
logger.logLevel = LogLevel.Verbose;

这样就实现了一个简单的bot,运行后在🍄节点发送“🍅”,bot将会回复“🥕🥕🥕!”

message_create事件在收到新消息时触发,可使用多个client.on来监听不同类型的事件,所有事件类型

关于授权Token、据点ID、话题/节点ID的获取请参照常见问题

部署在其他据点时,请确保您是目标据点的管理员,或已取得目标据点管理员的同意。

使用MewBot

using-mew-bot.ts

  1. 配置授权信息,在项目根目录/storage文件夹下创建account.json,格式可参考account.sample.json
  2. bot配置,在项目根目录/storage文件夹下创建config.json,可将config.sample.json复制一份改名,配置项说明可参考BotConfig
  3. 编写回复器,这里编写一个收到“🍅”,就会回复“🥕🥕🥕!”的回复器:
class TomatoReplier extends Replier {
    // 3.1. 回复器类型,与bot配置文件中的`repliers`对应,当`repliers`中包含`all`时,默认启用所有功能
    type = 'tomato';

    // 3.2. 回复器测试,此方法中对消息进行预处理,返回相应的置信度与预处理数据
    async test(msg: Message, options: TestParams): Promise<TestInfo> {
        // 🙅‍无消息内容,返回置信度0
        if (!msg.content) return NoConfidence;
        // 🙆‍消息中包含🍅,返回置信度1
        if (msg.content.indexOf('🍅') != -1) return FullConfidence;
        return NoConfidence;
    }

    // 3.3. 回复消息,此方法中对消息进行回复。当回复器通过测试被选中时,此方法将被调用。
    async reply(bot: IBot, msg: Message, test: TestInfo): Promise<ReplyResult> {
        // 执行回复
        await bot.replyText(msg, '🥕🥕🥕!');
        return Replied;
    }
}

bot收到一条消息后,将依次调用所有回复器的test方法,根据挑选函数选取最合适的回复器,执行其reply方法,默认的挑选函数Replier.pick01优先选择置信度为1的回复器。

  1. 初始化选项
const options: InitOptions = {
    repliers: [ 
        new TomatoReplier(),
        // ...添加更多回复器
    ]
};
  1. 启动
const bot = new MewBot(options);
bot.launch();

这样就实现了一个简单的bot,如果使用示例配置,运行后在🍄节点发送“@bot 🍅”,bot将会回复“@你的名字 🥕🥕🥕!”。

完整代码:using-mew-bot.ts

更多示例请参考:示例bot | nana

MewBot启动流程、消息处理逻辑、存储:MewBot

回复器:ReplierMatryoshkaReplier

常见问题

文档

Mew API使用示例可参考测试代码:

开发

一些关于本仓库的开发说明。

补充Mew API

目前所有Mew相关的API均放在mew-client.ts中,向其中补充API时,请注意以下几点:

  • 所有HTTP请求方法返回值统一为Promise<Result<T>>,参考Resultrequest
  • 完善文档注释,并使用@category为方法分类
  • 编写单元测试并确保通过

单元测试

需要在test文件夹下创建account.json,格式:

{
    "token": "你的Token",
    "username": "或者Mew ID",
    "password": "密码"
}

Token与账号密码二选一,推荐使用Token。

测试框架使用mocha,运行:

npm run test

本仓库中用作测试的媒体(图片、视频等)遵循CC0协议。

事件

仅包含通过WebSoceket下发的各类事件。使用dispatch-test.ts来测试,运行:

npm run test-dispatch

如果新增事件,需要修改如下文件:

  • dispatch.ts:事件中的数据类型
  • mew-client.ts:在类头部补充相关的事件定义,在onDispatch中补充对事件的分发。

日志

使用logger.ts来统一输出日志。

API文档

API文档位于documents/api下,使用typedoc自动生成:

npm run doc

其他文档需要手动更新。

TODO

  • 封装图片、长文、视频、链接类型的想法发送方法

Package Sidebar

Install

npm i mewbot

Weekly Downloads

0

Version

1.0.5-beta3

License

MIT

Unpacked Size

175 kB

Total Files

59

Last publish

Collaborators

  • pamisu