Awesome
<p align="center"> <a href="https://github.com/A-kirami/matcha"> <br /> <img src="./public/matcha.webp" alt="Matcha Logo" width="200" /> <br /> <picture> <source media="(prefers-color-scheme: dark)" srcset="./public/matcha-text-dark.svg"> <source media="(prefers-color-scheme: light)" srcset="./public/matcha-text-light.svg"> <img src="./public/matcha-text-light.svg" alt="Matcha Text" width="200" /> </picture> </a> <br /> 模拟聊天交互的辅助开发工具 </p> <p align="center"> <a href="https://github.com/A-kirami/matcha/actions/workflows/build.yml" target="__blank" ><img src="https://github.com/A-kirami/matcha/actions/workflows/build.yml/badge.svg?branch=main&event=push" alt="Github Actions" /></a> <a href="https://app.codacy.com/gh/A-kirami/matcha/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade" target="__blank" ><img src="https://app.codacy.com/project/badge/Grade/99e8f33bae854311a67ccf671a015d9a" alt="Codacy" /></a> <br /> <a href="https://github.com/A-kirami/matcha/releases/latest" target="__blank" ><img src="https://img.shields.io/github/v/release/A-kirami/matcha?include_prereleases&&color=70aeff&style=social" alt="Release Version" /></a> <a href="https://github.com/A-kirami/matcha/stargazers" target="__blank" ><img alt="GitHub stars" src="https://img.shields.io/github/stars/A-kirami/matcha?style=social" /></a> <a href="https://github.com/A-kirami/matcha/releases" target="__blank" ><img alt="GitHub downloads" src="https://img.shields.io/github/downloads/A-kirami/matcha/total?style=social" /></a> <br /> <a href="#" target="__blank"> <strong>🌎 演示与预览</strong> </a> | <a href="https://github.com/A-kirami/matcha/releases" target="__blank"> <strong>📦️ 下载安装包</strong> </a> | <a href="https://jq.qq.com/?_wv=1027&k=SBsy6Rrn" target="__blank"> <strong>💬 加入交流群</strong> </a> </p> <p align="center"> <a href="https://github.com/A-kirami/matcha" target="__blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="./docs/preview-dark.webp"> <source media="(prefers-color-scheme: light)" srcset="./docs/preview-light.webp"> <img src="./docs/preview-light.webp" alt="Matcha - Preview" width="100%" /> </picture> </a> </p>Matcha is mock chat.
Matcha 是一个专为 KiramiBot 设计的辅助开发工具,能够与 KiramiBot 进行模拟聊天交互,同时提供一系列的开发辅助功能。
它旨在降低开发者的调试与测试的负担,从而更有效率的专注于功能开发。
尽管它主要为 KiramiBot 设计,但只要是符合 Matcha 支持协议的机器人,都可接入并能够使用大部分基础功能。
KiramiBot 是一个简明轻快的聊天机器人应用,它与 NoneBot2 完全兼容,同时提供了更多的功能与特性,欢迎体验!
✨ 特性
- 小而美,轻巧体积,简约 UI
- 全平台支持(Windows,Mac,Linux)
- 多协议适配支持
- 支持多用户多群组
- 支持多媒体消息(图片、语音、视频)
- 原始事件展示
🚀 快速上手
创建角色
点击侧边栏底部的圆形按钮,打开角色管理面板。
<picture> <source media="(prefers-color-scheme: dark)" srcset="./docs/user-manage-dark.webp"> <source media="(prefers-color-scheme: light)" srcset="./docs/user-manage-light.webp"> <img src="./docs/user-manage-light.webp" alt="user manage" /> </picture>点击“新建角色”,填写角色信息并创建。
<picture> <source media="(prefers-color-scheme: dark)" srcset="./docs/create-user-dark.webp"> <source media="(prefers-color-scheme: light)" srcset="./docs/create-user-light.webp"> <img src="./docs/create-user-light.webp" alt="create user" /> </picture>设置用户与机器人
点击角色列表中的按钮,将角色设置为用户和机器人。
<picture> <source media="(prefers-color-scheme: dark)" srcset="./docs/bot-user-dark.webp"> <source media="(prefers-color-scheme: light)" srcset="./docs/bot-user-light.webp"> <img src="./docs/bot-user-light.webp" alt="bot user" /> </picture>设置连接
点击侧边栏底部的菜单按钮,打开设置页面,在设置页面中,选择“连接”设置,填写连接信息。
<picture> <source media="(prefers-color-scheme: dark)" srcset="./docs/connect-settings-dark.webp"> <source media="(prefers-color-scheme: light)" srcset="./docs/connect-settings-light.webp"> <img src="./docs/connect-settings-light.webp" alt="connect settings" /> </picture>提示连接成功后,即可开始使用。
🔌 协议适配
-
<details>
<summary>OneBot v11 标准</summary>
动作
- 发送私聊消息(send_private_msg)
- 发送群消息(send_group_msg)
- 发送消息(send_msg)
- 撤回消息(delete_msg)
- 获取消息(get_msg)
- 获取合并转发消息(get_forward_msg)
- 群组踢人(set_group_kick)
- 群组单人禁言(set_group_ban)
- 群组匿名用户禁言(set_group_anonymous_ban)
- 群组全员禁言(set_group_whole_ban)
- 群组设置管理员(set_group_admin)
- 群组匿名(set_group_anonymous)
- 设置群名片(set_group_card)
- 设置群名(set_group_name)
- 退出群组(set_group_leave)
- 设置群组专属头衔(set_group_special_title)
- 处理加好友请求(set_friend_add_request)
- 处理加群请求/邀请(set_group_add_request)
- 获取登录号信息(get_login_info)
- 获取陌生人信息(get_stranger_info)
- 获取好友列表(get_friend_list)
- 获取群信息(get_group_info)
- 获取群列表(get_group_list)
- 获取群成员信息(get_group_member_info)
- 获取群成员列表(get_group_member_list)
- 获取群荣誉信息(get_group_honor_info)
- 获取语音(get_record)
- 获取图片(get_image)
- 检查是否可以发送图片(can_send_image)
- 检查是否可以发送语音(can_send_record)
- 获取运行状态(get_status)
- 获取版本信息(get_version_info)
事件
- 私聊消息
- 群消息
- 群文件上传
- 群管理员变动
- 群成员减少
- 群成员增加
- 群禁言
- 好友添加
- 群消息撤回
- 好友消息撤回
- 群内戳一戳
- 群红包运气王
- 群成员荣誉变更
- 加好友请求
- 加群请求/邀请
-
<details>
<summary>OneBot v12 标准</summary>
动作
- 获取支持的动作列表(get_supported_actions)
- 获取运行状态(get_status)
- 获取版本信息(get_version)
- 发送消息(send_message)
- 撤回消息(delete_message)
- 获取机器人自身信息(get_self_info)
- 获取用户信息(get_user_info)
- 获取好友列表(get_friend_list)
- 获取群信息(get_group_info)
- 获取群列表(get_group_list)
- 获取群成员信息(get_group_member_info)
- 获取群成员列表(get_group_member_list)
- 设置群名称(set_group_name)
- 退出群(leave_group)
- 上传文件(upload_file)
- 分片上传文件(upload_file_fragmented)
- 获取文件(get_file)
- 分片获取文件(get_file_fragmented)
事件
- 私聊消息(message.private)
- 好友增加(notice.friend_increase)
- 好友减少(notice.friend_decrease)
- 私聊消息删除(notice.private_message_delete)
- 群消息(message.group)
- 群成员增加(notice.group_member_increase)
- 群成员减少(notice.group_member_decrease)
- 群消息删除(notice.group_message_delete)
📋 路线图
请访问本项目的 Projects
🤝 贡献
请参阅贡献指南
🍻 鸣谢
感谢以下开发者对本项目的贡献
<a href="https://github.com/A-kirami/matcha/graphs/contributors"> <img src="https://contrib.rocks/image?repo=A-kirami/matcha" /> </a>🎊 活动
📄 许可证
Code: AGPL-3.0 - 2023 - Akirami
Logo: CC-BY-NC-ND, Designs by Akirami