MuiceBot

<div align=center> <img width=200 src="https://bot.snowy.moe/logo.png" alt="image"/> <h1 align="center">MuiceBot</h1> <p align="center">Muice-Chatbot's NoneBot2 Implementation</p> </div> <div align=center> <a href="#About"><img src="https://img.shields.io/github/stars/Moemu/MuiceBot" alt="Stars"></a> <a href="https://pypi.org/project/MuiceBot/"><img src="https://img.shields.io/pypi/v/Muicebot" alt="PyPI Version"></a> <a href="https://pypi.org/project/MuiceBot/"><img src="https://img.shields.io/pypi/dm/Muicebot" alt="PyPI Downloads" ></a> <a href="https://nonebot.dev/"><img src="https://img.shields.io/badge/nonebot-2-red" alt="nonebot2"></a> <a href="#"><img src="https://img.shields.io/badge/Code%20Style-Black-121110.svg" alt="codestyle"></a> </div> <div align=center> <a href="#"><img src="https://wakatime.com/badge/user/637d5886-8b47-4b82-9264-3b3b9d6add67/project/a4557f7b-4d26-4105-842a-7a783cbad588.svg" alt="wakatime"></a> <a href="https://www.modelscope.cn/datasets/Moemuu/Muice-Dataset"><img src="https://img.shields.io/badge/ModelScope-Dataset-644cfd?link=https://www.modelscope.cn/datasets/Moemuu/Muice-Dataset" alt="ModelScope"></a> </div> <div align=center> <a href="https://bot.snowy.moe">📃Documentation</a> <a href="https://bot.snowy.moe/guide/setup.html">✨Quick Start</a> <a href="https://github.com/MuikaAI/Muicebot-Plugins-Index">🧩Plugin Store</a> </div> *This project is currently in a slow update state, and no new feature development is planned for now.* # Introduction✨ > We believe that AI creation should be for helping humans solve problems better, not creating problems. Therefore, we focus on the ability of large language models to solve practical problems. If the Muice series project cannot help us solve daily and emotional problems, the existence of Muice would be meaningless. > *———— "Muice Series Model Evaluation Criteria"* Muicebot is a LLM chatbot based on the Nonebot2 framework, aiming to solve real-world problems. With Muicebot, you can experience a web-like chat experience on mainstream chat platforms (e.g., QQ). Muicebot has two built-in chat personas, Muice and Muunika, to optimize the dialogue experience. For more information about Muice and Muunika, please visit [About Muice](https://bot.snowy.moe/about/Muice). # Features🪄 ✅ Multiple model loaders are supported, such as [OpenAI](https://platform.openai.com/docs/overview) and [Ollama](https://ollama.com/), which can load most model services or local models on the market, supporting multimodal (image recognition) and tool calls. ✅ Using `nonebot_plugin_alconna` as a universal information interface, supporting most adapters on the market. Special optimizations are made for some adapters. ✅ Supporting scheduled tasks based on `nonebot_plugin_apscheduler`, which can interact with large language models or send messages at regular intervals. ✅ Supporting several common commands based on `nonebot_plugin_alconna`. ✅ Using `nonebot-plugin-orm>=0.7.7` to save conversation data. ✅ Dynamically generating persona prompts using Jinja2. ✅ Supporting MCP services (stdio, SSE, and Streamable HTTP transport). # Model Loader Compatibility | Model Loader | Streaming Dialogue | Multimodal Input/Output | Inference Model Calling | Tool Calling | Internet Search | | ----------- | -------- | -------------- | ------------ | -------------------- | -------------------- | | `Azure` | ✅ | 🎶🖼️/❌ | ⭕ | ✅ | ❌ | | `Dashscope` | ✅ | 🎶🖼️/❌ | ✅ | ⭕ | ✅ | | `Gemini` | ✅ | ✅/🖼️ | ⭕ | ✅ | ✅ | | `Ollama` | ✅ | 🖼️/❌ | ✅ | ✅ | ❌ | | `Openai` | ✅ | ✅/🎶 | ✅ | ✅ | ❌ | ✅: indicates that the loader supports the feature well and MuiceBot has implemented it. ⭕: indicates that the loader supports the feature but may encounter issues when using it. 🚧: indicates that the loader supports the feature but MuiceBot has not implemented it or is in the process of implementing it. ❓: indicates that the maintainer is unsure whether the loader supports the feature and may need to review the documentation and source code. ❌: indicates that the loader does not support the feature. Multimodal markers: 🎶 for audio; 🎞️ for video; 🖼️ for image; 📄 for file; ✅ for full support. # Who is this project for? - Developers with Python programming experience. - Bot enthusiasts who have set up Nonebot projects. - AI enthusiasts who want to interact with large language models anytime and anywhere and are looking for a robot framework that can be compatible with most SDKs on the market. ~~# TODO📝~~ ~~Roadmap: [MuiceBot Update Plan](https://github.com/users/Moemu/projects/2)~~ # Tutorial💻 Refer to [Documentation](https://bot.snowy.moe). # Plugin Store🧩 [MuikaAI/Muicebot-Plugins-Index](https://github.com/MuikaAI/Muicebot-Plugins-Index) # About🎗️ The output results of large models will be provided **as is**. Due to complex reasons such as prompt injection attacks, the model may output harmful content. Regardless of the output results, the output results do not represent the views and positions of the developers. The developers of this project do not assume any responsibility for any consequences (including but not limited to robot account bans) that may be indirectly caused by this project. This project is provided under the [BSD 3](https://github.com/Moemu/nonebot-plugin-muice/blob/main/LICENSE) license. When redistributing, please keep a copy of the license file. The project logo uses assets or works from [nonebot/nonebot2](https://github.com/nonebot/nonebot2) and artist [Nakkar](https://www.pixiv.net/users/28246124) [Pixiv work](https://www.pixiv.net/artworks/101063891). If there is any infringement, please contact us. The BSD 3 license also applies to Muice's system prompts. Muice's text persona and persona images are provided under the [CC BY NC 3.0](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode) license. This project is based on or references some open-source project implementations, and we would like to express our gratitude here: - [nonebot/nonebot2](https://github.com/nonebot/nonebot2) The robot framework used in this project. - [@botuniverse](https://github.com/botuniverse) The organization responsible for formulating the Onebot standard. Thanks to the assistance of various developers. It's fair to say that without you, there wouldn't be Muice today: <a href="https://github.com/eryajf/Moemu/MuiceBot/contributors"> <img src="https://contrib.rocks/image?repo=Moemu/MuiceBot" alt="Loading..."/> </a> Friendship links: [LiteyukiStudio/nonebot-plugin-marshoai](https://github.com/LiteyukiStudio/nonebot-plugin-marshoai) This project belongs to MuikaAI. Original implementation based on OneBot V11: [Moemu/Muice-Chatbot](https://github.com/Moemu/Muice-Chatbot) <a href="https://www.afdian.com/a/Moemu" target="_blank"><img src="https://pic1.afdiancdn.com/static/img/welcome/button-sponsorme.png" alt="afadian" style="height: 45px !important;width: 163px !important;"></a> <a href="https://www.buymeacoffee.com/Moemu" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 45px !important;width: 163px !important;" ></a> Star History： [](https://star-history.com/#Moemu/MuiceBot&Date)