deploy bbot

部署 BBot

在部署之前，您需要知道以下三点：

• 本项目仅在 Ubuntu20.04LTS 及 Windows10 平台上进行测试，如果在使用其他平台时出现兼容性问题，请自行更换平台或为项目提交贡献进行适配。
• 仅凭 BBot 是无法完成消息推送的，BBot 需要对应平台的无头客户端或API才可正常工作！详情请参考 部署Mirai) 进行配置。
• 如果你是使用 Linux 平台进行部署的，请务必使用阅读 使用之前 - screen，并使用 screen 进行部署(或其他你喜欢的方式)，又或者可以使用 Docker 部署。

使用二进制包部署

目前，BBot 共发布了针对以下平台的二进制包版：

• Windows10 及以上
• Ubuntu20.04LTS

如果您使用的平台包含在上述平台，并且对源代码没有修改的需求，那么我们强烈建议使用二进制包版。

在发布页面中挑选您需求的发布版进行下载。通常来说，您可以选择最新的稳定版进行下载。

Windows

1. 双击 bbot-windows-<版本号>.exe，根据提示生成运行脚本。
2. 双击运行脚本。

Linux

在 Linux 中，您需要先授予二进制包可执行权限(+x)后才可运行。

# 请务必将文件名替换为您下载后的文件名，不要直接复制粘贴
chmod +x bbot-ubuntu-<版本号>
./bbot-ubuntu-<版本号>

使用源码部署

使用源码部署需要您拥有一定的计算机知识和理解能力，请优先使用二进制包进行部署。

若在部署过程中出现问题，请首先尝试二进制包版进行验证。若二进制包可以正常工作，那么大概率是您的部署流程上出现了问题。若二进制包无法正常工作，那么大概率是部署平台出现了问题，请考虑重装系统或修复平台。

安装python

警告 该项目需求 Python >= 3.9 ，请确保您所使用的平台兼容该版本的 python。

Windows 用户可前往 python官方网站 下载对应平台的的安装包，并进行安装 （注意添加至环境变量）。

Linux 用户可直接通过对应平台的包管理工具进行安装：

sudo apt-get update
sudo apt-get upgrade
sudo apt install python3.9

获取源码

使用git获取（推荐）

我们推荐使用 git 来获取源码，这将很大程度上便于项目的更新以及后续维护。

Windows 用户可前往 git官方网站 下载 git 并安装（注意添加至环境变量）。

Linux 用户可使用对应平台的包管理工具进行安装，可参考 git官方网站，例如 sudo apt-get install git。

在 git 安装完成后，使用 git clone https://github.com/djkcyl/BBot-Graia.git 下载项目。

使用其他方式获取

我们可以使用其他方式来获取源码，例如下载压缩包等，在此不进行讨论。

安装依赖

使用poetry(推荐)

本项目推荐使用 poetry 虚拟环境对项目的环境进行管理。

首先，请参考 poetry官方文档 安装 poetry。

如果您在使用官方的安装脚本失败的情况下，可尝试由我们提供的换源+汉化版本，但我们无法保证您的安装不会因此出现问题，请谨慎使用。 curl -sSL https://a60.oss.aunly.cn/poetry/install-poetry-proxy.py | python3 -

在项目的根目录中，使用 poetry install 进行虚拟环境的创建及依赖的获取。

提示 我们可以在虚拟环境创建前使用 poetry config virtualenvs.in-project true 命令将虚拟环境创建至项目根目录。

取决于您的网络或其他因素，该过程可能会消耗较长时间，请耐心等待。

使用pip

如果您希望使用 pip 来安装项目依赖，我们也提供了 requirements.txt，但通常情况下我们依旧建议使用 poetry 进行环境管理。

在使用 pip 安装依赖之前，请考虑使用 conda 或 venv 等虚拟环境，并在虚拟环境中运行此项目。若直接安装，可能会与其他项目的依赖产生冲突，导致程序无法运行等严重错误。

同时，如果您的环境中存在多个 python 解释器，请务必确保使用的解释器是正确的版本。

在项目的根目录中，使用 pip install -r requirements.txt 进行依赖的安装。

若您使用 pip 安装依赖后项目无法正常启动，请考虑使用 poetry 重新安装。

运行程序

在安装完毕依赖后，取决于您的安装方式，在项目的根目录中使用 poetry run python main.py 或 python main.py 来初次启动程序。

初次运行

无论您采用了哪种方式运行了 BBot，在初次运行(无配置文件)的情况下均会出现如下内容:

<此处是一段日期> | ERROR    | core.bot_config:<module>:167 - 未找到配置文
件，已为您创建默认配置文件（data\bot_config.yaml），请修改后重新启动

在项目的根目录的 data 文件夹中，会出现 bot_config.yaml 文件，请根据 填写配置文件 中的提示完成配置文件的填写后再次启动 BBot 即可正常运行。

若在使用中出现了异常问题，可先尝试根据 常见问题 和 使用之前 中的内容进行排查与修复，然后再尝试 寻求帮助。