首頁>編程相關>其他源碼
下載

WxBot

  • What's this?
    • 已對接框架
    • 已對接API
    • 已有插件
    • 指令大全
  • How to use?
    • 本地運行
    • Releases包
    • Docker運行
    • Actions編譯
  • How to develop?
    • 製作插件或接入其他框架
    • 參考案例
    • 調試-環境變量
    • 提交Pr注意項
  • Feature
  • Thanks
  • Support
  • License

What's this?

一個還算有意思的wechat robot項目，理想將其設計成一個多功能的機器人助手?

  • ?框架可無侵入擴展，現已接入Dean DLL 、千寻框架、 vlw框架，請參考framework目錄
  • ?功能可無侵入擴展，現已集成plugins目錄下的功能，請參考plugins目錄
  • ?新手視頻教程
    • BiliBili：https://www.bilibili.com/video/BV1Q84y1c7iF
    • YouTube：https://www.youtube.com/watch?v=JMeEa7ETIL0

? 注意：

  1. 使用本項目之前需要您已經配置好相關的微信的hook類軟件，那麼只需要在這類軟件上設置回調地址即可
  2. 本項目已接入Dean DLL 、千寻、 vlw三個框架，如果您有其他框架，可自行添加(參考framework目錄，實現IFramework接口即可)，或聯繫我添加
  3. 本項目不提供任何hook類軟件，您需要利用搜索引擎自行尋找
  4. 本項目暫時只支持HTTP協議，關於websocket協議支持目前不考慮
  5. 簡而言之，本項目是一個消息處理的中間件，微信消息監聽獲取是從框架獲取
  6. 本項目僅供學習交流使用，不得用於商業用途，否則後果自負
  7. 使用本項目造成封禁賬號等後果，本項目不承擔任何責任，實際上您使用任何非官方的微信機器人都有可能造成賬號封禁，所以請謹慎使用
  8. 如果您閱讀了上面的內容，覺得沒有問題，那麼請繼續閱讀下面的內容

功能示例：

img

已對接框架

? 已接入框架，展開看?
  • Dean DLL | 對接說明文檔?
    • 具體配置查看config.yaml文件註釋說明
    • img
  • VLW框架
    • 具體配置查看config.yaml文件註釋說明
    • img

已對接API

? 已對接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: User, error
	GetObjectInfo ( wxId string ) ( * User , error )

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

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

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

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

已有插件

? 已有插件?
  • 百度百科-點擊查看使用說明
    • import _ "github.com/yqchilde/wxbot/plugins/baidubaike"
  • ChatGPT聊天-點擊查看使用說明
    • import _ "github.com/yqchilde/wxbot/plugins/chatgpt"
  • KFC瘋狂星期四騷話-點擊查看使用說明
    • import _ "github.com/yqchilde/wxbot/plugins/crazykfc"
  • 獲取表情原圖-點擊查看使用說明
    • import _ "github.com/yqchilde/wxbot/plugins/memepicture"
  • 摸魚辦-點擊查看使用說明
    • import _ "github.com/yqchilde/wxbot/plugins/moyuban"
  • 查拼音縮寫-點擊查看使用說明
    • import _ "github.com/yqchilde/wxbot/plugins/pinyinsuoxie"
  • 獲取美女圖片-點擊查看使用說明
    • import _ "github.com/yqchilde/wxbot/plugins/plmm"
  • 查天氣-點擊查看使用說明
    • import _ "github.com/yqchilde/wxbot/plugins/weather"
  • 獲取每日早報-點擊查看使用說明
    • import _ "github.com/yqchilde/wxbot/plugins/zaobao"
  • 管理相關-點擊查看使用說明
    • import _ "github.com/yqchilde/wxbot/plugins/manager"
  • 公眾號監控轉發-點擊查看使用說明
    • import _ "github.com/yqchilde/wxbot/plugins/ghmonitor"
  • 聊天熱詞云-點擊查看使用說明
    • import _ "github.com/yqchilde/wxbot/plugins/wordcloud"
  • 查ID-點擊查看使用說明
    • import _ "github.com/yqchilde/wxbot/plugins/chaid"
  • 有道翻譯-點擊查看使用說明
    • import _ "github.com/yqchilde/wxbot/plugins/youdaofanyi"
  • 自動通過好友添加請求-點擊查看使用說明
    • import _ "github.com/yqchilde/wxbot/plugins/friendadd"
  • 選擇困難症幫手-點擊查看使用說明
    • import _ "github.com/yqchilde/wxbot/plugins/choose"
  • 讀取本地圖片-點擊查看使用說明
    • import _ "github.com/yqchilde/wxbot/plugins/localimage"
  • 爬取圖片到本地-點擊查看使用說明
    • import _ "github.com/yqchilde/wxbot/plugins/localimagespider"

指令大全

點擊查看機器人有哪些指令

How to use?

本地運行

  1. 克隆代碼
git clone https://github.com/yqchilde/wxbot.git

  1. 配置config.yaml

  2. 調試運行或編譯

    • 調試運行執行go run main.go
    • 編譯執行make release

Releases包

  1. 去Releases下載對應系統的編譯包，解壓後執行二進製文件即可

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

Actions編譯

  1. 先fork本項目
  2. 在https://github.com/settings/tokens 這裡獲取一個token用於給actions使用
  3. 給項目添加一個秘鑰，名字為WXBOT_TOKEN ，值為上面獲取的token
  4. 自行創建一個tag，如v1.0.0 ，然後等待actions編譯完成，編譯完成後會在release中生成對應的wxbot文件

How to develop?

製作插件或接入其他框架

?如果您想要擴展自己的插件，可以參考plugins目錄下的插件

?如果您想要擴展其他框架，可以參考frameworks目錄下的框架

?如果您需要增減插件，可編輯plugins.yaml 中代碼中去掉對應插件的導入或者添加對應插件的導入，照貓畫虎即可

?修改完plugins.yaml後需要執行一次make plugins或go generate -tags plugins ./engine/plugins生成對應的plugins.go文件再去編譯

- " 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/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 "       # 每日早报
- " github.com/yqchilde/wxbot/plugins/wordcloud "    # 聊天热词
- " github.com/yqchilde/wxbot/plugins/chaid "        # 查wxId
- " github.com/yqchilde/wxbot/plugins/youdaofanyi "  # 有道翻译

參考案例

查看更多使用案例

調試-環境變量

環境變量名變量類型說明
DEBUG bool優先級大於其他DEBUG_開頭的變量，開啟後開啟所有DEBUG模式用於調試HTTP請求和調用日誌文件名和行號
DEBUG_LOG bool用於調試調用日誌文件名和行號

提交Pr注意項

  1. import包時順序要規範，先import標準庫，再import第三方庫，最後import自己的庫，例如： 
 import (
	"errors"
	"fmt"
	"strings"
	"sync"
	"time"

	"github.com/PullRequestInc/go-gpt3"

	"github.com/yqchilde/wxbot/engine/control"
	"github.com/yqchilde/wxbot/engine/pkg/log"
	"github.com/yqchilde/wxbot/engine/pkg/sqlite"
	"github.com/yqchilde/wxbot/engine/robot"
)
  1. 若提交的是插件，請在plugins.yaml中添加對應的插件
  2. 若提交的是插件，請在README.md中已有插件部分添加對應的插件
  3. 若提交的是插件，請在plugins/README.md中添加對應的插件
  4. 提交代碼請先make plugins或go generate -tags plugins ./engine/plugins生成對應的plugins.go文件

Feature

開發計劃： 開發計劃如果您感覺這個項目有意思，麻煩幫我點一下star
這個項目待(不)補(完)充(善)很多東西，由於工作關係會抽出時間弄，感謝您發現並使用此倉庫

如果您有疑惑可以加Q群討論

打個廣告

  • ChatGPT成品賬號

Thanks

JetBrains 開源證書支持

yqchilde/wxbot項目一直以來都是在JetBrains 公司旗下的GoLand 集成開發環境中進行開發，基於free JetBrains Open Source license(s)正版免費授權，在此表達我的謝意。

開源項目

  • 非Hook版機器人核心由openwechat SDK實現，在nohook分支，已暫停維護

  • Hook版機器人框架我使用的是《我的框架》已跑路，現在用的是千尋，Dean DLL，為hook分支

  • hook分支大量借鑒了一個十分優秀的項目ZeroBot-Plugin的設計方案??，其中很多基礎代碼來自ZeroBot-Plugin ，在此基礎上擴展了支持wechat的方式，非常感謝，Thanks♪(･ω･)ﾉ

License

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

展開
附加信息
相關應用
爲您推薦
相關資訊 全部