Skip to content

Latest commit

 

History

History
211 lines (193 loc) · 7.42 KB

README.md

File metadata and controls

211 lines (193 loc) · 7.42 KB
Raw
← 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. 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

Script

Authentication

🐙 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:

stat.ink

👨‍💻 About

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

ℹ️ Examples workflows

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 }}

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; }