Skip to content

Latest commit

 

History

History
148 lines (116 loc) · 5.04 KB

README.md

File metadata and controls

148 lines (116 loc) · 5.04 KB
Raw

HoyoLab Auto Logo
HoyoLab Auto

NodeJS version badge License badge GitHub stars badge

HoyoLab Auto

A multi-purpose tool for any supported Hoyoverse games. This tool is designed to assist with daily check-ins, stamina checks, expedition checks, automatic code-redemption, and more.

Supported Games

  • Honkai Impact 3rd (Daily Check-In only)
  • Genshin Impact
  • Honkai: Star Rail
  • Zenless Zone Zero

Features

  • Auto check-in: Runs every midnight local time.
  • Dailies check: Reminds you to complete your daily tasks, such as daily commissions, at 09:00 local time.
  • Weeklies check: Reminds you to complete weekly tasks, such as weekly bosses and discounted resin usage, at 09:00 local time.
  • Stamina check: Monitors your Resin/Stamina every 30 minutes.
    • Customizable threshold: Notifies you when your stamina is above your set threshold.
  • Expedition check: Checks your expeditions every 30 minutes.
  • Shop status: This will notify you when your shop has finished selling videos (ZZZ Feature).
  • Code Redemption: Automatically search and redeem codes for supported games.
    • Genshin Impact
    • Honkai: Star Rail
    • Zenless Zone Zero
  • Notifications:
    • Discord
    • Telegram

Google App Script

If you don't have a server to run this script and simply just want to use it for checking in, you can use Google App Script.

Prerequisites

Installation

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

Usage

For a detailed usage guide, refer to this gist: Cookie Guide.

Notifications Setup

For setting up Discord or Telegram notifications, refer to the setup folder.

Running with Docker

This application can be easily managed and run using Docker. We provide a Makefile for convenience, but you can also use Docker commands directly.

1. Prerequisites

2. Configuration

  • Rename default.config.js: Create a copy of default.config.js named config.js and fill in your application's configuration: 
    cp default.config.js config.js
# Edit config.js with your settings

3. Building and Running with Docker Compose

Using the Makefile (Recommended):

The provided Makefile simplifies common Docker tasks.

  • Build the image:

    make build

  • Start the application:

    make up

  • Stop the application:

    make down

  • View logs:

    make logs

  • Rebuild and restart:

    make update

    For a complete list of available Makefile targets, run:

    make help

Using Docker Compose Directly:

If you prefer not to use the Makefile, you can use the following Docker Compose commands:

  • Build the image: 
    docker-compose build
  • Start the application: 
    docker-compose up -d
  • Stop the application: 
    docker-compose down
  • View logs: 
    docker-compose logs -f instance
  • Rebuild and restart: 
    docker-compose down && docker-compose build && docker-compose up -d

Contributing

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

If you have any suggestions or ideas, feel free to open an issue.

New to contributing?

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

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

Buy Me a Coffee

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

ko-fi