yindan/genshinhelper repository overview

English | 简体中文⁠

░█▀▀▀░█▀▀░█▀▀▄░█▀▀░█░░░░░▀░░█▀▀▄░█░░░░█▀▀░█░░▄▀▀▄░█▀▀░█▀▀▄
░█░▀▄░█▀▀░█░▒█░▀▀▄░█▀▀█░░█▀░█░▒█░█▀▀█░█▀▀░█░░█▄▄█░█▀▀░█▄▄▀
░▀▀▀▀░▀▀▀░▀░░▀░▀▀▀░▀░░▀░▀▀▀░▀░░▀░▀░░▀░▀▀▀░▀▀░█░░░░▀▀▀░▀░▀▀

⁠Table of Contents

• Features⁠
• Installation⁠
• Usage⁠
  • Docker⁠
  • PyPI Package⁠
  • Serverless⁠
    • Tencent Cloud SCF⁠
    • Alibaba Cloud FC⁠
    • AWS Lambda⁠
• Configuration⁠
  • Environment Variables⁠
  • Configuration file⁠
  • Multiple accounts⁠
• Contributing⁠
• Help and Support⁠
• Acknowledgements⁠
• License⁠

If this project is helpful to you, please give us a ⭐️Star QAQ ♥

⁠Features

• miHoYo BBS Genshin Impact daily check-in
• HoYoLAB Community Genshin Impact daily check-in
• Weibo super topic daily check-in
• Support subscription push
• Support multiple accounts
• Support multiple roles (CN Server)

⁠Installation

This project uses Docker⁠ or Python3⁠. Go check it out if you don't have one of them locally installed.

• Docker

You can use the following command to pull the image:

$ docker pull yindan/genshinhelper

This pulls the latest release of genshinhelper.

It can be found at Docker Hub⁠.

• PyPI Package

You can also use the pypi package⁠:

$ pip install genshinhelper

⁠Usage

⁠Docker

In the following commands, COOKIE_MIHOYOBBS is the variable name and <COOKIE_MIHOYOBBS> is your COOKIE_MIHOYOBBS value. The same goes for DISCORD_WEBHOOK and so on.

You can find all the environment variables used in this project in the Configuration⁠ section.

• Basic usage

$ docker run -d --name=genshinhelper \
-e COOKIE_MIHOYOBBS="<COOKIE_MIHOYOBBS>" \
-e DISCORD_WEBHOOK="<DISCORD_WEBHOOK>" \
--restart always \
yindan/genshinhelper:latest

• Advanced usage

Docker triggers tasks at 6:00 (UTC+8) every day by default. Use the CRON_SIGNIN variable to customize the trigger time.

$ docker run -d --name=genshinhelper \
-e COOKIE_MIHOYOBBS="<COOKIE_MIHOYOBBS>" \
-e DISCORD_WEBHOOK="<DISCORD_WEBHOOK>" \
-e CRON_SIGNIN="0 7 * * *" \
--restart always \
yindan/genshinhelper:latest

If you want to use the config.json configuration file, use the following command to map the relevant folder.

Assuming your configuration file is located at /etc/genshin/config.json.

$ docker run -d --name=genshinhelper \
-v /etc/genshin:/app/genshincheckinhelper/config \
--restart always \
yindan/genshinhelper:latest

• Useful commands

# Logs
$ docker logs -f genshinhelper --tail 100

# Restart
$ docker restart genshinhelper

# Update
$ docker pull yindan/genshinhelper
$ docker rm -f genshinhelper
# Re-create the container with the latest image according to basic usage or Advanced usage.

# Uninstall
$ docker rm -f genshinhelper
$ docker image rm genshinhelper

⁠PyPI Package

You must add environment variables in host at first. See Configuration⁠ for more details.

The following command assume that you have already added the environment variables.

$ python -m genshinhelper

⁠Serverless

If you don't have a host, you can try using serverless deployment. It can help you to automatically check-in every day.

You need to download the latest genshinhelper-xxx-serverless.zip serverless zip file at first. The entry point of the zip file is index.main_handler.

⁠Tencent Cloud SCF

International⁠ | 中国站⁠

• Go to 云函数 SCF 管理控制台⁠ → 函数服务 → 新建 → 自定义创建 → 基础配置 → 本地上传zip包 → 上传 → 本地上传zip包 → Select the downloaded file genshinhelper-xxx-serverless.zip → 完成

• Go to genshinhelper → 函数管理 → 函数配置 → 编辑

• Modify 执行超时时间 to 300 seconds and add environment variables in 环境变量. The list of environment variables can be found in the Configuration⁠ section.

• Go to genshinhelper → 触发管理 → 新建触发器 → Configure as shown below:

⁠Alibaba Cloud FC

International⁠ | 中国站⁠

• Go to 函数计算 FC 管理控制台⁠ → 新建函数 → 事件函数 → 代码包上传 → 上传代码 → Select the downloaded file genshinhelper-xxx-serverless.zip → Configure as shown below. Note that the entry point is index.main_handler → 新建

• Go to genshinhelper → 概览 → 修改配置

• Scroll down and find 环境变量 to add environment variables. The list of environment variables can be found in the Configuration⁠ section.

• Go to genshinhelper → 触发器 → 创建触发器 → Configure as shown below:

⁠AWS Lambda

• Go to AWS Lambda⁠ → Sign In to the Console → Choose a region (Singapore for example)

• Click All services → Lambda
• In the left, Functions → Create function
• Choose Author from scratch / Function name: yourAwesomeFunctionName / Runtime: Python 3.8 → Create function

• In function dashboard, Code → Upload from → .zip file → Select the downloaded file genshinhelper-xxx-serverless.zip → Save

• Scroll down, edit runtime settings. Change the original lambda_function.lambda_handler in Handler section to index.main_handler → Save

• Back to Function overview, click Add trigger → search / choose EventBridge → Configue as shown below

• Function dashboard → Configuration → General configuration → Edit → Timeout change to 5 min 0 sec

• Configuration → Environment variables → Edit → Add environment variable

⁠Configuration

The project has two ways of using custom configurations.

⁠Environment Variables

You can write your configuration directly into the environment variables.

The following table lists all the environment variables used in this project:

⁠Configuration file

It is recommended to copy and rename config.example.json to config.json before use the configuration file.

A config.example.json in JSON like below:

{
  "LANGUAGE": "en-us",
  "COOKIE_MIHOYOBBS": "",
  "COOKIE_MIYOUBI": "",
  "COOKIE_HOYOLAB": "",
  "COOKIE_WEIBO": "",
  "COOKIE_KA": "",
  "BARK_KEY": "",
  "BARK_SOUND": "healthnotification",
  "COOL_PUSH_SKEY": "",
  "COOL_PUSH_MODE": "send",
  "CUSTOM_NOTIFIER": {
    "method": "post",
    "url": "",
    "data": {
    },
    "retcode_key": "",
    "retcode_value": 200,
    "data_type": "data",
    "merge_title_and_desp": false,
    "set_data_title": "",
    "set_data_sub_title": "",
    "set_data_desp": ""
  },
  "DD_BOT_TOKEN": "",
  "DD_BOT_SECRET": "",
  "DISCORD_WEBHOOK": "",
  "IGOT_KEY": "",
  "PUSH_PLUS_TOKEN": "",
  "PUSH_PLUS_USER": "",
  "SCKEY": "",
  "SCTKEY": "",
  "TG_BOT_API": "api.telegram.org",
  "TG_BOT_TOKEN": "",
  "TG_USER_ID": "",
  "WW_ID": "",
  "WW_APP_SECRET": "",
  "WW_APP_USERID": "@all",
  "WW_APP_AGENTID": "",
  "WW_BOT_KEY": ""
}

⁠Multiple accounts

Multiple account cookies need to be separated by "#" symbol. e.g. COOKIE_MIHOYOBBS="<cookie1>#<cookie2>#<cookie3>"

⁠Contributing

Feel free to dive in! Open an issue⁠ or submit PRs.

⁠Help and Support

Please join our chat groups for help and support.

QQ Group⁠ | Discord⁠ | Telegram⁠

⁠Acknowledgements

The idea for the miyoubi feature is inspired by XiaoMiku01's project miyoubiAuto⁠.

Huge thanks to the contributors of the y1ndan/genshin-impact-helper⁠ project:

• PomeloWang
• Celeter
• Arondight
• chenkid999
• xe5700
• Renari
• journey-ad
• aflyhorse
• thesadru
• PeterPanZH
• cainiaowu
• alwaysmiddle
• qianxu2001

⁠License