Files

K2cr2O1 7f331970dd docs: 更新文档内容，简化语言并修正格式

- 简化插件开发指南中的描述，移除冗余内容
- 调整部署文档中的Python版本说明
- 优化最佳实践文档的措辞和格式
- 更新性能优化文档，删除不准确的数据
- 重构核心概念文档，使用更简洁的语言
- 修正README中的项目描述和技术栈说明
- 更新快速上手文档，简化安装步骤
- 调整事件流转文档的描述方式
- 简化架构文档内容
- 更新指令处理文档，添加参数注入示例
- 优化单例管理器文档的表述

2026-01-13 04:49:03 +08:00

1.9 KiB

Raw Blame History

快速上手

runit

1. 你需要准备

Python 3.14: 必须是这个版本别问我为什么。。。
Git: 拉取代码
Redis: 装一个
脑子和手: 这个最重要，或者你去问问镀铬酸钾，会给你一对一教学的。。。
OneBot v11 客户端: 机器人本体，推荐用 NapCatQQ

2. 搭起来

a. 克隆代码

找个你喜欢的地方，把代码从 GitHub 上clone下来

git clone [项目仓库地址]
cd [项目目录]

b. 创建虚拟环境

别把你的系统环境搞得乱七八糟

# Windows
python -m venv venv
.\venv\Scripts\activate

# Linux / macOS
python3.14 -m venv venv
source venv/bin/activate

看到命令行前面多了个 (venv)，就说明你进来了。

c. 安装依赖

pip install -r requirements.txt

d. 安装 Playwright 依赖

我们用 Playwright 来截图画画，它需要一个浏览器核心。

playwright install chromium

e. 编译核心 (可选，但强烈建议)

想让你的代码更快？把它的核心代码编译成 C。

python setup_mypyc.py build_ext --inplace

注：Windows 上可能需要装个 Visual Studio Build Tools，Linux 上需要 GCC。编译失败也别慌，跳过就行，JIT 也能保证不错的速度

3. 第一次

a. 修改配置

去根目录找 config.toml。

[napcat_ws]
# 你的 OneBot 地址
# 我们用的是正向连接，也就是 Bot 主动去连 OneBot
uri = "ws://127.0.0.1:3001"  
token = ""          

[redis]
host = "127.0.0.1"
port = 6379
db = 0

把 uri 改成你自己的 OneBot 地址。

b. 启动！

一切就绪

# 推荐开启 JIT 模式启动
python -X jit main.py

如果你看到日志刷出来，最后显示 “连接成功！”，恭喜，你成功了！

现在，试着给你的机器人发个 /help看看会返回什么东西

1.9 KiB Raw Blame History Unescape Escape