MuiceBot

<div align=center> <img width=200 src="https://bot.snowy.moe/logo.png" alt="image"/> <h1 align="center">MuiceBot</h1> <p align="center">NoneBot2 implementation of Muice-Chatbot</p> </div> <div align=center> <a href="#关于️"><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, focusing only on bug fixes and accepting external PRs, with no plans for other functional development at this time.* # Introduction✨ > We believe that the creation of AI should be aimed at helping humans solve problems better rather than creating new problems. Therefore, we focus on the ability of large language models to address real-world issues. If the Muice series projects cannot help us solve everyday and emotional problems, then the existence of Muice is meaningless. > *———— "Muice Series Model Evaluation Standards"* Muicebot is an LLM (Large Language Model) chatbot implemented based on the Nonebot2 framework, designed to solve real-world problems. With Muicebot, you can enjoy a chat experience on mainstream messaging platforms (such as QQ) that is typically only available on web pages. Muicebot features two built-in chat personas named 沐雪 (Muice) and 沐妮卡 (Munica) to optimize the conversation experience. For more information about the settings of 沐雪 and 沐妮卡, please visit [About Muice](https://bot.snowy.moe/about/Muice). # Features 🪄 ✅ Embedded with various model loaders, such as [OpenAI](https://platform.openai.com/docs/overview) and [Ollama](https://ollama.com/), capable of loading most model services or local models available on the market, supporting multimodal (image recognition) and tool invocation. Additionally, it comes with a special Mu Xue Roleplay fine-tuning model that only calculates 3.9 > 3.11~ ✅ Uses `nonebot_plugin_alconna` as a universal information interface, supporting most adapters available on the market. Special optimizations have been made for certain adapters. ✅ Supports scheduled tasks based on `nonebot_plugin_apscheduler`, allowing for timed interactions with large language models or direct message sending. ✅ Supports several common commands based on `nonebot_plugin_alconna`. ✅ Provides an ORM layer for saving conversation data based on `nonebot-plugin-orm>=0.7.7`. Some may ask: Maintainer, Maintainer, can we implement long-term and short-term memory, LangChain, FairSeq memory optimizations? ~~It will be available in the future (~~ ✅ Uses Jinja2 to dynamically generate character prompt words. ✅ Supports calling MCP services (supports stdio, SSE, and Streamable HTTP transmission methods). # Model Loader Compatibility | Model Loader | Streaming Dialogue | Multimodal Input/Output | Inference Model Invocation | Tool Invocation | Online Search | | -------------- | ------------------ | ----------------------- | -------------------------- | ---------------- | -------------- | | `Azure` | ✅ | 🎶🖼️/❌ | ⭕ | ✅ | ❌ | | `Dashscope` | ✅ | 🎶🖼️/❌ | ✅ | ⭕ | ✅ | | `Gemini` | ✅ | ✅/🖼️ | ⭕ | ✅ | ✅ | | `Ollama` | ✅ | 🖼️/❌ | ✅ | ✅ | ❌ | | `Openai` | ✅ | ✅/🎶 | ✅ | ✅ | ❌ | ✅: Indicates that this loader supports the feature well and `MuiceBot` has implemented it. ⭕: Indicates that this loader supports the feature, but there may be issues when using it. 🚧: Indicates that this loader supports the feature, but `MuiceBot` has not implemented it or is in the process of implementation. ❓: Indicates that the Maintainer is unsure whether this loader supports the feature and may need to review documentation and check the source code further. ❌: Indicates that this loader does not support the feature. Multimodal Markers: 🎶 indicates audio; 🎞️ indicates video; 🖼️ indicates image; 📄 indicates file; ✅ indicates full support. # Who is this project suitable for? - Developers who have experience writing Python programs - 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 bot framework that is compatible with most SDKs on the market ~~# TODO📝~~ ~~Recent update roadmap: [MuiceBot Update Plan](https://github.com/users/Moemu/projects/2)~~ # User Guide 💻 Refer to the [Usage Documentation](https://bot.snowy.moe) # Plugin Store 🧩 [MuikaAI/Muicebot-Plugins-Index](https://github.com/MuikaAI/Muicebot-Plugins-Index) # About 🎗️ The output results of the large model will be provided **as is**. Due to complex reasons such as prompt injection attacks, the model may output harmful content. Regardless of the model's output, the results do not represent the views or positions of the developers. All developers of this project bear no responsibility for any consequences that may arise indirectly from this project (including but not limited to the banning of bot accounts). This project is provided under the [BSD 3](https://github.com/Moemu/nonebot-plugin-muice/blob/main/LICENSE) license, and a copy of the license file must be retained when redistributing. 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 works](https://www.pixiv.net/artworks/101063891). If there is any infringement, please contact us promptly. The BSD 3 license also applies to Mu Xue's system prompts, and Mu Xue's character text or character images are provided under the [CC BY NC 3.0](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.zh-hans) license terms. This project is based on or references implementations from several open-source projects, and we would like to express our gratitude here: - [nonebot/nonebot2](https://github.com/nonebot/nonebot2) The bot framework used in this project - [@botuniverse](https://github.com/botuniverse) The organization responsible for formulating the Onebot standard Thanks to all the developers for their assistance; it can be said that without you, there would be no Mu Xue today: <a href="https://github.com/eryajf/Moemu/MuiceBot/contributors"> <img src="https://contrib.rocks/image?repo=Moemu/MuiceBot" alt="Image loading..."/> </a> Related 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)