跳到主要内容

安装小真寻(手动 - uv 部署)

版本警告

真寻Bot需要python版本为 >=3.10

下载​

你可以通过以下两种方式之一获取项目代码：

方式一：使用 Git Clone (推荐)​

在终端执行以下命令：

git clone https://github.com/HibiKier/zhenxun_bot.git

克隆完成后进入项目根目录​

cd zhenxun_bot

方式二：直接下载​

从 zhenxun-org / zhenxun_bot clone代码 或 直接下载 压缩包 并解压，随后在终端进入解压后的文件夹。

安装依赖包​

安装 UV 管理工具​

uv 是高性能的 Python 包管理器，用于替代传统的 pip 和 poetry。

pip install uv

安装项目依赖​

在项目根目录下执行以下命令，uv 会自动创建虚拟环境并同步所有依赖：

uv sync

基础配置​

设置超级用户，打开 .env.dev 文件，在SUPERUSERS和qq中添加自己的QQ​

env.dev
SUPERUSERS=["123456789"]

PLATFORM_SUPERUSERS = '
  {
    "qq": ["123456789"],
    "dodo": [],
    "kaiheila": [],
    "discord": []
  }
'

数据库配置​

建议的数据库，嫌麻烦请使用Sqlite

env.dev
# 示例: "postgres://user:password@127.0.0.1:5432/database"

DB_URL = "postgres://用户名:密码@127.0.0.1:端口/数据库名称"

# 如果你是与教程一模一样的命令代码，且数据库也在该服务器上，可以直接复制以下URL
DB_URL = "postgres://postgres:zhenxun_bot@127.0.0.1:5432/zhenxun_bot"

基础插件配置​

文件保存在 data/config.yaml，所有真寻相关插件都在使用该配置文件，按需修改

启动​

使用 uv run 来启动 Bot，它会自动关联当前目录下的虚拟环境：

uv run zx
提示

如果你想要安装包，使用以下命令，以httpx为例子

uv add httpx
uv add httpx==0.27.2

当你的控制台出现以下日志，说明你已经成功了🎉🎉​

08-14 23:18:44 [INFO] zhenxun | CMD[Web UI] API启动成功
08-14 23:18:44 [INFO] uvicorn | Application startup complete.
08-14 23:18:44 [INFO] uvicorn | Uvicorn running on http://127.0.0.1:8080 (Press CTRL+C to quit)
提示

当前版本真寻本体与插件库分离，你可以在以下获取插件或其他相关，或通过与真寻的对话命令安装插件（插件商店）

项目名称主要用途仓库作者备注
插件库插件zhenxun-org原 plugins 文件夹插件
插件索引库插件zhenxun-org扩展插件索引库
一键安装安装soloxiaoye2022第三方
WebUi管理hibikier基于真寻 WebApi 的 webui 实现
安卓 app(WebUi)安装YuS1aN第三方