docs: overhaul EULA and README for clarity and user-friendliness
The End User License Agreement (EULA) has been completely rewritten from a formal legal document into a user-friendly Q&A format. This change aims to make the terms of use more accessible and understandable for end-users, clearly outlining their rights and responsibilities. The README.md has been significantly updated to improve structure, readability, and visual appeal. Key changes include: - Restructuring the layout for a more logical flow. - Adding clear, concise tables for system requirements. - Simplifying the quick start and configuration instructions. - Enhancing visual elements with better-formatted badges and centered sections. - Clarifying the project's status as a third-party fork and warning about potential migration issues.
This commit is contained in:
minecraft1024a
committed by
Windpicker-owo
Windpicker-owo
parent
255c7e2efb
commit
c5ea7c0864
166
README.md
166
README.md
@@ -1,38 +1,60 @@
|
||||
<div align="center">
|
||||
|
||||
# 🌟 麦麦Fork！MoFox_Bot
|
||||
# 🌟 MoFox_Bot
|
||||
|
||||
**🚀 基于 MaiCore 的增强版 AI 智能体，提供更完善的功能和更好的使用体验**
|
||||
|
||||
<p>
|
||||
<strong>🚀 基于 MaiCore 的增强版智能体，提供更完善的功能和更好的使用体验</strong>
|
||||
<a href="https://www.python.org/">
|
||||
<img src="https://img.shields.io/badge/Python-3.10+-3776ab?logo=python&logoColor=white&style=for-the-badge" alt="Python">
|
||||
</a>
|
||||
<a href="https://github.com/MoFox-Studio/MoFox_Bot/blob/master/LICENSE">
|
||||
<img src="https://img.shields.io/badge/License-GPLv3-d73a49?logo=gnu&logoColor=white&style=for-the-badge" alt="License">
|
||||
</a>
|
||||
<a href="https://github.com/MoFox-Studio/MoFox_Bot/graphs/contributors">
|
||||
<img src="https://img.shields.io/badge/Contributors-Welcome-brightgreen?logo=github&logoColor=white&style=for-the-badge" alt="Contributors">
|
||||
</a>
|
||||
<a href="https://github.com/MoFox-Studio/MoFox_Bot/stargazers">
|
||||
<img src="https://img.shields.io/github/stars/MoFox-Studio/MoFox_Bot?style=for-the-badge&logo=star&logoColor=white&color=yellow&label=Stars" alt="Stars">
|
||||
</a>
|
||||
<a href="https://github.com/MoFox-Studio/MoFox_Bot/releases">
|
||||
<img src="https://img.shields.io/github/v/release/MoFox-Studio/MoFox_Bot?style=for-the-badge&logo=github&logoColor=white&color=orange" alt="Release">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](https://www.python.org/)
|
||||
[](https://github.com/MoFox-Studio/MoFox_Bot/blob/master/LICENSE)
|
||||
[](https://github.com/MoFox-Studio/MoFox_Bot/graphs/contributors)
|
||||
[](https://github.com/MoFox-Studio/MoFox_Bot/stargazers)
|
||||
[](https://github.com/MoFox-Studio/MoFox_Bot/releases)
|
||||
[](https://github.com/NapNeko/NapCatQQ)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 📖 项目介绍
|
||||
|
||||
**MoFox_Bot** 是基于 MaiCore 的增强版智能体，在保留原版 `0.10.0 snapshot.5` 所有功能的基础上，提供了更完善的功能、更好的稳定性和更丰富的使用体验。
|
||||
**MoFox_Bot** 是一个基于 [MaiCore](https://github.com/MaiM-with-u/MaiBot) `0.10.0 snapshot.5` 版本的增强型 `fork` 项目。
|
||||
我们在保留原版所有功能的基础上，进行了一系列的改进和功能拓展，致力于提供更强的稳定性、更丰富的功能和更流畅的用户体验。
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **请注意！** 这个版本的所有后续更新均为我们的第三方更新，不代表 MaiBot 官方立场
|
||||
> **第三方项目声明**
|
||||
>
|
||||
> 本项目是由 **MoFox Studio** 独立维护的第三方项目，并非 MaiBot 官方版本。
|
||||
> 所有后续更新和维护均由我们团队负责，与 MaiBot 官方无直接关系。
|
||||
|
||||
> [!WARNING]
|
||||
> **迁移提醒！** 从官方版本到 MoFox_Bot 版本迁移暂时存在问题，因为数据库结构有改变
|
||||
> **迁移风险提示**
|
||||
>
|
||||
> 由于我们对数据库结构进行了重构和优化，从 MaiBot 官方版本直接迁移到 MoFox_Bot **可能会遇到数据不兼容的问题**。
|
||||
> 在迁移前，请务必做好数据备份。
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## ✨ 功能特性
|
||||
|
||||
</div>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
@@ -68,114 +90,106 @@
|
||||
</table>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 🔧 系统要求
|
||||
|
||||
在开始使用之前，请确保你的系统满足以下要求：
|
||||
### 💻 基础环境
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
### 💻 基础要求
|
||||
|
||||
| 项目 | 要求 |
|
||||
|------|------|
|
||||
| 🖥️ **操作系统** | Windows 10/11, macOS 10.14+, Linux (Ubuntu 18.04+) |
|
||||
| 🐍 **Python 版本** | Python 3.10 或更高版本 |
|
||||
| 💾 **内存** | 建议 4GB 以上可用内存 |
|
||||
| 💿 **存储空间** | 至少 2GB 可用空间 |
|
||||
|
||||
</td>
|
||||
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
| 项目 | 要求 |
|
||||
| ------------ | ---------------------------------------------------- |
|
||||
| 🖥️ 操作系统 | Windows 10/11, macOS 10.14+, Linux (Ubuntu 18.04+) |
|
||||
| 🐍 Python 版本 | Python 3.10 或更高版本 |
|
||||
| 💾 内存 | 建议 4GB 以上可用内存 |
|
||||
| 💿 存储空间 | 至少 2GB 可用空间 |
|
||||
|
||||
### 🛠️ 依赖服务
|
||||
|
||||
| 服务 | 描述 |
|
||||
|------|------|
|
||||
| 🤖 **QQ协议端** | [NapCat](https://github.com/NapNeko/NapCatQQ) 或其他兼容协议端 |
|
||||
| 🗃️ **数据库** | SQLite (内置) 或 MySQL (可选) |
|
||||
| 🔧 **管理工具** | chat2db (可选) |
|
||||
| 服务 | 描述 |
|
||||
| ------------ | ------------------------------------------ |
|
||||
| 🤖 QQ 协议端 | [NapCatQQ](https://github.com/NapNeko/NapCatQQ) 或其他兼容协议端 |
|
||||
| 🗃️ 数据库 | SQLite (内置) 或 MySQL (可选) |
|
||||
| 🔧 管理工具 | Chat2DB (可选，用于数据库管理) |
|
||||
|
||||
</td>
|
||||
</div>
|
||||
|
||||
</tr>
|
||||
</table>
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 🏁 快速开始
|
||||
|
||||
### 📦 安装部署
|
||||
### 📦 安装与部署
|
||||
|
||||
</div>
|
||||
|
||||
```bash
|
||||
# 克隆项目
|
||||
# 1. 克隆项目到本地
|
||||
git clone https://github.com/MoFox-Studio/MoFox_Bot.git
|
||||
cd MoFox_Bot
|
||||
|
||||
# 安装依赖
|
||||
# 2. 安装依赖
|
||||
pip install -r requirements.txt
|
||||
|
||||
# 配置机器人
|
||||
# 3. 配置机器人
|
||||
# 首先，复制配置文件模板
|
||||
cp config/bot_config.toml.example config/bot_config.toml
|
||||
# 编辑配置文件...
|
||||
# 然后，根据你的需求编辑 config/bot_config.toml 文件
|
||||
|
||||
# 启动机器人
|
||||
# 4. 启动机器人
|
||||
python bot.py
|
||||
```
|
||||
|
||||
### ⚙️ 配置说明
|
||||
<div align="center">
|
||||
|
||||
1. 📝 **编辑配置文件** - 修改 `config/bot_config.toml` 中的基本设置
|
||||
2. 🤖 **配置协议端** - 设置 NapCat 或其他兼容的 QQ 协议端
|
||||
3. 🗃️ **数据库配置** - 选择 SQLite 或 MySQL 作为数据存储
|
||||
4. 🔌 **插件配置** - 在 `config/plugins/` 目录下配置所需插件
|
||||
### ⚙️ 配置要点
|
||||
|
||||
1. 📝 **核心配置**: 修改 `config/bot_config.toml` 中的基础设置，如 LLM API Key 等。
|
||||
2. 🤖 **协议端配置**: 设置 NapCatQQ 或其他兼容的 QQ 协议端，确保通信正常。
|
||||
3. 🗃️ **数据库配置**: 根据需求选择 SQLite 或配置你的 MySQL 服务器。
|
||||
4. 🔌 **插件配置**: 在 `config/plugins/` 目录下按需配置插件。
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 🙏 致谢
|
||||
|
||||
我们衷心感谢以下优秀的开源项目：
|
||||
我们衷心感谢以下优秀的开源项目，没有它们，就没有 MoFox_Bot。
|
||||
|
||||
<div align="center">
|
||||
|
||||
| 项目 | 描述 | 贡献 |
|
||||
|------|------|------|
|
||||
| 🎯 [MaiM-with-u](https://github.com/MaiM-with-u/MaiBot) | 原版 MaiBot 项目 | 提供优秀的基础框架 |
|
||||
| 🐱 [NapCat](https://github.com/NapNeko/NapCatQQ) | 基于 NTQQ 的 Bot 协议端 | 现代化的 QQ 协议实现 |
|
||||
| 🌌 [Maizone](https://github.com/internetsb/Maizone) | 魔改空间插件 | 插件部分功能借鉴 |
|
||||
| 项目 | 描述 | 贡献 |
|
||||
| ------------------------------------------ | -------------------- | ---------------- |
|
||||
| 🎯 [MaiM-with-u/MaiBot](https://github.com/MaiM-with-u/MaiBot) | 原版 MaiBot 项目 | 提供优秀的基础框架 |
|
||||
| 🐱 [NapNeko/NapCatQQ](https://github.com/NapNeko/NapCatQQ) | 基于 NTQQ 的 Bot 协议端 | 现代化的 QQ 协议实现 |
|
||||
| 🌌 [internetsb/Maizone](https://github.com/internetsb/Maizone) | 魔改空间插件 | 插件部分功能借鉴 |
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## ⚠️ 注意事项
|
||||
|
||||
<div align="center">
|
||||
|
||||
> [!CAUTION]
|
||||
> **重要提醒**
|
||||
>
|
||||
> 使用本项目前必须阅读和同意 [📋 用户协议](EULA.md) 和 [🔒 隐私协议](PRIVACY.md)
|
||||
>
|
||||
> 本应用生成内容来自人工智能模型，由 AI 生成，请仔细甄别，请勿用于违反法律的用途
|
||||
>
|
||||
> AI 生成内容不代表本项目团队的观点和立场
|
||||
>
|
||||
> - 使用本项目前，你必须阅读并同意 [**📋 用户协议 (EULA.md)**](EULA.md)。
|
||||
> - 本应用生成的内容来自人工智能大模型，请仔细甄别其准确性，并请勿用于任何违反法律法规的用途。
|
||||
> - AI 生成的所有内容不代表本项目团队的任何观点和立场。
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## 📄 开源协议
|
||||
|
||||
<div align="center">
|
||||
|
||||
**本项目基于 [GPL-3.0](LICENSE) 协议开源**
|
||||
## 📄 开源协议
|
||||
|
||||
本项目基于 **[GPL-3.0](LICENSE)** 协议开源。
|
||||
|
||||
[](LICENSE)
|
||||
|
||||
@@ -192,8 +206,8 @@ Licensed under the GNU General Public License v3.0
|
||||
|
||||
**🌟 如果这个项目对你有帮助，请给我们一个 Star！**
|
||||
|
||||
**💬 有问题或建议？欢迎提 Issue 或 PR！**
|
||||
**💬 有任何问题或建议？欢迎提交 Issue 或 Pull Request！**
|
||||
|
||||
Made with ❤️ by [MoFox Studio](https://github.com/MoFox-Studio)
|
||||
*Made with ❤️ by [MoFox Studio](https://github.com/MoFox-Studio)*
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user