โ† Back to plugins index

๐Ÿฆ‘ Splatoon

This plugin displays your Splatoon 3 recent matches based on data fetched from Splatnet.

โš ๏ธ Disclaimer

This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Nintendo or Splatoon. All product and company names are trademarksโ„ข or registeredยฎ trademarks of their respective holders.

This specific plugin is licensed under GPL-3.0 rather than MIT to comply with spacemeowx2/s3si.ts license.

Note that Nintendo Switch Online web tokens usage are not explicitly allowed by Nintendo, use at your own risk.

Authors@lowlighter
Supported features
โ†’ Full specification		 ๐Ÿ“— Classic template
๐Ÿ‘ค Users ๐Ÿ‘ฅ Organizations
๐Ÿ—๏ธ plugin_splatoon_token ๐Ÿ—๏ธ plugin_splatoon_statink_token
## โžก๏ธ Available options
OptionDescription

plugin_splatoon

Enable splatoon plugin
type: boolean
default: no

plugin_splatoon_token

Splatnet token
๐Ÿ” Token
๐ŸŒ Web instances must configure settings.json:
  • metrics.api.nintendo.splatnet
type: token

plugin_splatoon_sections

Displayed sections

  • player for overall player recap
  • versus for Turf war and Anarchy battle matches
  • salmon-run for Salmon run next wave matches
type: array (comma-separated)
default: player, versus, salmon-run

plugin_splatoon_versus_limit

Display limit (Versus)
type: number (0 โ‰ค ๐‘ฅ โ‰ค 6)
default: 1

plugin_splatoon_salmon_limit

Display limit (Salmon run)
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
๐ŸŒ Web instances must configure settings.json:
  • metrics.api.statink
type: boolean
default: no

plugin_splatoon_statink_token

stat.ink token
๐Ÿ” Token
type: token

plugin_splatoon_source

Source

  • splatnet will fetch data from Splatnet using spacemeowx2/s3si.ts tool
  • local will assume s3si/export directory already exists and is populated (use this when developping new features for this plugin to save network resources and time)
  • mocks will use s3si/mocks directory (use this when developping new features for this plugin to avoid setting up a NSO token)
โฏ๏ธ Cannot be preset
๐Ÿ”ง For development
type: string
default: splatnet
allowed values:
  • splatnet
  • local
  • mocks
## ๐Ÿ—๏ธ 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 ``` ![Script](/.github/readme/imgs/plugin_splatoon_script.png) ![Authentication](/.github/readme/imgs/plugin_splatoon_auth.png) ## ๐Ÿ™ [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: ![stat.ink](/.github/readme/imgs/plugin_splatoon_statink.png) ## ๐Ÿ‘จโ€๐Ÿ’ป 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: NOT_NEEDED 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: NOT_NEEDED 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; } ```