An open API service indexing awesome lists of open source software.

https://github.com/clov614/rikka-bot-wechat

onebot12微信机器人框架
https://github.com/clov614/rikka-bot-wechat

go golang http webhook wechat-app wechat-bot wechat-bot-skeleton

Last synced: 17 days ago
JSON representation

onebot12微信机器人框架

Awesome Lists containing this project

README

          

# Rikka-Bot-WeChat

✨一个简易的微信机器人框架,基于GoLang✨

![](https://img.shields.io/github/go-mod/go-version/Clov614/rikka-bot-wechat "语言")
![](https://img.shields.io/github/stars/Clov614/rikka-bot-wechat?style=flat&color=yellow)
[![](https://img.shields.io/github/actions/workflow/status/Clov614/rikka-bot-wechat/golangci-lint.yml?branch=main)](https://github.com/Clov614/rikka-bot-wechat/actions/workflows/golangci-lint.yml "代码分析")
[![](https://github.com/Clov614/rikka-bot-wechat/actions/workflows/release.yml/badge.svg)](https://github.com/Clov614/rikka-bot-wechat/actions/workflows/release.yml "go-releaser")
[![](https://img.shields.io/github/contributors/Clov614/rikka-bot-wechat)](https://github.com/Clov614/rikka-bot-wechat/graphs/contributors "贡献者")
[![](https://img.shields.io/github/license/Clov614/rikka-bot-wechat)](https://github.com/Clov614/rikka-bot-wechat/blob/main/LICENSE "许可协议")
[![](https://img.shields.io/badge/rikka_bot_wechat-deepwiki-blue?link=https%3A%2F%2Fdeepwiki.com%2FClov614%2Frikka-bot-wechat
)](https://deepwiki.com/Clov614/rikka-bot-wechat "DeepWiki")

## [OneBot V12 标准](https://12.onebot.dev/)

- [x] HTTP
- [x] Http WebHook
- [ ] 正向WebSocket
- [ ] 反向WebSocket

## OneBot客户端快速使用

1. 前往 [Release](https://github.com/Clov614/rikka-bot-wechat/releases) 页面下载对应系统版本的可执行文件

2. [查看配置和启动说明](docs/onebot/README.md)

## 功能介绍

1.
- [x] 支持规则校验
2.
- [x] 持久化设置
3.
- [x] 插件化调用对话(普通对话/长对话)
4.
- [x] 权限管理
5.
- [x] cron定时任务
6.
- [x] OneBot 标准客户端

![cmd_run](/docs/img/product.png)
![http_post](/docs/img/product01.png)

## 机器人快速开始

前往 [Release](https://github.com/Clov614/rikka-bot-wechat/releases) 页面下载对应系统版本的可执行文件

~~Linux运行~~

Win运行(不推荐直接点击exe运行、可以将如下内容写进run.bat双击运行或者直接运行如下命令)

```bash
start cmd /K rikka-bot-wechat.exe -bot -autoInject
```

> [!TIP]
> 【后缀说明】 -bot 开启机器人功能 -http 开启http客户端 -autoInject 自动注入(自动唤起微信完成注入) -debug debug模式

> [!IMPORTANT]
> 【重要事项】首次启动客户端会自动生成配置文件以及拉取需要的文件,拉取失败可根据日志信息自行手动下载到对应目录
> 可通过删除原本的配置文件,启动会生成默认配置文件

支持同时开启bot以及http

```bash
start cmd /K rikka-bot-wechat.exe -bot -http -autoInject
```

## 功能模块

1.
- [x] [管理权限](docs/plugin/admin/README.md)
2.
- [x] [链接解析](docs/plugin/bilibili/README.md)
3.
- [ ] 热更新

## 如何开发插件

todo (
暂未完善文档,可以阅读一下 [/rikka/plugins](https://github.com/Clov614/rikka-bot-wechat/tree/main/rikkabot/plugins))

## 开发计划

1.
- [x] refactor: 注入实现(重构机器人的适配器模块)

2.
- [ ] 重构处理器、插件模块,摘出来,优化加载方式(热加载)

3.
- [ ] AI模块支持多模态

4.
- [ ] bug: ai插件的过滤器重构,将文本分离出程序,加载词典时找不到路径问题

5.
- [ ] feat: 自定义消息捕捉器(分流器),暴露一个新的 http 接口,提供给脚本分流使用

6.
- [ ] feat: xml消息的收发
## 相关链接

| 地址 | 简介 |
|-----------------------------------------------------------------------|------------------|
| [eatmoreapple/openwechat](https://github.com/eatmoreapple/openwechat) | golang微信SDK |
| [Clov614/wcf-rpc-sdk](https://github.com/Clov614/wcf-rpc-sdk) | wechatferry微信SDK |