better readme

splashcat-exporter
Rosalina 2023-12-03 18:05:25 -05:00
parent 6dd721bbab
commit 0a90da9b21
No known key found for this signature in database
1 changed files with 10 additions and 4 deletions

View File

@ -3,7 +3,7 @@
[![Build status](https://github.com/spacemeowx2/s3si.ts/workflows/Build/badge.svg)](https://github.com/spacemeowx2/s3si.ts/actions/workflows/ci.yaml)
[![Constant check status](https://github.com/spacemeowx2/s3si.ts/workflows/Constant%20Check/badge.svg)](https://github.com/spacemeowx2/s3si.ts/actions/workflows/constant-check.yaml)
Export your battles from SplatNet to stat.ink.
Export your battles from SplatNet to stat.ink and Splashcat.
If you have used s3s, please see [here](#migrate-from-s3s).
@ -17,9 +17,9 @@ If you have used s3s, please see [here](#migrate-from-s3s).
```
Options:
--profile-path <path>, -p Path to config file (default: ./profile.json)
--exporter <exporter>, -e Exporter list to use (default: stat.ink)
--exporter <exporter>, -e Exporter list to use (default: stat.ink,splashcat)
Multiple exporters can be separated by commas
(e.g. "stat.ink,file")
(e.g. "stat.ink,file,splashcat")
--list-method When set to "latest", the latest 50 matches will be obtained.
When set to "all", matches of all modes will be obtained with a maximum of 250 matches (5 modes x 50 matches).
When set to "auto", the latest 50 matches will be obtained. If 50 matches have not been uploaded yet, matches will be obtained from the list of all modes.
@ -38,6 +38,10 @@ Options:
- If you want to use a different profile, use `-p` to specify the path to the
profile file.
### Splashcat Notes
Splashcat requires battles uploaded to use `en-US` (set with `userLang`). Splashcat will localize battle results into the user's language when displayed.
### Track your rank
- Run
@ -71,7 +75,8 @@ Options:
// userLang will effect the language of the exported games to stat.ink
"userLang": "zh-CN",
"userCountry": "JP",
"statInkApiKey": "..."
"statInkApiKey": "...",
"splashcatApiKey": "..."
}
```
@ -95,3 +100,4 @@ Then run `s3si.ts`, and it will work without login prompt.
- https://github.com/frozenpandaman/s3s
- https://github.com/fetus-hina/stat.ink
- forked from https://github.com/spacemeowx2/s3si.ts