Metadata-Version: 2.1
Name: starrail
Version: 0.0.2
Summary: Honkai: Star Rail Automation Package (auto-grind resources)
Home-page: https://github.com/ReZeroE/StarRail
Author: Kevin L.
Author-email: kevinliu@vt.edu
Project-URL: Bug Tracker, https://github.com/ReZeroE/StarRail/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 1 - Planning
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# Honkai Star Rail - `starrail`


<img src="https://i.imgur.com/8Elhiqy.jpg" width="400" height="auto" align="left"/>
<ul>
  
```
Honkai: Star Rail Automation Package
- Auto Resources Grind
- Auto Daily Login and Award Collection

Supported OS Platforms:
- Windows [Official Star Rail Installation]

Android/iOS emulators are not supported.
```

| [Overview](https://github.com/ReZeroE/StarRail#installation--setup) |  -  |
[Installation / Setup](https://github.com/ReZeroE/StarRail#installation--setup) |

</ul>
<br clear="left"/>

**Note: This package is currently under development - [`Development Status :: 1 - Planning`]**

***

## Updates (4/29/2023)

The ongoing progress of the package's development will continue, albeit with a temporary suspension on incorporating newer updates that enhance the module's ability to interact with the game's content. At present, we are awaiting responses from Honkai: Star Rail's developers regarding the possibility of any infringement on their Fair Use Policies from using the `starrail` package (including the features we planned to implement).

To learn more about this, feel free to read [Honkai: Star Rail's Fair Gaming Declaration](https://hsr.hoyoverse.com/en-us/news/111244).


## Overview

The `starrail` package is a Python3-based module that facilitates the automation of various tasks pertaining to Honkai Star Rail. This package is currenly undergoing active development, and additional details will be made available in due course.

Features in current development include:
- Command-Line Support
  - Starting / Terminating / Restarting the game
- Auto Resources Grind
- Auto Daily Login and Award Collection

## Installation / Setup
The install the `starrail` package, run:
```shell
pip install starrail
```
OR
```shell
git clone https://github.com/ReZeroE/StarRail.git
cd StarRail/
pip install .
```

# Disclaimer
The "starrail" Python3-based module is an external script/tool
designed to automate the gameplay of Honkai Star Rail. The creator(s) 
of this package has no relationship with MiHoYo, the game's developer.
The use of this package is entirely at the user's own risk, and the
creator accepts no responsibility for any damage or loss caused by
the package's use. It is the user's responsibility to ensure that
they use the package according to Honkai Star Rail's Fair Gaming
Declaration, and the creator accepts no responsibility for any
consequences resulting from its misuse, including game account
penalties, suspension, or bans.

Please note that according to MiHoYo's [Honkai: Star Rail's Fair Gaming Declaration](https://hsr.hoyoverse.com/en-us/news/111244):

    "It is strictly forbidden to use external plug-ins, game
    accelerators/boosters, scripts, or any other third-party tools
    that damage the balance of the game. Once discovered, COGNOSPHERE
    PTE. LTD. (referred to as "we" henceforth) will take appropriate
    actions depending on the severity and frequency of the offenses.
    These actions include removing rewards obtained through such
    infringements, suspending the game account, or permanently
    banning the game account. Therefore, the user of this package
    must be aware that the use of this package may result in the
    above actions being taken against their game account by MiHoYo."

By using this package, the user agrees to ALL terms and conditions
and acknowledges that the creator will not be held liable for any
negative outcomes that may occur as a result of its use.

## License

<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/0/0c/MIT_logo.svg/220px-MIT_logo.svg.png" align="left" width="150"/>

<ul>
 - MIT Licensed
</ul>

<br clear="left"/>
