docs: 更新文档内容,简化语言并修正格式

- 简化插件开发指南中的描述,移除冗余内容
- 调整部署文档中的Python版本说明
- 优化最佳实践文档的措辞和格式
- 更新性能优化文档,删除不准确的数据
- 重构核心概念文档,使用更简洁的语言
- 修正README中的项目描述和技术栈说明
- 更新快速上手文档,简化安装步骤
- 调整事件流转文档的描述方式
- 简化架构文档内容
- 更新指令处理文档,添加参数注入示例
- 优化单例管理器文档的表述
This commit is contained in:
2026-01-13 04:49:03 +08:00
parent 7880f0f928
commit 7f331970dd
11 changed files with 213 additions and 172 deletions

View File

@@ -1,74 +1,69 @@
# 快速上手
这篇文档教你怎么把 NEO Bot 跑起来。如果你连这都搞不定,建议先去补补 Python 基础。
runit
## 1. 环境准备
## 1. 你需要准备
别拿老古董环境来跑新代码,我们用的是最新的技术栈
* **Python 3.14**: 必须是这个版本别问我为什么。。
* **Git**: 拉取代码
* **Redis**: 装一个
* **脑子和手**: 这个最重要,或者你去问问镀铬酸钾,会给你一对一教学的。。。
* **OneBot v11 客户端**: 机器人本体,推荐用 [NapCatQQ](https://github.com/NapNeko/NapCatQQ)
* **Python**: 必须 `3.14` 或更高。
* 推荐开启 JIT (`-X jit`)。
* 别问为什么不用 3.8,问就是慢。
## 2. 搭起来
* **Git**: 拉代码用的,这都要教?
### a. 克隆代码
* **Redis**: 必须装。
* Windows 用户自己想办法 (WSL2 或者 Memurai)。
* Linux/macOS 用户直接包管理器装。
* 没 Redis 跑不起来,别试了。
* **OneBot v11 客户端**: 机器人本体。
* **强烈推荐**: [NapCatQQ](https://github.com/NapNeko/NapCatQQ)
* 别用那些几百年不更新的协议端,出了问题别找我。
## 2. 安装步骤
### 拉代码
找个你喜欢的地方,把代码从 GitHub 上clone下来
```bash
git clone [项目仓库地址]
cd [项目目录]
```
### 搞个虚拟环境
### b. 创建虚拟环境
别把系统环境搞脏了,这是基本礼貌。
别把你的系统环境搞得乱七八糟
```bash
# 创建
# Windows
python -m venv venv
# 激活 (Windows)
.\venv\Scripts\activate
# 激活 (Linux/macOS)
# Linux / macOS
python3.14 -m venv venv
source venv/bin/activate
```
### 装依赖
看到命令行前面多了个 `(venv)`,就说明你进来了。
### c. 安装依赖
```bash
pip install -r requirements.txt
```
### 装浏览器内核
### d. 安装 Playwright 依赖
我们用 Playwright 做渲染,所以得装个 Chromium
我们用 Playwright 来截图画画,它需要一个浏览器核心
```bash
playwright install chromium
```
### 编译核心 (可选,但推荐)
### e. 编译核心 (可选,但强烈建议)
体验极致速度?把核心模块编译成 C 扩展
让你的代码更快?把它的核心代码编译成 C。
```bash
python setup_mypyc.py build_ext --inplace
```
*Windows 上需要 Visual Studio Build ToolsLinux 上需要 GCC。编译失败就跳过,反正 JIT 也够快了。*
*Windows 上可能需要装个 Visual Studio Build ToolsLinux 上需要 GCC。编译失败也别慌跳过就行JIT 也能保证不错的速度*
## 3. 配置
## 3. 第一次
### a. 修改配置
去根目录找 `config.toml`
@@ -84,14 +79,17 @@ host = "127.0.0.1"
port = 6379
db = 0
```
`uri` 改成你自己的 OneBot 地址。
## 4. 启动
### b. 启动
一切就绪,起飞。
一切就绪
```bash
# 开启 JIT 模式启动
# 推荐开启 JIT 模式启动
python -X jit main.py
```
看到 `连接成功!` 就说明跑通了。如果报错,先看日志,别上来就问。
如果你看到日志刷出来,最后显示 “连接成功!”,恭喜,你成功了!
现在,试着给你的机器人发个 `/help`看看会返回什么东西