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:
Features
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
- Clone the repository.
- Run
npm install to install the dependencies.
- Create a
config.json or rename default.config.json to config.json.
- Follow the instructions in the
config.json file.
Usage
- Go to your HoyoLab profile here.
- Log in with your Hoyoverse account.
- Open the browser console (F12).
- Click on the “Network” tab.
- Refresh the page.
- Search for
getGameRecordCard and click on it.
- Click on the “Cookies” tab.
- Look for
account_mid_v2, cookie_token_v2, and ltuid_v2.
- Double click the value of each cookie and copy it.
- Paste the values in your
default.config.js or config.js file.
- Run
index.js with node index.js if you want to run it indefinitely everytime the daily reset occurs.
- Run
index.js with node index.js --sign if you want to run it once.
- 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).
- Prepare the configuration file as described in the Installation and Usage sections.
- Build the base image with
docker compose build or without cache with docker compose build --no-cache.
- Start the container with
docker compose up -d.
- 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!
评论