项目作者: csvwolf

项目描述 :
Just another wechat bot
高级语言: JavaScript
项目地址: git://github.com/csvwolf/We-Mercury.git
创建时间: 2018-05-17T10:48:16Z
项目社区:https://github.com/csvwolf/We-Mercury

开源协议:MIT License

下载


We-Mercury

Another WeChat Bot.

QuickStart

安装:npm install we-mercury

配置 ./config.json,目前支持管理员配置和 profile,uin 会在登录后输出在 console,填写就能生效,profile 用于保存配置信息,在一段时间内不用重新扫码:

  1. {
  2. "admin": 0,
  3. "profile": "user"
  4. }

启用:

  1. const mercury = require('we-mercury')
  2. /**
  3. * commands: 内置的命令前缀和函数名
  4. * list: 函数列表
  5. * message callback: 用于监听 message 后的回调
  6. */
  7. mercury({
  8. // commands
  9. }, {
  10. // function list
  11. }, () => {
  12. // message callback
  13. })

一个标准的 commands:

  1. {
  2. '/room': {
  3. tip: '申请加入房间',
  4. method: 'AddRoom',
  5. paramsNum: 1
  6. },
  7. '/remove': {
  8. tip: '移除用户',
  9. method: 'RemoveMember', // 方法名,与 function list 对应
  10. paramsNum: 1 // 参数数量
  11. }
  12. }

一个标准的 function list

  1. const AddRoom = require('./add_room')
  2. const RemoveMember = require('./remove_member')
  3. module.exports = {
  4. AddRoom,
  5. RemoveMember
  6. }

内置了 add_roomremove_member。需要对每个命令配置规则,在根目录新建文件夹 rules,并创造 add_rooms.js(推荐与命令同名):

  1. module.exports = {
  2. 'live': /^知乎 Live/, // 参数 和 匹配条件,支持正则
  3. 'eleme-fe2017': '饿了么大前端交流群',
  4. 'boom-flower': '不锈钢姐妹花'
  5. }

然后走起。

具体的例子可见 /example

墨丘利(拉丁语:Mercurius)是罗马神话中为众神传递信息的使者