Notice

This project only receives bug fixes. Please use hoyolab-auto instead

Honkai: Star Rail Helper

Honkai: Star Rail Helper

A multi-purpose tool for the Honkai Impact: Star Rail that can be used to automate the daily check-in process, check stamina and expedition status.

Services

If you don't want to use Node.js and simply only want to use it for auto check-in, you can use one of the following services:

• Google Apps Script

Features

• Auto Check-in

  

• Multiple accounts
• Stamina check (Node only)
  • Will send you notification if your stamina is above set threshold (default: 170)
• Expedition check (Node only)
  • Will send you notification if your expedition is done
• Reminders (Node only)
  • Dailies
    • Remind you to do your daily commission every day at 09:00 PM or your specified time (Only if you haven't done it yet)
  • Weeklies
    • Remind you to do your weekly boss every your specified time or Sunday 09:00 PM (Only if you haven't done it yet)
    • Remind you to do your Simulated Universe points every your specified time or Sunday 09:00 PM (Only if you haven't done it yet)
• Code Redeem (Node only)
  • Will send you notification if there's a new code available
  • Will automatically redeem the code for you
• Discord notifications
• Telegram notifications (Node only)
  • Commands
    • Check stamina
    • Check expedition status

Pre-requisites

• Node.js (You will need to run your computer 24/7 if you want to use this, Google Apps Script is recommended if you don't want to run your computer 24/7 but you can only use it for auto check-in)

Installation

1. Clone the repository.
2. Run npm install to install the dependencies.
3. Create a config.json or rename default.config.json to config.json.
4. Follow the instructions in the config.json file.

Usage

1. Go to your HoyoLab profile here.
2. Log in with your Hoyoverse account.
3. Open the browser console (F12).
4. Click on the "Network" tab.
5. Refresh the page.
6. Search for getGameRecordCard and click on it.
7. Click on the "Cookies" tab.
8. Look for account_mid_v2, cookie_token_v2, and ltuid_v2.
9. Double click the value of each cookie and copy it.
10. Paste the values in your default.config.js or config.js file.
11. Run index.js with node index.js if you want to run it indefinitely everytime the daily reset occurs.
12. Run index.js with node index.js --sign if you want to run it once.
13. Additonal arguments:
    • --stamina to check all accounts stamina. (You need to set your in-game uid for it to work)
    • --expedition to check all accounts expedition status. (You need to set your in-game uid for it to work)
    • --help to show the help menu.

Notifications

For Discord notifications or Telegram setup, refer to this folder: setup

Docker

To start the project, you can use Docker.

How to run

For the application to work, the configuration file must be mounted under /app/config.json or /app/default.config.json, respectively (refer to docker-compose.yml for details).

1. Prepare the configuration file as described in the Installation and Usage sections.
2. Build the base image with docker compose build or without cache with docker compose build --no-cache.
3. Start the container with docker compose up -d.
4. Check logs with docker compose logs -f.

Makefile

There is a handy Makefile that can be used with GNU Make or GNU Make for Windows.

List of generally used commands:

• make run - Start application.
• make run-once - Start application once.
• make install - Download node modules.
• make start - Start the Docker container instance.
• make stop - Stop the Docker container instance.
• make logs - Read logs generated by the Docker container.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. If there's any bugs, please open an issue.

New here?

To get started, fork the repo, make your changes, add, commit and push your changes to your fork, then come back here and open a pull request. If you're new to GitHub, this tutorial may help.

You can support the project by giving it a star, sharing it with your friends, contributing to the project, and report any bugs you find.

Buy me a coffee

If this repo is useful to you, you can buy me a coffee to support me. Thank you!

• Ko-fi
• Trakteer