HCLonely / AWA-Helper

外星人论坛自动任务助手

AWA-Helper

外星人论坛自动做任务。

简体中文 • English

请到这里帮助我们改进翻译.

使用说明

用前说明

1. 使用前请确保 AWA 帐号已关联 Steam 帐号且 Steam 帐号信息已设置为公开
2. 使用前请确保 AWA 帐号已关联 Twitch 帐号且 Twitch 帐号已给 AWA 扩展授权(如何关联？)
3. [不建议]如需多开，请将本程序复制到不同文件夹运行

AWA-Manager

AWA-Manager 是一个 AWA-Helper 的管理器，开启后可在浏览器前端管理 AWA-Helper, 主要功能包括:

• Cookie 同步；
• 配置文件参数设置；
• AWA-Helper 运行状态查看；
• 控制启动/终止 AWA-Helper
• ...

建议长期不关机或挂载到服务器的用户使用此 AWA-Manager.

Cookie 同步

1. 在配置文件中配置managerServer和webUI , 并运行 AWA-Manager；
2. 在浏览器中安装Tampermonkey BETA扩展（注意是红色的 BETA 版本，普通版无法获取 Cookie！！！）；
3. 安装AWA-Manager用户脚本；
4. 打开https://www.alienwarearena.com/control-center页面配置ManagerServer；
5. 每次你打开浏览器页面时都会同步一次 Cookie.

通过编译好的可执行文件运行

如果你的电脑全天运行不关机或在服务器上运行建议使用 AWA-Manager.

视频教程

Windows

安装运行

1. 下载AWA-Helper-Win.tar.gz并解压；
2. 编辑配置文件,查看说明
3. 运行(以下两种二选一)：
   • 运行 AWA-Helper: 双击AWA-Helper.bat;
   • 运行 AWA-Manager: 双击AWA-Manager.bat运行 AWA-Manager;

更新

• 自动更新: 在 config 文件中配置autoUpdate: true;
• 手动更新: 双击'update.bat'.

Linux

PS1: MacOS 的兼容性未测试，不建议使用 MacOS 设备运行此程序！

PS2: 既然你使用 Linux 设备，以下为基于有一定 Linux 使用基础的说明！

安装运行

1. 下载AWA-Helper-Linux-x64.tar.gz并解压；

   curl -O -L https://github.com/HCLonely/AWA-Helper/releases/download/v3.0.2/AWA-Helper-Linux-x64.tar.gz # 注意替换版本号和CPU架构x64, armv7, armv8
   tar -xzvf AWA-Helper-linux-x64.tar.gz
   sudo mv dist AWA-Helper
   cd AWA-Helper
   sudo chmod +x AWA-Helper.sh
   sudo chmod +x AWA-Manager.sh
   sudo chmod +x update.sh

2. 编辑配置文件,查看说明

   sudo cp config/config.example.yml config/config.yml

3. 运行(以下两种二选一)：

   • 运行 AWA-Helper: ./AWA-Helper.sh;
   • 运行 AWA-Manager: ./AWA-Manager.sh.

更新

• 自动更新: 在 config 文件中配置autoUpdate: true;
• 手动更新: ./update.sh.

通过 NodeJS 运行

这种方法更新时下载的文件体积小，但需要在本地安装 NodeJS.

安装运行

1. (仅首次安装需要)安装NodeJs >= v16.0.0;

2. 下载main.js；

   mkdir AWA-Helper
   cd AWA-Helper
   curl -O -L https://github.com/HCLonely/AWA-Helper/releases/download/v3.0.2/main.js # 注意替换版本号为最新版

3. (仅首次安装需要)初始化

   node main.js

4. 编辑配置文件,查看说明

   cp config/config.example.yml config/config.yml

5. 运行(以下两种二选一)：

   • 运行 AWA-Helper: node main.js --helper;
   • 运行 AWA-Manager:node main.js --manager.

更新

• 自动更新: 在 config 文件中配置autoUpdate: true;
• 手动更新: node main.js --update;

使用 Docker

运行

!!! Docker 方式运行不要修改managerServer和webUI的port，并设置autoUpdate和managerServer的local为false!!!

• AWA-Manager(建议)

docker run -d --name awa-helper -p 2345:2345 -p 3456:3456 -v /data/awa-helper/config:/usr/src/app/output/config -v /data/awa-helper/logs:/usr/src/app/output/logs -e helperMode=manager hclonely/awa-helper:latest

• 或 AWA-Helper

docker run -d --name awa-helper -p 3456:3456 -v /data/awa-helper/config:/usr/src/app/output/config -v /data/awa-helper/logs:/usr/src/app/output/logs hclonely/awa-helper:latest

ps:容器内有两个挂载点：/usr/src/app/dist/config和/usr/src/app/dist/logs，分别对应于本地路径/data/awa-helper/config和/data/awa-helper/logs（可自定义修改），前者存放配置文件，后者是存放日志文件。

config 文件配置

需要复制一份config文件夹里的config.example.yml文件并重命名为config.yml!!!

全局配置(必需)

全局配置参数说明

language: zh # 程序显示语言，目前支持中文 (zh) 和 English (en)
webUI:
  enable: true # 是否启用WebUI
  port: 3456 # WebUI端口
  ssl: # WebUI启用SSL
    key: xxx.yyy-key.pem # SSL证书key文件名，将此文件放到与config.yml配置文件同一目录！
    cert: xxx.yyy.pem # SSL证书文件名，将此文件放到与config.yml配置文件同一目录！
timeout: 0 # 超时设置，单位：秒，0为不限制。如果程序运行超过此时间后还在运行，则终止此程序。
logsExpire: 30 # 日志保留时间，单位：天，默认30天，0为不限制。
TLSRejectUnauthorized: true # 是否启用TLSSocket库校验，默认开启。如果使用代理出现网络问题，可尝试更改此项！
UA: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Safari/537.36 Edg/117.0.2045.47' # 浏览器UA
autoUpdate: true # 自动更新

AWA-Manager 配置

AWA-Manager 配置参数说明

managerServer:
  enable: false # 需同时启用webUI
  secret: '' # AWA-Manager Secret，强烈建议修改
  local: true # 仅内网访问，false为开启外网访问
  port: 2345 # AWA managerServer端口
  # ssl: # managerServer启用SSL
    # key: xxx.yyy-key.pem # SSL证书key文件名，将此文件放到与config.yml配置文件同一目录！
    # cert: xxx.yyy.pem # SSL证书文件名，将此文件放到与config.yml配置文件同一目录！
  corn: '3 30 14,21 * * *' # 定时启动AWA-Helper，需开启managerServer
#        ┬ ┬─ ──┬── ┬ ┬ ┬
#        │ │    │   │ │ |
#        │ │    │   │ │ └─────────────── 一周的第几天 (0 - 7, 1L - 7L) (0或7是周日) ┐
#        │ │    │   │ └───────────────── 月份     (1 - 12)                  ├─ 日期
#        │ │    │   └─────────────────── 每月的第几天 (1 - 31, L)               ┘
#        │ │    └───────────────────── 小时 (0 - 23) ┐
#        │ └────────────────────────── 分钟 (0 - 59) ├─ 时间
#        └───────────────────────── ───秒  (0 - 59) ┘
# 示例中的表达式代表每天的14:30:03和21:30:03启动AWA-Helper
# !! 注意每次运行的时间间隔要大于前面设置的timeout
  artifacts: # 定时更换遗物
    - corn: '7 29 9 * * 1' # 写法格式同上
      ids: '636,17056,30235' # 遗物id, 英文逗号分隔
    - corn: '36 44 10 * * 2'
      ids: '636,17056,53672'
# !! 注意每次更换遗物的时间间隔要大于24小时

AWA 配置(必需)

AWA 参数说明

awaCookie: '' # 外星人论坛Cookie, 可以只有`REMEMBERME`, 没有`REMEMBERME`则必须有`PHPSESSID`和`sc`, 但会导致连续签到天数获取错误，不会影响其他功能
awaHost: 'www.alienwarearena.com' # 外星人论坛Host, 常用的有`www.alienwarearena.com`和`na.alienwarearena.com`, 默认的没问题就不要改
# awaBoosterNotice: true # 已弃用！外星人论坛任务大于1个时询问是否开启助推器，助推器需要自行开启！！！
awaQuests:
  - getStarted # 自动做左下角的GET STARTED任务，不需要做此任务删除或注释掉此行
  - dailyQuest # 自动做每日任务，不需要做此任务删除或注释掉此行
  - timeOnSite # 自动做AWA在线任务，不需要做此任务删除或注释掉此行
  - watchTwitch # 自动做Twitch直播间在线任务，不需要做此任务删除或注释掉此行
  - steamQuest # 自动做Steam游戏时长任务，不需要做此任务删除或注释掉此行
awaDailyQuestType: # 每日任务类型，不需要注释掉即可，全部注释=全部开启，如果不需要做每日任务请注释上面的`dailyQuest`
  - click # 浏览页面任务，务标题为任务链接，需点击任务才能完成
  - visitLink # 浏览页面任务，任务标题为任务链接，浏览页面才能完成
  - openLink # 浏览页面任务，任务标题无链接，尝试浏览 排行榜，奖励，商店页面
  - changeBorder # 更换Border
  - changeBadge # 更换Badge
  - changeAvatar # 更换Avatar
  - viewNews # 浏览新闻
  - sharePost # 分享帖子
  - replyPost # 回复帖子
awaDailyQuestNumber1: true # 每日任务有多个时是否只做第一个
awaSafeReply: false # 今日回复过帖子则跳过回复帖子操作，默认不跳过(false)
autoUpdateDailyQuestDb: false # 自动更新每日任务数据库
joinSteamCommunityEvent: true # 自动加入Steam社区活动

AWA 参数获取方式

自动更新

参考Cookie 同步。

手动获取

1. 打开https://www.alienwarearena.com/account/personalization页面，打开控制台，找到网络一栏，筛选personalization, 复制请求头中cookie:后面的部分，粘贴到配置文件中的awaCookie部分；

2. [可选&建议] 打开控制台输入以下内容，并把你的COOKIE替换为复制的cookie，回车运行后会剔除不需要的cookie.

   console.log(`你的COOKIE`.split(';').map((e) => ['REMEMBERME','PHPSESSID','sc'].includes(e.trim().split('=')[0]) ? e.trim() : null).filter((e) => e).join(';'));

Twitch 配置(可选)

做 Twitch 在线任务需要，不想做这个任务可以不填。自动做 Twitch 任务前需要先在 Twitch 给外星人扩展授权，只需授权一次即可。

Twitch 参数说明

twitchCookie: '' # Twitch Cookie, 须包括`unique_id` 和 `auth-token`

Twitch 参数获取方式

1. 打开https://www.twitch.tv/页面，打开控制台输入以下内容获取：

document.cookie.split(';').filter((e) => ['unique_id','auth-token'].includes(e.split('=')[0].trim())).join(';');

Steam 任务配置

挂 Steam 游戏时长的方式, 仅支持ASF.

已支持自选 Steam 游戏任务，需在游戏选择页面同步游戏(Sync Game)一次。

steamUse: 'ASF' # 挂时长方式

ASF 配置(可选)

使用ASF挂 Steam 游戏时长任务需要，不想做这个任务可以不填。需要steamUse为ASF.

ASF 参数说明

asfProtocol: 'http' # ASF使用的协议，一般都是`http`
asfHost: '127.0.0.1' # ASF使用的Host，本地运行一般是`127.0.0.1`
asfPort: '1242' # ASF使用的端口，默认是`1242`
asfPassword: '' # ASF IPCPassword
asfBotname: '' # 要挂游戏的ASF Bot名称

proxy 配置(可选)

代理设置，一般 Twitch 任务需要。

proxy 参数说明

proxy:
  enable:
    - github # 在检测更新时使用代理，不使用删掉此行
    - twitch # 在访问Twitch站点时使用代理，不使用删掉此行
    - awa # 在访问外星人论坛站点时使用代理，不使用删掉此行
    - asf # 在访问ASF时使用代理，不使用删掉此行
    - steam # 在访问Steam时使用代理，不使用删掉此行
    - pusher # 在推送时使用代理，不使用删掉此行
  protocol: 'http' # 代理协议，'http'或'socks'
  host: '127.0.0.1' # 代理host
  port: 7890 # 代理端口
  username: '' # 代理用户名，没有可留空
  password: '' # 代理密码，没有可留空

推送配置(可选)

推送配置参数说明

pusher:
  enable: false # 是否启用推送，这里以GoCqhttp为例
  platform: GoCqhttp # 推送平台，具体支持情况请查看 https://github.com/HCLonely/all-pusher-api#已支持平台
  key: # 配置参数，以下参数不是固定的，请参考 https://github.com/HCLonely/all-pusher-api#参数
    token: '******'
    baseUrl: 'http://127.0.0.1:5700'
    user_id: '******'

功能

每日任务（旧版）

flowchart TD
  A([Start]) --> B{任务是否完成}
  B --> |Yes| C([Stop])
  B --> |No| D{是否为点击浏览任务}
  D --> |Yes| E[执行此任务]
  E --> F{任务是否完成}
  F --> |Yes| C
  F --> |No| G{"是否为浏览页面\n任务(有链接)"}
  D --> |No| G
  G --> |Yes| H[执行此任务]
  H --> I{任务是否完成}
  I --> |Yes| C
  I --> |No| J{数据库中是否\n有此任务}
  J --> |Yes| K[执行此任务]
  K --> L{任务是否完成}
  L --> |Yes| C
  L & J --> |No| M["更换边框\n更换徽章\n更换头像\n浏览新闻\n分享帖子\n浏览排行榜页面\n浏览奖励页面\n浏览商店页面\n浏览视频页面"]
  M --> N{任务是否完成}
  N --> |Yes| C
  N --> |No| O[回复帖子]
  O --> P{任务是否完成}
  P --> |Yes| C
  P --> |No| C

Loading

AWA 在线

flowchart TD
  A([Start]) --> B{任务是否完成}
  B --> |Yes| C([Stop])
  B --> |No| D[循环发送在线心跳]
  D -.-> E[任务是否完成] -. 完成 .-> C

Loading

Twitch 任务

flowchart TD
  A([Start]) --> B{任务是否完成}
  B --> |Yes| C([Stop])
  B --> |No| D[获取可用直播]
  D --> E{是否有可用直播}
  E --> |Yes| F[获取直播间ID]
  E --> |No| G[等待10分钟]
  F --> |失败| K{有其他可用直播间}
  K --> |Yes| H[更换直播间]
  K --> |No| C
  H --> F
  F --> |成功| I[获取直播间扩展信息]
  I --> |失败| K
  I --> |成功| J[循环发送在线心跳]
  J -.-> L[任务是否完成] -. 完成 .-> C

Loading

Steam 任务

flowchart TD
  A([Start]) --> B[获取任务信息]
  B --> C[获取每个任务详细信息]
  C --> |未拥有| D["重新检测\n(相当于点击\nCheck Games按钮)"]
  D --> |未拥有| F([跳过此任务])
  C & D --> |已拥有| E["开始此任务\n(相当于点击\nStart Quest按钮)"]
  E --> F{调用ASF检测\n游戏库中是否有\n任务游戏}
  C --> |已开始| F
  F --> |Yes| G[调用ASF挂时长]
  F --> |No| H([Stop])
  G -.-> I[任务是否完成] -. 完成 .-> H

Loading

运行示例

TODO

感谢以下开源项目

• axios
• chalk
• cheerio
• cron-parser
• dayjs
• decompress
• express
• express-ws
• form-data
• i18n-node
• lodash
• node-cron
• node-tunnel
• node-socks-proxy-agent
• yaml
• yaml-lint
• eslint
• node-fs-extra
• highlight.js
• marked
• rollup
• TypeScript
• UglifyJS