Skip to main content

Honkai Star Rail Toolkit

Project description

《崩坏:星穹铁道》工具箱

logo

开发状态

主分支版本 开发分支版本 PyPI 版本
0.4.0 0.4.1 0.4.1
  • 支持命令行导出 csv、xlsx、json 格式抽卡记录
  • 支持命令行显示抽卡报告
  • 支持导出 markdown 格式抽卡报告
  • 支持导出网页版抽卡报告
  • 支持中英文多语言导出
  • 支持 Windows 平台游戏中自动检测 API URL
  • 实现用户界面并编译到 Windows 与 macOS 平台
  • 支持自动检查更新

安装方式

目前仅提供命令行版本(我会尽快编译一个可以直接下载运行的应用程序版本),用户交互界面版本正在开发中。

命令行安装

Python 用户可以直接使用 pip 安装本工具:

python3 -m pip install starrail-toolkit --upgrade -i https://pypi.tuna.tsinghua.edu.cn/simple

从源码安装

若需要使用尚未推送到 PyPI 版本的功能,可通过源码安装:

git clone git@github.com:LittleNyima/honkai-starrail-toolkit.git
cd honkai-starrail-toolkit
python3 setup.py install

使用指南

获取抽卡查询 API URL

请参考【这个教程】获取查询链接。

由此可以获得一个形如 https://api-takumi.mihoyo.com/common/gacha_record/api/getGachaLog?xxxxx 的 URL,后续步骤使用的就是这个 URL。注意:API URL 会在一定时间(大约 24 小时)后过期,过期后需要重新获取。

注:若为 Windows 平台,可以使用本工具自动检测 API URL。 首先登陆游戏,进入抽卡查询页面,当显示出一页抽卡查询结果后,运行本工具,即可检测到抽卡查询 URL。如果需要切换账号,建议使用上述教程中的方法获取每个账号的 API URL,以便精确控制导出的账号。

导出抽卡记录

命令行导出

可以使用如下命令导出:

# 非 Windows 平台
hksr --api https://api-takumi.mihoyo.com/xxx
# Windows 平台无需 --api 参数
hksr

参数说明:

  • --api:(Windows 平台可选)API URL 地址。若为 Windows 平台,可以不填这个参数,而使用自动检测功能。
  • --export:(可选)导出格式选项。默认为导出全部格式,若仅需导出部分格式,可以替换对应参数。目前支持的格式有 csvhtmljsonmdxlsx。例如,若只需要 json 与 xlsx 格式数据,可以替换为 --export json xlsx
  • --locale:(可选)控制输出语言。默认为输出简体中文,可选值为 en(英语)、chs(简体中文)。
  • --log-level:(可选)日志等级。控制日志的输出等级,默认为 DEBUG。若感觉输出的日志过多影响观感,建议将日志等级更改为 INFO,例如:--log-level INFO。(注意:若设置的日志等级过高,可能导致基本的信息无法显示,例如导出进度、导出位置、命令行版抽卡报告等)从高到低的可选值为 CRITICALERRORWARNINGINFODEBUG

本项目目前正处于快速迭代阶段,使用方式可能会发生改变,更新时请留意本部分关于使用方式的说明。

Troubleshooting

  • 遇到 PermissionError: [Errno 13] Permission denied:应该是因为缓存文件被占用,建议退出游戏后重试。

导出结果示例

  • Excel 结果示例(为保护隐私已隐藏部分信息)

    xlsx
  • Markdown 结果示例:

    markdown

安全提醒

本仓库代码完全开源,且用户数据全部保存在本地,本项目不会上传任何用户数据。本项目仅在该 GitHub 仓库及 PyPI 进行分发,请仔细甄别下载到的程序,防止遭遇恶意程序。

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

starrail-toolkit-0.4.1.tar.gz (31.3 kB view details)

Uploaded Source

Built Distribution

starrail_toolkit-0.4.1-py3-none-any.whl (33.4 kB view details)

Uploaded Python 3

File details

Details for the file starrail-toolkit-0.4.1.tar.gz.

File metadata

  • Download URL: starrail-toolkit-0.4.1.tar.gz
  • Upload date:
  • Size: 31.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.13

File hashes

Hashes for starrail-toolkit-0.4.1.tar.gz
Algorithm Hash digest
SHA256 8f3230e6b7f62b38c3ef53dc88e03553c36ff30da4fb5226a1ab35623fa52d87
MD5 2d4bc2297e5fa16665f753375ce9f93a
BLAKE2b-256 28271c94f5711b2bf95a3bf5691ac2aaf201a985fca2e5dd505528224f7e8fe4

See more details on using hashes here.

File details

Details for the file starrail_toolkit-0.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for starrail_toolkit-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 359c458cd282afc6889b860505ad20c63cb456414f643ecc9dd4c3993c25feb4
MD5 c8f3784d001d3614393b3715689f32ca
BLAKE2b-256 e9ee67c155d9b5e7a54e43c3aa14b4bf5311cfab37bba8bafa2d8174a58da0ef

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page