metrics/source/plugins/community/splatoon/README.md

← 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

➡️ Available options

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

🗝️ Obtaining a Nintendo Switch Online token

The helper script is intended to be run by deno runtime. Either install it locally or use its docker image.

Run the following command in your terminal and follow instructions:

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 integration

It is possible to make this plugin automatically export fetched games to stat.ink by adding the following:

plugin_splatoon_statink: yes
plugin_splatoon_statink_token: ${{ secrets.SPLATOON_STATINK_TOKEN }}

stat.ink API key can be found on user profile:

👨‍💻 About

Data are fetched using spacemeowx2/s3si.ts tool (which is itself based on frozenpandaman/s3s).

ℹ️ Examples workflows

name: Example
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.splatoon.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ""
  plugin_splatoon: yes
  plugin_splatoon_token: ${{ secrets.SPLATOON_TOKEN }}
  extras_css: |
    h2 { display: none !important; }