Leahnaya/nxapi
1
0
Fork 0
mirror of https://github.com/samuelthomas2774/nxapi.git synced 2026-08-28 05:38:06 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Samuel Elliott
2022-10-31 16:41:41 +00:00
parent 6c7f008617
commit 1a25639440
2 changed files with 57 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -1,7 +1,7 @@
nxapi
===
JavaScript library and command line and Electron app for accessing the Nintendo Switch Online and Nintendo Switch Parental Controls app APIs. Show your Nintendo Switch presence in Discord, get friend notifications on desktop, and download and access SplatNet 2, NookLink and Parental Controls data.
JavaScript library and command line and Electron app for accessing the Nintendo Switch Online and Nintendo Switch Parental Controls app APIs. Show your Nintendo Switch presence in Discord, get friend notifications on desktop, and download and access SplatNet 2, NookLink, SplatNet 3 and Parental Controls data.
[![Discord](https://img.shields.io/discord/998657768594608138?color=5865f2&label=Discord)](https://discord.com/invite/4D82rFkXRv)

56
docs/cli.md
View File

@@ -629,6 +629,62 @@ nxapi pctl dump-summaries data/summaries
nxapi pctl dump-summaries --device 0123456789abcdef
```
Presence server
---
nxapi includes a HTTP server for fetching presence data from Coral and SplatNet 3.
```sh
# Start the server listening on all interfaces on a random port
# The `--user` option is required and can be used multiple times
nxapi presence-server --user 0123456789abcdef
# Start the server listening on a specific address/port
# The `--listen` option can be used multiple times
nxapi presence-server --listen "[::1]:12345" --user 0123456789abcdef
# Enable Splatoon 3 presence data using SplatNet 3
# All users specified with the `--user` option must be able to access SplatNet 3
nxapi presence-server --user 0123456789abcdef --splatnet3
# Allow returning presence data for all users at `/api/presence`
nxapi presence-server --user 0123456789abcdef --allow-all-users
# Set the update interval to 5 minutes (300 seconds)
nxapi presence-server --user 0123456789abcdef --update-interval 300
```
```sh
# Fetch all available presence data using curl (requires the `--allow-all-users` option)
curl http://[::1]:12345/api/presence
# Fetch presence data for a specific user using curl
# Replace `0123456789abcdef` with the user's NSA ID
curl http://[::1]:12345/api/presence/0123456789abcdef
# Fetch presence data for a specific user including Splatoon 3 presence using curl
curl http://[::1]:12345/api/presence/0123456789abcdef?include-splatoon3=1
# Watch for presence events
curl --no-buffer http://[::1]:12345/api/presence/0123456789abcdef/events
curl --no-buffer http://[::1]:12345/api/presence/0123456789abcdef/events?include-splatoon3=1
```
Example EventStream use:
```ts
const events = new EventSource('https://[::1]:12345/api/presence/0123456789abcdef/events');
events.addEventListener('close', event => {
console.error('Event stream closed', event);
// Handle reconnecting to the server...
});
events.addEventListener('friend', event => {
const data = JSON.parse(event.data);
console.log('Received Coral presence data', data.presence);
});
```
Misc. commands/options
---