wxbot

README

What's this?

一个还算有意思的wechat robot项目，理想将其设计成一个多功能的机器人助手 😈

• 🤨框架可无侵入扩展，现已接入千寻框架和vlw框架，请参考framework目录
• 🤨功能可无侵入扩展，现已集成plugins目录下的功能，请参考plugins目录

🔔 注意：

1. 使用本项目之前需要您已经配置好相关的 微信的hook 类软件，那么只需要在这类软件上设置回调地址即可
2. 本项目已接入vlw、千寻两个框架，如果您有其他框架，可自行添加(参考framework目录，实现IFramework接口即可)，或联系我添加
3. 本项目不提供任何hook类软件，您需要利用搜索引擎自行寻找
4. 本项目暂时只支持HTTP协议，关于websocket协议支持目前不考虑
5. 简而言之，本项目是一个消息处理的中间件，微信消息监听获取是从框架获取
6. 本项目仅供学习交流使用，不得用于商业用途，否则后果自负
7. 使用本项目造成封禁账号等后果（项目立项到现在，作者还没出现过异常），本项目不承担任何责任，实际上您使用任何非官方的微信机器人都有可能造成账号封禁，所以请谨慎使用
8. 如果您阅读了上面的内容，觉得没有问题，那么请继续阅读下面的内容

功能示例：

🎁 已对接API，展开看👇

// IFramework 这是接入框架所定义的接口
type IFramework interface {
	// Callback 这是消息回调方法，vx框架回调消息转发给该Server
	Callback(func(*Event, IFramework))

	// GetMemePictures 获取表情包图片地址(迷因图)
	// return: 图片链接(网络URL或图片base64)
	GetMemePictures(message *Message) string

	// SendText 发送文本消息
	// toWxId: 好友ID/群ID
	// text: 文本内容
	SendText(toWxId, text string) error

	// SendTextAndAt 发送文本消息并@，只有群聊有效
	// toGroupWxId: 群ID
	// toWxId: 好友ID/群ID/all
	// toWxName: 好友昵称/群昵称，留空为自动获取
	// text: 文本内容
	SendTextAndAt(toGroupWxId, toWxId, toWxName, text string) error

	// SendImage 发送图片消息
	// toWxId: 好友ID/群ID
	// path: 图片路径
	SendImage(toWxId, path string) error

	// SendShareLink 发送分享链接消息
	// toWxId: 好友ID/群ID
	// title: 标题
	// desc: 描述
	// imageUrl: 图片链接
	// jumpUrl: 跳转链接
	SendShareLink(toWxId, title, desc, imageUrl, jumpUrl string) error

	// SendFile 发送文件消息
	// toWxId: 好友ID/群ID/公众号ID
	// path: 本地文件绝对路径
	SendFile(toWxId, path string) error

	// SendVideo 发送视频消息
	// toWxId: 好友ID/群ID/公众号ID
	// path: 本地视频文件绝对路径
	SendVideo(toWxId, path string) error

	// SendEmoji 发送表情消息
	// toWxId: 好友ID/群ID/公众号ID
	// path: 本地动态表情文件绝对路径
	SendEmoji(toWxId, path string) error

	// SendMusic 发送音乐消息
	// toWxId: 好友ID/群ID/公众号ID
	// name: 音乐名称
	// author: 音乐作者
	// app: 音乐来源(VLW需留空)，酷狗/wx79f2c4418704b4f8，网易云/wx8dd6ecd81906fd84，QQ音乐/wx5aa333606550dfd5
	// jumpUrl: 音乐跳转链接
	// musicUrl: 网络歌曲直链
	// coverUrl: 封面图片链接
	SendMusic(toWxId, name, author, app, jumpUrl, musicUrl, coverUrl string) error

	// SendMiniProgram 发送小程序消息
	// toWxId: 好友ID/群ID/公众号ID
	// ghId: 小程序ID
	// title: 标题
	// content: 内容
	// imagePath: 图片路径, 本地图片路径或网络图片URL
	// jumpPath: 小程序点击跳转地址，例如：pages/index/index.html
	SendMiniProgram(toWxId, ghId, title, content, imagePath, jumpPath string) error

	// SendMessageRecord 发送消息记录
	// toWxId: 好友ID/群ID/公众号ID
	// title: 仅供电脑上显示用，手机上的话微信会根据[显示昵称]来自动生成 谁和谁的聊天记录
	// dataList:
	// 	- wxid: 发送此条消息的人的wxid
	// 	- nickName: 显示的昵称(可随意伪造)
	// 	- timestamp: 10位时间戳
	// 	- msg: 消息内容
	SendMessageRecord(toWxId, title string, dataList []map[string]interface{}) error

	// SendMessageRecordXML 发送消息记录(XML方式)
	// toWxId: 好友ID/群ID/公众号ID
	// xmlStr: 消息记录XML代码
	SendMessageRecordXML(toWxId, xmlStr string) error

	// SendFavorites 发送收藏消息
	// toWxId: 好友ID/群ID/公众号ID
	// favoritesId: 收藏夹ID
	SendFavorites(toWxId, favoritesId string) error

	// SendXML 发送XML消息
	// toWxId: 好友ID/群ID/公众号ID
	// xmlStr: XML代码
	SendXML(toWxId, xmlStr string) error

	// SendBusinessCard 发送名片消息
	// toWxId: 好友ID/群ID/公众号ID
	// targetWxId: 目标用户ID
	SendBusinessCard(toWxId, targetWxId string) error

	// AgreeFriendVerify 同意好友验证
	// v3: 验证V3
	// v4: 验证V4
	// scene: 验证场景
	AgreeFriendVerify(v3, v4, scene string) error

	// InviteIntoGroup 邀请好友加入群组
	// groupWxId: 群ID
	// wxId: 好友ID
	// typ: 邀请类型，1-直接拉，2-发送邀请链接
	InviteIntoGroup(groupWxId, wxId string, typ int) error

	// GetObjectInfo 获取对象信息
	// wxId: 好友ID/群ID/公众号ID
	// return: ObjectInfo, error
	GetObjectInfo(wxId string) (*ObjectInfo, error)

	// GetFriendsList 获取好友列表
	// isRefresh: 是否刷新 false-从缓存中获取，true-重新遍历二叉树并刷新缓存
	// return: []*FriendInfo, error
	GetFriendsList(isRefresh bool) ([]*FriendInfo, error)

	// GetGroupList 获取群组列表
	// isRefresh: 是否刷新 false-从缓存中获取，true-重新遍历二叉树并刷新缓存
	// return: []*GroupInfo, error
	GetGroupList(isRefresh bool) ([]*GroupInfo, error)

	// GetGroupMemberList 获取群成员列表
	// groupWxId: 群ID
	// isRefresh: 是否刷新 false-从缓存中获取，true-重新遍历二叉树并刷新缓存
	// return: []*GroupMemberInfo, error
	GetGroupMemberList(groupWxId string, isRefresh bool) ([]*GroupMemberInfo, error)

	// GetSubscriptionList 获取订阅列表
	// isRefresh: 是否刷新 false-从缓存中获取，true-重新遍历二叉树并刷新缓存
	// return: []*SubscriptionInfo, error
	GetSubscriptionList(isRefresh bool) ([]*SubscriptionInfo, error)
}

🎁 已接入框架，展开看👇

• 千寻框架
  • 具体配置查看 config.yaml 文件注释说明
  • 
• VLW框架
  • 具体配置查看 config.yaml 文件注释说明
  • 

🎁 已有插件 👇

• 百度百科-点击查看详情
  • 用法：发送百度百科 你要查的词，例如：百度百科 OCR
• ChatGPT聊天-点击查看详情
  • 用法：发送开始ChatGPT会话，然后就可以和机器人连续对话聊天了
• KFC疯狂星期四骚话-点击查看详情
  • 用法：发送kfc骚话，获取一条v50骚话
• 获取表情原图-点击查看详情
  • 用法：发送表情原图后30秒内发送一张表情包(迷因图)，即可获取原图
• 摸鱼办-点击查看详情
  • 用法：发送摸鱼或摸鱼办，即可获取一张摸鱼办图片
• 查拼音缩写-点击查看详情
  • 用法：发送查缩写 你要查的词，即可获取拼音缩写含义
• 获取美女图片-点击查看详情
  • 用法：发送漂亮妹妹，即可获取一张美女图片
• 查天气-点击查看详情
  • 用法：发送XX天气，即可获取XX地区的天气情况，例如：济南天气
• 获取每日早报-点击查看详情
  • 用法：发送早报或每日早报，即可获取每日早报
• 管理相关-点击查看详情
  • 可以全局设置定时任务
    • 设置每月8号10:00:00的提醒
    • 设置每周三10:00:00的提醒
    • 设置每天10:00:00的提醒
    • 设置每隔1小时的提醒
  • 可以全局监听好友添加邀请拉群等
• 公众号监控转发-点击查看详情
  • 用法：发送监控公众号 (gh_.*) 转发到 (.*)
  • 用法：发送监控公众号关键词 (.*) 转发到 (.*)

How to use?

本地运行

1. 拷贝代码

   git clone https://github.com/yqchilde/wxbot.git
   

2. 配置config.yaml

3. go run main.go 或自行build

Docker运行

1. 一键脚本启动

bash -c "$(curl -fsSL https://raw.fastgit.org/yqchilde/wxbot/hook/docker/run.sh)"

1. 命令启动，注意提前配置config.yaml,否则会报错

docker run -d \
    --name="wxbot" \
    -p 9528:9528 \
    -v $(pwd)/config.yaml:/app/config.yaml \
    -v $(pwd)/data:/app/data \
    yqchilde/wxbot:latest

How to develop?

🤔如果您想要扩展自己的插件，可以参考plugins目录下的插件

🤔如果您想要扩展其他框架，可以参考frameworks目录下的框架

🤔如果您有不想要的插件，可在 main.go 上方代码中去掉对应插件的导入(不打算做成动态插件)

package main

import (
	"time"

	"github.com/spf13/viper"
	"github.com/yqchilde/pkgs/net"
	"github.com/yqchilde/wxbot/engine/pkg/log"
	"github.com/yqchilde/wxbot/engine/robot"
	"github.com/yqchilde/wxbot/framework/qianxun"
	"github.com/yqchilde/wxbot/framework/vlw"

	// 导入插件, 不需要的插件可以注释掉或者删除
	_ "github.com/yqchilde/wxbot/plugins/baidubaike"   // 百度百科
	_ "github.com/yqchilde/wxbot/plugins/chatgpt"      // GPT聊天
	_ "github.com/yqchilde/wxbot/plugins/crazykfc"     // 肯德基疯狂星期四骚话
	_ "github.com/yqchilde/wxbot/plugins/ghmonitor"    // 公众号消息监控转发
	_ "github.com/yqchilde/wxbot/plugins/jingdong"     // 京豆上车
	_ "github.com/yqchilde/wxbot/plugins/manager"      // 群组管理相关
	_ "github.com/yqchilde/wxbot/plugins/memepicture"  // 表情包原图
	_ "github.com/yqchilde/wxbot/plugins/moyuban"      // 摸鱼办
	_ "github.com/yqchilde/wxbot/plugins/pinyinsuoxie" // 拼音缩写翻译
	_ "github.com/yqchilde/wxbot/plugins/plmm"         // 漂亮妹妹
	_ "github.com/yqchilde/wxbot/plugins/weather"      // 天气查询
	_ "github.com/yqchilde/wxbot/plugins/zaobao"       // 每日早报
)

var conf robot.Config
var ping = true

func main() {
	// 初始化配置
	v := viper.New()
	v.SetConfigFile("config.yaml")
	if err := v.ReadInConfig(); err != nil {
		log.Fatalf("[main] 读取配置文件失败: %s", err.Error())
	}
	if err := v.Unmarshal(&conf); err != nil {
		log.Fatalf("[main] 解析配置文件失败: %s", err.Error())
	}

	// 初始化机器人
	frameworkType := v.GetString("frameworks.name")
	switch frameworkType {
	case "千寻", "qianxun":
		conf.Framework = robot.IFramework(qianxun.New(
			v.GetString("botWxId"),
			v.GetString("frameworks.apiUrl"),
			v.GetString("frameworks.apiToken"),
			v.GetUint("frameworks.servePort"),
		))
		if ipPort, err := net.CheckoutIpPort(v.GetString("frameworks.apiUrl")); err == nil {
			if ping = net.PingConn(ipPort, time.Second*20); !ping {
				log.Warn("[main] 无法连接到千寻框架，网络无法Ping通")
			}
		}
	case "VLW", "vlw":
		conf.Framework = robot.IFramework(vlw.New(
			v.GetString("botWxId"),
			v.GetString("frameworks.apiUrl"),
			v.GetString("frameworks.apiToken"),
			v.GetUint("frameworks.servePort"),
		))
		if ipPort, err := net.CheckoutIpPort(v.GetString("frameworks.apiUrl")); err == nil {
			if ping = net.PingConn(ipPort, time.Second*20); !ping {
				log.Warn("[main] 无法连接到VLW框架，网络无法Ping通")
			}
		}
	default:
		log.Fatalf("[main] 请在配置文件中指定机器人框架后再启动")
	}

	robot.WxBot = robot.Init(&conf)
	if ping {
		log.Println("[main] 开始获取账号数据...")
		friendsList, err := robot.WxBot.Framework.GetFriendsList(true)
		if err != nil {
			log.Errorf("[main] 获取好友列表失败，error: %s", err.Error())
		}
		groupList, err := robot.WxBot.Framework.GetGroupList(true)
		if err != nil {
			log.Errorf("[main] 获取群组列表失败，error: %s", err.Error())
		}
		subscriptionList, err := robot.WxBot.Framework.GetSubscriptionList(true)
		if err != nil {
			log.Errorf("[main] 获取公众号列表失败，error: %s", err.Error())
		}
		robot.WxBot.FriendsList = friendsList
		robot.WxBot.GroupList = groupList
		robot.WxBot.SubscriptionList = subscriptionList
		log.Printf("[main] 共获取到%d个好友", len(friendsList))
		log.Printf("[main] 共获取到%d个群组", len(groupList))
		log.Printf("[main] 共获取到%d个公众号", len(subscriptionList))
	}

	log.Printf("[main] 机器人%s开始工作", conf.BotNickname)
	robot.WxBot.Run()
}

调试-环境变量

环境变量名	变量类型	说明
DEBUG	bool	优先级大于其他DEBUG_开头的变量，开启后开启所有DEBUG模式 用于调试HTTP请求和调用日志文件名和行号
DEBUG_LOG	bool	用于调试调用日志文件名和行号

Feature

开发计划：🕒 开发计划
如果您感觉这个项目有意思，麻烦帮我点一下star
这个项目待(不)补(完)充(善)很多东西，由于工作关系会抽出时间弄，感谢您发现并使用此仓库

如果您有疑惑可以加Q群讨论

Thanks

JetBrains 开源证书支持

yqchilde/wxbot 项目一直以来都是在 JetBrains 公司旗下的 GoLand 集成开发环境中进行开发，基于 free JetBrains Open Source license(s) 正版免费授权，在此表达我的谢意。

开源项目

• 非Hook版机器人核心由 openwechat SDK实现，在nohook分支，已暂停维护

• Hook版机器人框架我使用的是 《我的框架》已跑路，现在用的是千寻，为hook分支

• hook分支大量借鉴了一个十分优秀的项目ZeroBot-Plugin的设计方案 👍🏻，其中很多基础代码来自ZeroBot-Plugin，在此基础上扩展了支持wechat的方式，非常感谢，Thanks♪(･ω･)ﾉ

License

AGPL-3.0 license. See the LICENSE file for details.