| Option | Description |
plugin_splatoon
|
Enable splatoon plugin
![]() |
✨ On master/main
type: boolean
default: no
|
plugin_splatoon_token
|
Splatnet token
![]() |
🔐 Token
✨ On master/main
🌐 Web instances must configure settings.json:
- metrics.api.nintendo.splatnet
type: token
|
plugin_splatoon_modes
|
Displayed modes
![]() |
✨ On master/main
type: array
(comma-separated)
default: turf-war, splat-zones, tower-control, rainmaker, clam-blitz, salmon-run
|
plugin_splatoon_versus_limit
|
Display limit (Versus)
![]() |
✨ On master/main
type: number
(0 ≤
𝑥
≤ 6)
default: 1
|
plugin_splatoon_salmon_limit
|
Display limit (Salmon run)
![]() |
✨ On master/main
type: number
(0 ≤
𝑥
≤ 6)
default: 1
|
plugin_splatoon_statink
|
stat.ink integration
If set, fetched data will also be uploaded to stat.ink
Requires plugin_splatoon_statink_token to be set
![]() |
✨ On master/main
🌐 Web instances must configure settings.json:
type: boolean
default: no
|
plugin_splatoon_statink_token
|
stat.ink token
![]() |
🔐 Token
✨ On master/main
type: token
|
## 🗝️ Obtaining a *Nintendo Switch Online* token
The helper script is intended to be run by [deno runtime](https://deno.land/). Either [install it locally](https://deno.land/manual/getting_started/installation) or use its [docker image](https://hub.docker.com/r/denoland/deno).
Run the following command in your terminal and follow instructions:
```bash
deno run --allow-run=deno --allow-read=profile.json --allow-write=profile.json --unstable https://raw.githubusercontent.com/lowlighter/metrics/master/source/plugins/community/splatoon/token.ts
```
## 🐙 [stat.ink](https://stat.ink) integration
It is possible to make this plugin automatically export fetched games to [stat.ink](https://stat.ink) by adding the following:
```yaml
plugin_splatoon_statink: yes
plugin_splatoon_statink_token: ${{ secrets.SPLATOON_STATINK_TOKEN }}
```
[stat.ink](https://stat.ink) API key can be found on user profile:
## 👨💻 About
Data are fetched using [spacemeowx2/s3si.ts](https://github.com/spacemeowx2/s3si.ts) tool (which is itself based on [frozenpandaman/s3s](https://github.com/frozenpandaman/s3s)).
## ℹ️ Examples workflows
```yaml
name: Splatnet data
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.splatoon.svg
token: ${{ secrets.METRICS_TOKEN }}
base: ""
plugin_splatoon: yes
plugin_splatoon_token: ${{ secrets.SPLATOON_TOKEN }}
```
```yaml
name: Splatnet data with stat.ink integration
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.splatoon.svg
token: ${{ secrets.METRICS_TOKEN }}
base: ""
plugin_splatoon: yes
plugin_splatoon_token: ${{ secrets.SPLATOON_TOKEN }}
plugin_splatoon_statink: yes
plugin_splatoon_statink_token: ${{ secrets.SPLATOON_STATINK_TOKEN }}
extras_css: |
h2 { display: none !important; }
```
