Skip to content

Home

Jump to bottom
Kevin L. edited this page Aug 5, 2024 · 4 revisions

Honkai: Star Rail - starrail

Centered Image

Overview

The starrail package is a CLI (command-line interface) tool designed for managing and interacting with the game, Honkai: Star Rail, directly from your terminal.

Key Features:

  • Game Launch Control

    • Start/Stop the game application directory from the terminal (skips launcher).
    • Schedule the game to start/stop at any given time (i.e. 10:30AM).

  • Simple Automation

    • Custom Macros: Record and playback recorded mouse + keyboard click sequences in-game.
    • Uniform Click: Allows automatic uniform-interval mouse clicking (duration can be randomized).

  • Binary Decoding

    • Web Cache: Access decoded web cache URLs containing information about pulls, events, and announcements.
    • Streaming Assets: Access detailed client streaming asset information (read-only).
    • Supplement Binary Decoder: Provides supplementary tools to decode any ASCII-based binary file.

  • Other Features

    • Screenshots: Open the screenshots directory from the CLI without the game launcher.
    • Official Pages: Open the official HoyoVerse web pages easily from the CLI.

Please view the Developer's Note on the recent project changes (0.0.3 to 1.0.0).

Note

Installation Requirements

  • Windows 10 or later
  • Python 3.6 or later
  • Official Honkai: Star Rail Installation
Clone this wiki locally