This commit is contained in:
雅诺狐
2025-08-26 14:20:32 +08:00
18 changed files with 92 additions and 97 deletions

View File

@@ -1,4 +1,4 @@
# 如何给MaiCore做贡献v1.0
# 如何给MoFox_Bot做贡献v1.0
修改时间2025/4/5
@@ -6,7 +6,7 @@
首先,非常感谢你抽出时间来做贡献!❤️
这份文档是告诉你当你想向MaiMbot-Pro-Max提交代码或者想要以其他形式加入MaiMbot-Pro-Max的开发,或周边插件的开发,你可以怎么做。
这份文档是告诉你当你想向MoFox_Bot提交代码或者想要以其他形式加入MoFox_Bot的开发,或周边插件的开发,你可以怎么做。
我们鼓励并重视任何形式的贡献,但无序的贡献只会使麦麦的维护与更新变成一团糟。因此,我们建议您在做出贡献之前,先查看本指南。
@@ -39,8 +39,8 @@
## 我想做贡献
> ### 项目所有权与维护
> MaiMbot-Pro-Max项目基于MaiBot修改核心为MaiCore由雅诺狐创建采用GPL3开源协议。
> MaiMbot-Pro-Max项目现已移动至MaiMbot-Pro-Max组织下目前主要内容由核心开发组维护整体由核心开发组、reviewer和所有贡献者共同维护该部分在未来将会明确
> MoFox_Bot项目基于MaiBot修改核心为MaiCore由雅诺狐创建采用GPL3开源协议。
> MoFox_Bot项目现已移动至MoFox_Bot组织下目前主要内容由核心开发组维护整体由核心开发组、reviewer和所有贡献者共同维护该部分在未来将会明确
> 为了保证设计的统一和节省不必要的精力,以及为了对项目有整体的把控,我们对不同类型的贡献采取不同的审核策略:
>
> #### 功能新增
@@ -66,7 +66,7 @@
## 提出建议
这一部分指导您如何为MaiMbot-Pro-Max提交一个建议,包括全新的功能和对现有功能的小改进。遵循这些指南将有助于维护人员和社区了解您的建议并找到相关的建议。
这一部分指导您如何为MoFox_Bot提交一个建议,包括全新的功能和对现有功能的小改进。遵循这些指南将有助于维护人员和社区了解您的建议并找到相关的建议。
在提交建议之前
@@ -83,6 +83,6 @@
### 附(暂定):
核心组成员:@foxcyber907(雅诺狐) @Furina-1013-create(Navinatte)@tt-P607(言柒)@ikun-11451(ikun两年半@minecraft1024a(一闪)
reviewer核心组+MaiMbot-Pro-Max主仓库合作者/权限者
reviewer核心组+MoFox_Bot主仓库合作者/权限者
贡献者:所有提交过贡献的用户

View File

@@ -2,7 +2,7 @@
## 概述
MaiMbot-Pro-Max的权限系统提供了完整的权限管理功能,支持权限等级和权限节点配置。系统包含以下核心概念:
MoFox_Bot的权限系统提供了完整的权限管理功能,支持权限等级和权限节点配置。系统包含以下核心概念:
- **Master用户**:拥有最高权限,无视所有权限节点,在配置文件中设置
- **权限节点**:细粒度的权限控制单元,由插件自行创建和管理

View File

@@ -1,4 +1,4 @@
# 麦麦记忆系统架构 v3.0 设计文档
# MoFox_Bot记忆系统架构 v3.0 设计文档
*融合 Mem0 先进理念的生产级记忆系统*
## 🎯 1. 核心思想

View File

@@ -1,6 +1,6 @@
# 模型配置指南
本文档将指导您如何配置 `model_config.toml` 文件,该文件用于配置 MaiBot 的各种AI模型和API服务提供商。
本文档将指导您如何配置 `model_config.toml` 文件,该文件用于配置 MoFox_Bot 的各种AI模型和API服务提供商。
## 配置文件结构

View File

@@ -2,13 +2,13 @@
## 📖 什么是Action
Action是给麦麦在回复之外提供额外功能的智能组件,**由麦麦的决策系统自主选择是否使用**具有随机性和拟人化的调用特点。Action不是直接响应用户命令而是让麦麦根据聊天情境智能地选择合适的动作,使其行为更加自然和真实。
Action是给MoFox_Bot在回复之外提供额外功能的智能组件,**由MoFox_Bot的决策系统自主选择是否使用**具有随机性和拟人化的调用特点。Action不是直接响应用户命令而是让MoFox_Bot根据聊天情境智能地选择合适的动作,使其行为更加自然和真实。
### Action的特点
- 🧠 **智能激活**麦麦根据多种条件智能判断是否使用
- 🧠 **智能激活**MoFox_Bot根据多种条件智能判断是否使用
- 🎲 **可随机性**:可以使用随机数激活,增加行为的不可预测性,更接近真人交流
- 🤖 **拟人化**:让麦麦的回应更自然、更有个性
- 🤖 **拟人化**:让MoFox_Bot的回应更自然、更有个性
- 🔄 **情境感知**:基于聊天上下文做出合适的反应
---

View File

@@ -1,6 +1,6 @@
# MaiBot插件开发文档
# MoFox_Bot插件开发文档
> 欢迎来到MaiBot插件系统开发文档这里是你开始插件开发旅程的最佳起点。
> 欢迎来到MoFox_Bot插件系统开发文档这里是你开始插件开发旅程的最佳起点。
## 新手入门

View File

@@ -2,7 +2,7 @@
## 概述
MaiBot插件系统现在强制要求每个插件都必须包含一个 `_manifest.json` 文件。这个文件描述了插件的基本信息、依赖关系、组件等重要元数据。
MoFox_Bot插件系统现在强制要求每个插件都必须包含一个 `_manifest.json` 文件。这个文件描述了插件的基本信息、依赖关系、组件等重要元数据。
### 🔄 配置架构Manifest与Config的职责分离

View File

@@ -1,10 +1,10 @@
# 🚀 快速开始指南
本指南将带你从零开始创建一个功能完整的MaiCore插件。
本指南将带你从零开始创建一个功能完整的MoFox_Bot插件。
## 📖 概述
这个指南将带你快速创建你的第一个MaiCore插件。我们将创建一个简单的问候插件,展示插件系统的基本概念。
这个指南将带你快速创建你的第一个MoFox_Bot插件。我们将创建一个简单的问候插件,展示插件系统的基本概念。
以下代码都在我们的`plugins/hello_world_plugin/`目录下。
@@ -18,7 +18,7 @@
确保你已经:
1. 克隆了MaiCore项目
1. 克隆了MoFox_Bot项目
2. 安装了Python依赖
3. 了解基本的Python语法
@@ -58,7 +58,7 @@ from src.plugin_system import BasePlugin, register_plugin, ComponentInfo
@register_plugin # 注册插件
class HelloWorldPlugin(BasePlugin):
"""Hello World插件 - 你的第一个MaiCore插件"""
"""Hello World插件 - 你的第一个MoFox_Bot插件"""
# 以下是插件基本信息和方法(必须填写)
plugin_name = "hello_world_plugin"
@@ -73,7 +73,7 @@ class HelloWorldPlugin(BasePlugin):
return []
```
🎉 恭喜你刚刚创建了一个最简单但完整的MaiCore插件!
🎉 恭喜你刚刚创建了一个最简单但完整的MoFox_Bot插件!
**解释一下这些代码:**
@@ -84,9 +84,9 @@ class HelloWorldPlugin(BasePlugin):
### 4. 测试基础插件
现在就可以测试这个插件了启动MaiCore
现在就可以测试这个插件了启动MoFox_Bot
直接通过启动器运行MaiCore或者 `python bot.py`
直接通过启动器运行MoFox_Bot或者 `python bot.py`
在日志中你应该能看到插件被加载的信息。虽然插件还没有任何功能,但它已经成功运行了!
@@ -96,9 +96,9 @@ class HelloWorldPlugin(BasePlugin):
现在我们要给插件加入一个有用的功能我们从最好玩的Action做起
Action是一类可以让MaiCore根据自身意愿选择使用的“动作”在MaiCore不论是“回复”还是“不回复”或者“发送表情”以及“禁言”等等都是通过Action实现的。
Action是一类可以让MoFox_Bot根据自身意愿选择使用的“动作”在MoFox_Bot不论是“回复”还是“不回复”或者“发送表情”以及“禁言”等等都是通过Action实现的。
你可以通过编写动作来拓展MaiCore的能力,包括发送语音,截图,甚至操作文件,编写代码......
你可以通过编写动作来拓展MoFox_Bot的能力,包括发送语音,截图,甚至操作文件,编写代码......
现在让我们给插件添加第一个简单的功能。这个Action可以对用户发送一句问候语。
@@ -138,7 +138,7 @@ class HelloAction(BaseAction):
@register_plugin
class HelloWorldPlugin(BasePlugin):
"""Hello World插件 - 你的第一个MaiCore插件"""
"""Hello World插件 - 你的第一个MoFox_Bot插件"""
# 插件基本信息
plugin_name = "hello_world_plugin"
@@ -160,21 +160,21 @@ class HelloWorldPlugin(BasePlugin):
- `HelloAction` 是我们定义的问候动作类,继承自 `BaseAction`,并实现了核心功能。
-`HelloWorldPlugin` 中,我们通过 `get_plugin_components()` 方法,通过调用`get_action_info()`这个内置方法将 `HelloAction` 注册为插件的一个组件。
- 这样一来当插件被加载时问候动作也会被一并加载并可以在MaiCore中使用。
- `execute()` 函数是Action的核心定义了当Action被MaiCore选择后,具体要做什么
- 这样一来当插件被加载时问候动作也会被一并加载并可以在MoFox_Bot中使用。
- `execute()` 函数是Action的核心定义了当Action被MoFox_Bot选择后,具体要做什么
- `self.send_text()` 是发送文本消息的便捷方法
Action 组件中有关`activation_type``action_parameters``action_require``associated_types` 等的详细说明请参考 [Action组件指南](./action-components.md)。
### 6. 测试问候Action
重启MaiCore,然后在聊天中发送任意消息,比如:
重启MoFox_Bot,然后在聊天中发送任意消息,比如:
```
你好
```
MaiCore可能会选择使用你的问候Action发送回复
MoFox_Bot可能会选择使用你的问候Action发送回复
```
嗨!很开心见到你!😊
@@ -182,7 +182,7 @@ MaiCore可能会选择使用你的问候Action发送回复
![1750332508760](image/quick-start/1750332508760.png)
> **💡 小提示**MaiCore会智能地决定什么时候使用它。如果没有立即看到效果,多试几次不同的消息。
> **💡 小提示**MoFox_Bot会智能地决定什么时候使用它。如果没有立即看到效果,多试几次不同的消息。
🎉 太棒了!你的插件已经有实际功能了!
@@ -222,7 +222,7 @@ class TimeCommand(BaseCommand):
@register_plugin
class HelloWorldPlugin(BasePlugin):
"""Hello World插件 - 你的第一个MaiCore插件"""
"""Hello World插件 - 你的第一个MoFox_Bot插件"""
# 插件基本信息
plugin_name = "hello_world_plugin"
@@ -250,7 +250,7 @@ class HelloWorldPlugin(BasePlugin):
### 8. 测试时间查询Command
重启MaiCore,发送命令:
重启MoFox_Bot,发送命令:
```
/time
@@ -319,7 +319,7 @@ class HelloWorldPlugin(BasePlugin):
```toml
# hello_world_plugin - 自动生成的配置文件
# 我的第一个MaiCore插件,包含问候功能和时间查询等基础示例
# 我的第一个MoFox_Bot插件,包含问候功能和时间查询等基础示例
# 插件基本信息
[plugin]
@@ -417,11 +417,6 @@ class TimeCommand(BaseCommand):
你可以创建一个 `README.md` 文件,描述插件的功能和使用方法。
### 3. 发布到插件市场
如果你想让更多人使用你的插件可以将它发布到MaiCore的插件市场。
这部分请参考 [plugin-repo](https://github.com/Maim-with-u/plugin-repo) 的文档。
---

View File

@@ -2,11 +2,11 @@
## 📖 什么是工具
工具是MaiBot的信息获取能力扩展组件。如果说Action组件功能五花八门可以拓展麦麦能做的事情那么Tool就是在某个过程中拓宽了麦麦能够获得的信息量。
工具是MoFox_Bot的信息获取能力扩展组件。如果说Action组件功能五花八门可以拓展麦麦能做的事情那么Tool就是在某个过程中拓宽了麦麦能够获得的信息量。
### 🎯 工具的特点
- 🔍 **信息获取增强**:扩展麦麦获取外部信息的能力
- 🔍 **信息获取增强**:扩展MoFox_Bot获取外部信息的能力
- 📊 **数据丰富**:帮助麦麦获得更多背景信息和实时数据
- 🔌 **插件式架构**:支持独立开发和注册新工具
-**自动发现**:工具会被系统自动识别和注册
@@ -15,9 +15,9 @@
| 特征 | Action | Command | Tool |
|-----|-------|---------|------|
| **主要用途** | 扩展麦麦行为能力 | 响应用户指令 | 扩展麦麦信息获取 |
| **触发方式** | 麦麦智能决策 | 用户主动触发 | LLM根据需要调用 |
| **目标** | 让麦麦做更多事情 | 提供具体功能 | 让麦麦知道更多信息 |
| **主要用途** | 扩展MoFox_Bot行为能力 | 响应用户指令 | 扩展MoFox_Bot信息获取 |
| **触发方式** | MoFox_Bot智能决策 | 用户主动触发 | LLM根据需要调用 |
| **目标** | 让MoFox_Bot做更多事情 | 提供具体功能 | 让MoFox_Bot知道更多信息 |
| **使用场景** | 增强交互体验 | 功能服务 | 信息查询和分析 |
## 🏗️ Tool组件的基本结构

View File

@@ -2,7 +2,7 @@
## 1. 系统概述与目标
本系统旨在为Bot引入一个动态的、由大型语言模型LLM驱动的“月层计划”机制。其核心目标是取代静态、预设的任务模板转而利用LLM在程序启动时自动生成符合Bot人设的、具有时效性的月度计划。这些计划将被存储、管理并在构建每日日程时被动态抽取和使用从而极大地丰富日程内容的个性和多样性。
本系统旨在为MoFox_Bot引入一个动态的、由大型语言模型LLM驱动的“月层计划”机制。其核心目标是取代静态、预设的任务模板转而利用LLM在程序启动时自动生成符合Bot人设的、具有时效性的月度计划。这些计划将被存储、管理并在构建每日日程时被动态抽取和使用从而极大地丰富日程内容的个性和多样性。
---