Adachi-BOT

说明

关于

本项目提供了一个在 QQ 中运行的原神助手，与之聊天可以方便地查询玩家数据和游戏信息、模拟抽卡、模拟刷圣遗物，以及一些其他的功能。原项目的该版本已经不再维护，此项目当前会持续更新。

本项目仅供学习交流技术使用，严禁用于任何商业用途和非法行为！

文档

1. 常见问题请参阅 FAQ 。
2. 制作资源文件请查阅《资源文件制作指引》。
3. 开发插件请查阅《插件开发指引》。

开发

运行命令 npm run install-dev 以安装开发者模块。

1. 代码提交前运行 npm run code-check 进行检查确保无报错，并运行 npm run code-format 进行格式化。
2. 代码自测完毕后发起 Pull request 合入 dev 分支。
3. 新功能添加或者功能修改请先发起 Issue 询问我的意愿，根据沟通结果选择合入本项目或者提交到你账户下的一个 Fork 。漏洞修复无需事先沟通，直接发起 Pull request 并描述清楚问题即可。

请不要在你的 Fork 中开启下面的 workflow ！它们对你没有任何帮助。

1. Update JavaScript modules in dev branch
2. Update Node.js modules in dev branch
3. Update material.json in dev branch

使用

部署

本项目原则上只做 Linux 系统的支持，所有代码合入主线之前也只在 Linux 上进行测试，推荐使用一个主流的发行版（例如 CentOS ）进行部署。如果你执意要在 Windows 系统上进行部署，请参照我在 FAQ 中写的《如何在 Windows 系统上进行部署》，注意虽然这份说明是出自我之手，但是不表示我推荐在 Windows 系统上部署本项目。

准备环境

首先你需要有一份较新的 Node.js ，本项目不兼容较旧版本的 Node.js 。

echo 'export N_NODE_MIRROR="https://mirrors.ustc.edu.cn/node/"' | tee -a ~/.bashrc
echo 'export N_NODE_DOWNLOAD_MIRROR="https://mirrors.ustc.edu.cn/node/"' | tee -a ~/.bashrc
source ~/.bashrc

curl -fsSL https://raw.githubusercontent.com/tj/n/master/bin/n | sudo -E bash -s lts
sudo --preserve-env=PATH env npm install -g n
sudo --preserve-env=PATH env n lts

1. 建议提供一个内存和交换空间容量总和达到 1.5 GiB 的 Linux 环境进行部署，以运行无头浏览器。
2. 不要遗漏 tee 命令的 -a 选项，否则你的 ~/.bashrc 将被破坏。

克隆项目

git clone --depth 1 https://github.com/Arondight/Adachi-BOT.git

安装依赖模块

你需要使用 npm 命令安装所需的依赖模块，但是因为 Puppeteer 在安装过程中具有特殊性，所以整个安装过程有了两种思路，进入本项目所在的目录 ./Adachi-BOT/ 后，你可以在下面的安装方法中任选其一。

其一，（推荐）使用系统自带的 Chromium

你要做的是。

1. 用包管理器安装 Chromium ，然后找到它的二进制 ELF 文件路径。
2. 配置环境变量 PUPPETEER_EXECUTABLE_PATH 为这个路径，然后配置环境变量 PUPPETEER_SKIP_CHROMIUM_DOWNLOAD 为 true 。

这样 Puppeteer 就可以使用系统自带的 Chromium 了。这里以 CentOS 为例，上面两个步骤可以用转化为以下 Bash 命令。

sudo yum -y install epel-release
sudo yum -y install chromium

cp -v ~/.bashrc{,-backup}

echo 'export PUPPETEER_EXECUTABLE_PATH="/usr/lib64/chromium-browser/chromium-browser"' | tee -a ~/.bashrc
echo 'export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD="true"' | tee -a ~/.bashrc
source ~/.bashrc

npm run install-prod

1. 其中 /usr/lib64/chromium-browser/chromium-browser 是你的 Chromium 浏览器 ELF 文件路径，而非启动脚本或其链接的路径，具体请参照 FAQ 中的《Linux 下如何找到 Chromium 的二进制 ELF 文件路径》。
2. 不要遗漏 tee 命令的 -a 选项，否则你的 ~/.bashrc 将被破坏。

其二，让 npm 为你安装一个 Chromium

这需要你的系统有访问国际互联网的能力，如果可以访问，直接执行以下命令。

npm run install-prod

如果无法访问，那么你需要通过任意合法途径获得一个可以访问国际互联网的 http 代理，然后执行以下命令。

npm_config_proxy=http://<代理地址>:<代理端口> npm run install-prod

注意使用此方法安装 Chromium ，你需要自行解决它的运行依赖问题（例如缺少动态库）。

配置

首次配置，进入本项目所在的目录 ./Adachi-BOT/ ，执行以下命令从 ./config_defaults/ 下复制默认配置文件 setting.yml 和 cookies.yml 到 ./config/ 中。

cp -iv ./config_defaults/{setting,cookies}.yml ./config/

然后需要编辑以下文件，根据注释填入合适的配置。

1. 你也可以从 ./config_defaults/ 下复制更多的文件到 ./config/ 来进行自定义配置。但是有些配置文件如果你不想自己维护，那就不要把它们放到 ./config/ 下。请详细阅读相关配置文件中注释的说明。
2. 你可以在 yamlchecker.com 网站上检查你写的配置文件语法是否正确，只需要将配置文件的内容复制到文本框中即可。
3. 当前任何配置文件的更改都需要重启机器人方可生效。

运行

进入本项目所在的目录 ./Adachi-BOT/ 。

1. 首次运行必须进行初始化以完成 QQ 的新设备认证，随后按下组合键 Ctrl+C 停止，此时初始化完成。
2. 需要启动一次后才可以允许、禁止开机启动。

更新

进入本项目所在的目录 ./Adachi-BOT/ 。

检查更新

./scripts/is_there_an_update_available.sh

进行更新

npm run update

查看配置文件变更

./scripts/whats_updated_in_the_configuration_files.sh

你可以使用 Meld 把 ./config_defaults/ 中的变更合并到 ./config/ 里。

重启机器人

npm run restart

功能

所有功能

具体命令请查看这里，一些只供管理者使用的主人命令请查看这里。

功能示例

请见 Wiki 中的《功能示例》。

致谢

此为项目的致谢名单，各项先后顺序均根据首字母排列。

贡献者

感谢以下人员以及未提及的贡献者们，你们让一切变得更好了。

第三方网站

本项目的一些功能使用了以下网站提供的 API 。

许可

MIT License 。