安装指南

惜月安装指南Markdown大约 8 分钟

前言

如果你只是想体验一下小派蒙的功能，查询自己的原神信息，可以来QQ频道-尘世闲游open in new window，这里提供了一个现成的派蒙供大家在频道中免费使用。

如果你想搭建一个属于自己的小派蒙，可以继续看本教程，教程将通过小派蒙脚手架插件open in new window，以最简时间从0搭建一个小派蒙机器人，通常你只需要跟着本教程复制粘贴即可。

关于Linux各种发行版，这里推荐您使用Ubuntu20+或Debian11+系统，极不推荐使用CentOS或其他不常见发行版系统。

本教程中关于前置环境、安装go-cqhttp等可以参考Well404open in new window的NoneBot2.0.0RC 全平台保姆级新手教学open in new window中的相关视频教程。

小派蒙推荐配置为4G运行内存及以上(2G的话需要关闭某些功能)，大约需要2G存储空间。

如安装过程中遇到问题也可以在QQ频道中提问，点击上方QQ频道或这里open in new window加入。

以下涉及到的命令中，#后面的为注释，不要复制运行。

前置环境

Windows

安装Python

可以打开命令行，运行 python -V ，查看是否已安装，如已有版本为3.8~3.10，就不用再安装

请参考该以下教程之一完成python的安装：

安装完成后，在命令行依次运行以下命令：

pip -V  # 查看指出的python版本是否为刚刚安装的版本
pip install pipx  # 安装pipx
pipx ensurepath  # 把pipx添加到环境变量

安装git

可以打开命令行，运行 git --version ，查看是否已安装，如已安装就不用再安装

请参考以下教程之一完成git的安装：

Ubuntu

请使用20.04或22.04版本，这两个版本已自带派蒙所必需的python版本和git，其余版本请自行升级python到3.8-3.10版本。

依次执行以下命令：

sudo -i  # 获取root权限，如果本来就以root权限登录，那可以跳过
apt update && apt upgrade  # 更新系统
apt install pipx  # 安装pipx
pipx ensurepath  # 把pipx添加到环境变量

安装小派蒙

选择一个你想要存放的目录，打开命令行，依次运行以下命令：

目录路径最好不要有中文，如果使用了中文路径，报错了的话请尝试更换为英文路径

pipx install nb-cli  # 安装nonebot脚手架
nb self install nb-cli-plugin-littlepaimon  # 安装小派蒙脚手架插件
nb paimon create  # 创建小派蒙项目

如果提示找不到nb，刷新或重启一下终端或命令行即可

在运行nb paimon create后，脚手架会一步步指引安装，以下为可能出现的选项：

  • 项目名称：你想要存放的小派蒙文件夹名，默认为LittlePaimon
  • 克隆源：推荐默认，如果下载失败可尝试其他源
  • 超级用户QQ号：相当于机器人的管理员，填写你自己的QQ号
  • 立刻安装依赖：请选择是(Y)，即直接回车
  • 创建虚拟环境：如果您没有其他Python开发需求的话，可以选否(N)，如果有，请选是(Y)
  • go-cqhttp安装和使用方式：该怎么选，详见下方关于go-cqhttp

在创建完成后，继续运行以下命令：

cd LittlePaimon  # LittlePaimon为你刚刚填写的项目目录名
nb paimon res  # 给出的两次选择均保持默认(回车两次)
nb paimon run playwright install chromium --with-deps  # 安装playwright相关依赖

到此，您的小派蒙Bot安装成功！

此后，你只需要在派蒙的目录下使用命令nb paimon run即可启动小派蒙Bot，并根据你选择的go-cqhttp方式，启动并登录机器人账号。

以下为使用脚手架快速安装演示视频：

go-cqhttp

go-cqhttp是一个无头QQ客户端，负责与小派蒙交互，进行消息的收发。

方式一 nonebot-plugin-gocqhttp插件

如果你使用的是本地电脑或有公网IP的的服务器，推荐使用 nonebot-plugin-gocqhttp 插件， 该插件会以子进程调用的方式让go-cqhttp和小派蒙一起运行。

如果选择了该方式，请在启动小派蒙后，在浏览器访问链接http://127.0.0.1:13579/go-cqhttp

如果是云服务器，需开放13579端口，将127.0.0.1换成你的公网ip进行访问

该链接为插件提供的网页控制台，在控制台中添加bot账号，添加完成后需重启小派蒙，然后根据gocq的指引进行账号登录验证。

登录成功后，以后启动就不需要再登录了。

方式二 go-cqhttp本体

如果你的服务器没有公网IP，或插件版使用时出现问题不能解决，可使用 go-cqhttp 本体版。

本体版需要你在启动小派蒙时，额外启动go-cqhttp

  • Windows: 双击go-cqhttp.exe，按指引运行
  • Ubuntu(Linux): 在其目录下使用命令./go-cqhttp运行 首次登录还需要根据gocq的指引进行账号登录验证。

如果你在nb paimon create创建派蒙时已经选择了插件版，想换成本体版，可以进行以下操作：

    1. 编辑小派蒙目录中的pyproject.toml文件， 找到"nonebot_plugin_gocqhttp"，将它和它后面的逗号删除，保存文件。
    1. 找一个合适的目录(例如小派蒙目录的上层)，运行nb paimon create -g，下载和配置go-cqhttp本体

方式三 已有现成的go-cqhttp

那你只需要在go-cqhttp的配置文件config.yml中的连接服务列表处添加派蒙的ws链接地址即可。

  - ws-reverse:
      # 反向WS Universal 地址
      universal: ws://127.0.0.1:13579/onebot/v11/ws
      # 重连间隔 单位毫秒
      reconnect-interval: 3000
      middlewares:
        <<: *default # 引用默认中间件

在servers:下方添加上述代码，注意缩进!，例如下面这个例子：

account: # 账号相关
  uin: 1233456 # QQ账号
  password: '' # 密码为空时使用扫码登录
......
# 连接服务列表
servers:
  - ws-reverse:
      # 反向WS Universal 地址
      universal: ws://127.0.0.1:13579/onebot/v11/ws
      # 重连间隔 单位毫秒
      reconnect-interval: 3000
      middlewares:
        <<: *default # 引用默认中间件






 
 
 
 
 
 
 

账号登录不上的解决方法

如果在云服务器上登录qq时有类似有风险，请使用同一网络、验证失败、账号被冻结或密码错误等提示而登录不上， 可以先在你的本地电脑下载go-cqhttp，登录同一账号，登录成功后，将device.json和session.token这两个文件上传到云服务器，替换掉云服务器上的同名文件，再次启动bot即可。

如果是gocq本体，那就是替换gocq所在目录的这两个文件。

如果是gocq插件，那就是替换小派蒙目录/accounts/你的qq号/下的这两个文件。

后台运行

Windows

需要保持命令行窗口一直运行，不能关闭(如果使用的是go-cqhttp本体，那它窗口也不能关闭)

Ubuntu

推荐使用tmux命令来管理后台运行。

如果系统没有自带tmux，可以使用命令 apt install tmux 来安装

在小派蒙所在目录，使用tmux来后台运行小派蒙：

tmux new -s paimon nb paimon run

运行后，会新开一个终端窗口来运行派蒙，按 Ctrl+B D 即可让它退到后台。

使用以下命令即可让它重新回到前台：

tmux a -t paimon

go-cqhttp本体版同理：

tmux new -s gocq ./go-cqhttp  # 运行
tmux a -t gocq  # 调回前台

关于tmux的详细使用方法请参考Tmux使用手册open in new window。

此外，你还可以使用screenopen in new window、nohupopen in new window、pm2open in new window、supervisoropen in new window等命令或工具来实现后台运行，请自行查阅相关用法。

通过 TRSS 脚本安装

如果你不熟悉命令行操作，也可以使用交互式脚本安装管理小派蒙（在 TRSS Liteyuki 里）：

详细使用方法请参考其文档。

Poetry旧版安装教程

以下为之前使用Poetry来安装的旧版教程，供老用户参考：

安装NoneBot商店的插件

指路

点击此处前往NoneBot插件商店open in new window

在商店处复制你想要安装的插件的安装命令(大多是nb plugin install 插件名)， 在小派蒙的目录运行命令即可安装。

支持绝大部分NoneBot插件，不过可能部分插件的指令有冲突，可以使用nb plugin uninstall 插件名命令来卸载插件。

使用Poetry

如果你是使用Poetry部署的用户，你需要在命令前添加poetry run，即：

  • poetry run nb plugin install 插件名
  • poetry run nb plugin uninstall 插件名