mirror of
https://github.com/samuelthomas2774/nxapi.git
synced 2026-03-21 18:04:10 -05:00
Update documentation
This commit is contained in:
parent
6f9afb041d
commit
82ba22b42f
102
docs/cli.md
102
docs/cli.md
|
|
@ -426,6 +426,67 @@ All SplatNet 3 commands may automatically request a web service token. This will
|
|||
nxapi splatnet3 user
|
||||
```
|
||||
|
||||
### Download history/hero/catalog records and stage/weapon stats
|
||||
|
||||
```sh
|
||||
# Download user records to the splatnet3 directory in nxapi's data path
|
||||
nxapi splatnet3 dump-records
|
||||
# Download user records to data/splatnet3
|
||||
nxapi splatnet3 dump-records data/splatnet3
|
||||
|
||||
# Only download history records
|
||||
nxapi splatnet3 dump-records --history
|
||||
# Only download hero records
|
||||
nxapi splatnet3 dump-records --hero
|
||||
# Only download catalog records
|
||||
nxapi splatnet3 dump-records --catalog
|
||||
# Only download stage stats
|
||||
nxapi splatnet3 dump-records --stage
|
||||
# Only download weapon stats
|
||||
nxapi splatnet3 dump-records --weapon
|
||||
```
|
||||
|
||||
### Download Splatfest records
|
||||
|
||||
```sh
|
||||
# Download Splatfest records to the splatnet3 directory in nxapi's data path
|
||||
nxapi splatnet3 dump-fests
|
||||
# Download Splatfest records to data/splatnet3
|
||||
nxapi splatnet3 dump-fests data/splatnet3
|
||||
|
||||
# Include rankings
|
||||
nxapi splatnet3 dump-fests --include-rankings
|
||||
```
|
||||
|
||||
### Download photo album items
|
||||
|
||||
```sh
|
||||
# Download photos to the splatnet3 directory in nxapi's data path
|
||||
nxapi splatnet3 dump-album
|
||||
# Download photos to data/splatnet3
|
||||
nxapi splatnet3 dump-album data/splatnet3
|
||||
```
|
||||
|
||||
### Download history/hero/catalog records and stage/weapon stats
|
||||
|
||||
```sh
|
||||
# Download user records to the splatnet3 directory in nxapi's data path
|
||||
nxapi splatnet3 dump-records
|
||||
# Download user records to data/splatnet3
|
||||
nxapi splatnet3 dump-records data/splatnet3
|
||||
|
||||
# Only download history records
|
||||
nxapi splatnet3 dump-records --history
|
||||
# Only download hero records
|
||||
nxapi splatnet3 dump-records --hero
|
||||
# Only download catalog records
|
||||
nxapi splatnet3 dump-records --catalog
|
||||
# Only download stage stats
|
||||
nxapi splatnet3 dump-records --stage
|
||||
# Only download weapon stats
|
||||
nxapi splatnet3 dump-records --weapon
|
||||
```
|
||||
|
||||
### Download battle/Salmon Run results
|
||||
|
||||
```sh
|
||||
|
|
@ -436,9 +497,46 @@ nxapi splatnet3 dump-results
|
|||
nxapi splatnet3 dump-results data/splatnet3
|
||||
|
||||
# Only download battle results
|
||||
nxapi splatnet3 dump-results --no-coop
|
||||
nxapi splatnet3 dump-results --battles
|
||||
# Only download Salmon Run results
|
||||
nxapi splatnet3 dump-results --no-battles
|
||||
nxapi splatnet3 dump-results --coop
|
||||
|
||||
# Additionally download history records
|
||||
nxapi splatnet3 dump-results --include-history
|
||||
# Additionally download catalog records
|
||||
nxapi splatnet3 dump-results --include-catalog
|
||||
```
|
||||
|
||||
### Monitor SplatNet 3 for new user records/battle/Salmon Run results
|
||||
|
||||
This will constantly check SplatNet 3 for new data.
|
||||
|
||||
```sh
|
||||
# Watch for new battle and Salmon Run results and photo album items and download them
|
||||
# to the splatnet3 directory in nxapi's data path
|
||||
nxapi splatnet3 monitor
|
||||
|
||||
# Watch for new battle and Salmon Run results and download them to data/splatnet3
|
||||
nxapi splatnet3 monitor data/splatnet3
|
||||
|
||||
# Download history records when new battle/coop results are available
|
||||
nxapi splatnet3 monitor --include-history
|
||||
# Download catalog records when new battle/coop results are available
|
||||
nxapi splatnet3 monitor --include-catalog
|
||||
# Download stage stats when new battle results are available
|
||||
nxapi splatnet3 monitor --include-stage
|
||||
# Download weapon stats when new battle results are available
|
||||
nxapi splatnet3 monitor --include-weapon
|
||||
|
||||
# Only monitor battle results
|
||||
nxapi splatnet3 monitor --battles
|
||||
# Only monitor Salmon Run results
|
||||
nxapi splatnet3 monitor --coop
|
||||
# Only monitor photo album items
|
||||
nxapi splatnet3 monitor --album
|
||||
|
||||
# Set update interval to 1800 seconds (30 minutes)
|
||||
nxapi splatnet3 monitor --update-interval 1800
|
||||
```
|
||||
|
||||
### Friends
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
`nxapi/nooklink`
|
||||
---
|
||||
|
||||
NookLink is more complex that SplatNet 2 as it supports multiple users linked to the same network account.
|
||||
NookLink is more complex than other web services as it supports multiple users linked to the same network account:
|
||||
|
||||
- `NooklinkApi` is used at NSA-level, and is solely used to list available NookLink users and authenticate to NookLink at ACNH-level.
|
||||
- `NooklinkUserApi` is used at ACNH-level, and is used to perform all other actions in the NookLink web app.
|
||||
|
|
|
|||
|
|
@ -120,4 +120,4 @@ splatnet.onTokenShouldRenew = async (remaining: number, response: Response) => {
|
|||
|
||||
### API types
|
||||
|
||||
`nxapi/splatnet3` exports all API types from [src/api/splatnet3-types.ts](../../src/api/splatnet3-types.ts).
|
||||
SplatNet 3 types are available from [splatnet3-types](https://gitlab.fancy.org.uk/samuel/splatnet3-types) ([GitHub](https://github.com/nintendoapis/splatnet3-types)).
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user