Skip to main content

Honkai Star Rail Toolkit

Project description

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

logo

开发状态

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

安装方式

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

命令行安装

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

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
python 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,以便精确控制导出的账号。

导出抽卡记录

命令行导出

可以使用如下命令导出:

hksr --api https://api-takumi.mihoyo.com/xxx

参数说明:

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

导出结果示例

  • 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.0.tar.gz (31.0 kB view details)

Uploaded Source

Built Distribution

starrail_toolkit-0.4.0-py3-none-any.whl (33.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: starrail-toolkit-0.4.0.tar.gz
  • Upload date:
  • Size: 31.0 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.0.tar.gz
Algorithm Hash digest
SHA256 69e9b573e49d7d5836bc3a6b41bcebad55e7a111dad5ce6856c692007a31495f
MD5 901dcf8b8dc85aeebf559ba8e3c17c94
BLAKE2b-256 7b6d9fb3785a16c132449e0d60059b199389e8ac4bf65478dd901b6857eb11f3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for starrail_toolkit-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9cae358d9018c600d318cba25fe08899da20fc321d093b54dc178f02e1fb894b
MD5 10d3d97c2f01c4a3a0c1818db596dad1
BLAKE2b-256 0a1605a739e11a386d38322023329d4677132db32dcb84140aec28101ac9e253

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