diff --git a/.github/scripts/files/examples.yml b/.github/scripts/files/examples.yml index edc22267..6da9b359 100644 --- a/.github/scripts/files/examples.yml +++ b/.github/scripts/files/examples.yml @@ -18,6 +18,8 @@ on: required: true GOOGLE_MAP_TOKEN: required: true + SPLATOON_TOKEN: + required: true SPOTIFY_TOKENS: required: true STOCK_TOKEN: diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index aa1fa2e3..311cd88f 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -159,6 +159,7 @@ jobs: CHESS_TOKEN: ${{ secrets.CHESS_TOKEN }} PAGESPEED_TOKEN: ${{ secrets.PAGESPEED_TOKEN }} GOOGLE_MAP_TOKEN: ${{ secrets.GOOGLE_MAP_TOKEN }} + SPLATOON_TOKEN: ${{ secrets.SPLATOON_TOKEN }} SPOTIFY_TOKENS: ${{ secrets.SPOTIFY_TOKENS }} STOCK_TOKEN: ${{ secrets.STOCK_TOKEN }} TWITTER_TOKEN: ${{ secrets.TWITTER_TOKEN }} diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml index 81444044..064843a6 100644 --- a/.github/workflows/examples.yml +++ b/.github/workflows/examples.yml @@ -18,6 +18,8 @@ on: required: true GOOGLE_MAP_TOKEN: required: true + SPLATOON_TOKEN: + required: true SPOTIFY_TOKENS: required: true STOCK_TOKEN: @@ -1147,6 +1149,21 @@ jobs: user: lowlighter plugins_errors_fatal: yes if: ${{ success() || failure() }} + - name: ๐Ÿฆ‘ Splatoon - Example + uses: lowlighter/metrics@master + 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; } + output_action: none + delay: 120 + user: lowlighter + plugins_errors_fatal: yes + if: ${{ success() || failure() }} - name: ๐Ÿ’น Stock prices - Stock prices from Tesla uses: lowlighter/metrics@master with: diff --git a/README.md b/README.md index 4a6cdefd..1c2e7461 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile -

๐Ÿงฉ Customizable with 42 plugins and 302 options!

+

๐Ÿงฉ Customizable with 43 plugins and 307 options!

@@ -465,6 +465,7 @@ Plugins provide additional content and lets you customize rendered metrics. * [๐Ÿ’‰ Nightscout `nightscout`](/source/plugins/community/nightscout/README.md) by [@legoandmars](https://github.com/legoandmars) * [๐Ÿ’ฉ PoopMap plugin `poopmap`](/source/plugins/community/poopmap/README.md) by [@matievisthekat](https://github.com/matievisthekat) * [๐Ÿ“ธ Website screenshot `screenshot`](/source/plugins/community/screenshot/README.md) by [@lowlighter](https://github.com/lowlighter) + * [๐Ÿฆ‘ Splatoon `splatoon`](/source/plugins/community/splatoon/README.md) by [@lowlighter](https://github.com/lowlighter) * [๐Ÿ’น Stock prices `stock`](/source/plugins/community/stock/README.md) by [@lowlighter](https://github.com/lowlighter) diff --git a/action.yml b/action.yml index 36fd9650..1ca69945 100644 --- a/action.yml +++ b/action.yml @@ -1322,6 +1322,29 @@ inputs: description: Background default: + # ==================================================================================== + # ๐Ÿฆ‘ Splatoon + + plugin_splatoon: + description: Enable splatoon plugin + default: + + plugin_splatoon_token: + description: Splatnet token + default: + + plugin_splatoon_modes: + description: Displayed modes + default: + + plugin_splatoon_versus_limit: + description: Display limit (Versus) + default: + + plugin_splatoon_salmon_limit: + description: Display limit (Salmon run) + default: + # ==================================================================================== # ๐Ÿ’น Stock prices diff --git a/settings.example.json b/settings.example.json index ffdc7de2..678fa1c0 100644 --- a/settings.example.json +++ b/settings.example.json @@ -194,6 +194,10 @@ "screenshot":{ "enabled": false, "//": "Enable screenshot plugin" }, + "splatoon":{ + "token": "Splatnet token", + "enabled": false, "//": "Enable splatoon plugin" + }, "stock":{ "token": "Yahoo Finance token", "enabled": false, "//": "Enable stock plugin" diff --git a/source/plugins/README.md b/source/plugins/README.md index 3f53daac..b28547e2 100644 --- a/source/plugins/README.md +++ b/source/plugins/README.md @@ -53,5 +53,6 @@ Plugins provide additional content and lets you customize rendered metrics. * [๐Ÿ’‰ Nightscout `nightscout`](/source/plugins/community/nightscout/README.md) by [@legoandmars](https://github.com/legoandmars) * [๐Ÿ’ฉ PoopMap plugin `poopmap`](/source/plugins/community/poopmap/README.md) by [@matievisthekat](https://github.com/matievisthekat) * [๐Ÿ“ธ Website screenshot `screenshot`](/source/plugins/community/screenshot/README.md) by [@lowlighter](https://github.com/lowlighter) + * [๐Ÿฆ‘ Splatoon `splatoon`](/source/plugins/community/splatoon/README.md) by [@lowlighter](https://github.com/lowlighter) * [๐Ÿ’น Stock prices `stock`](/source/plugins/community/stock/README.md) by [@lowlighter](https://github.com/lowlighter) diff --git a/source/plugins/community/README.md b/source/plugins/community/README.md index 66774ba5..4a5f780f 100644 --- a/source/plugins/community/README.md +++ b/source/plugins/community/README.md @@ -30,17 +30,27 @@ ๐Ÿ“ธ Website screenshot - ๐Ÿ’น Stock prices + ๐Ÿฆ‘ Splatoon + + + + + + ๐Ÿ’น Stock prices + + + + diff --git a/source/plugins/community/splatoon/README.md b/source/plugins/community/splatoon/README.md index a2b51550..059eeaed 100644 --- a/source/plugins/community/splatoon/README.md +++ b/source/plugins/community/splatoon/README.md @@ -1,9 +1,108 @@ + + + + + + + + + + + + + + + + + + + +
โ† 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionDescription

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 @@ -22,4 +121,17 @@ deno run --allow-run=deno --allow-read=profile.json --allow-write=profile.json - ## โ„น๏ธ Examples workflows +```yaml +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; } + +``` diff --git a/source/plugins/community/splatoon/examples.yml b/source/plugins/community/splatoon/examples.yml index 8f05968f..9307ac2c 100644 --- a/source/plugins/community/splatoon/examples.yml +++ b/source/plugins/community/splatoon/examples.yml @@ -6,7 +6,7 @@ base: "" plugin_splatoon: yes plugin_splatoon_token: ${{ secrets.SPLATOON_TOKEN }} + extras_css: | + h2 { display: none !important; } test: skip: true - prod: - skip: true diff --git a/source/templates/classic/README.md b/source/templates/classic/README.md index 26976fee..1b07964c 100644 --- a/source/templates/classic/README.md +++ b/source/templates/classic/README.md @@ -7,7 +7,7 @@ This is also the default template.

Supported features
โ†’ Full specification - ๐Ÿ† ๐Ÿ“ฐ ๐ŸŒธ ๐Ÿ“† โ™ โ™Ÿ๏ธ ๐Ÿฅ  ๐Ÿ’‰ ๐Ÿ’ฉ ๐Ÿ“ธ ๐Ÿ’น ๐Ÿ’ฌ ๐ŸŽŸ๏ธ ๐ŸŽซ ๐Ÿ’ก ๐Ÿ™‹ ๐Ÿ“… ๐Ÿˆท๏ธ ๐Ÿ—ณ๏ธ ๐Ÿ‘จโ€๐Ÿ’ป ๐ŸŽผ ๐ŸŽฉ โฑ๏ธ ๐Ÿง‘โ€๐Ÿคโ€๐Ÿง‘ โœ’๏ธ ๐Ÿ—‚๏ธ ๐ŸŽญ ๐Ÿ““ ๐Ÿ—ผ ๐ŸŒ‡ ๐Ÿ’• ๐Ÿ—จ๏ธ โœจ ๐Ÿ’ซ ๐ŸŒŸ ๐Ÿ’ญ ๐Ÿ“Œ ๐Ÿงฎ ๐Ÿค โฐ + ๐Ÿ† ๐Ÿ“ฐ ๐ŸŒธ ๐Ÿ“† โ™ โ™Ÿ๏ธ ๐Ÿฅ  ๐Ÿ’‰ ๐Ÿ’ฉ ๐Ÿ“ธ ๐Ÿฆ‘ ๐Ÿ’น ๐Ÿ’ฌ ๐ŸŽŸ๏ธ ๐ŸŽซ ๐Ÿ’ก ๐Ÿ™‹ ๐Ÿ“… ๐Ÿˆท๏ธ ๐Ÿ—ณ๏ธ ๐Ÿ‘จโ€๐Ÿ’ป ๐ŸŽผ ๐ŸŽฉ โฑ๏ธ ๐Ÿง‘โ€๐Ÿคโ€๐Ÿง‘ โœ’๏ธ ๐Ÿ—‚๏ธ ๐ŸŽญ ๐Ÿ““ ๐Ÿ—ผ ๐ŸŒ‡ ๐Ÿ’• ๐Ÿ—จ๏ธ โœจ ๐Ÿ’ซ ๐ŸŒŸ ๐Ÿ’ญ ๐Ÿ“Œ ๐Ÿงฎ ๐Ÿค โฐ ๐Ÿ‘ค Users ๐Ÿ‘ฅ Organizations diff --git a/tests/cases/splatoon.plugin.yml b/tests/cases/splatoon.plugin.yml new file mode 100644 index 00000000..fe51488c --- /dev/null +++ b/tests/cases/splatoon.plugin.yml @@ -0,0 +1 @@ +[] diff --git a/tests/secrets.json b/tests/secrets.json index 9ac41063..e251769e 100644 --- a/tests/secrets.json +++ b/tests/secrets.json @@ -12,5 +12,6 @@ "GOOGLE_MAP_TOKEN": "MOCKED_TOKEN", "STOCK_TOKEN":"MOCKED_TOKEN", "CHESS_TOKEN":"MOCKED_TOKEN", + "SPLATOON_TOKEN":"{}", "POOPMAP_TOKEN":"MOCKED_TOKEN" } \ No newline at end of file