ci: auto-regenerate files

This commit is contained in:
github-actions[bot]
2023-03-14 02:55:35 +00:00
parent 6b04b36038
commit ddf66d31a5
9 changed files with 403 additions and 28 deletions

View File

@@ -41,6 +41,7 @@
<th nowrap="nowrap" align="center" title="🗼 Rss feed">🗼</th>
<th nowrap="nowrap" align="center" title="⏰ WakaTime">⏰</th>
<th nowrap="nowrap" align="center" title="🗳️ Leetcode">🗳️</th>
<th nowrap="nowrap" align="center" title="🕹️ Steam">🕹️</th>
</tr>
<tr>
<td nowrap="nowrap">📗 Classic template</td>
@@ -82,6 +83,7 @@
<td nowrap="nowrap" align="center" data-plugin="rss">✔️</td>
<td nowrap="nowrap" align="center" data-plugin="wakatime">✔️</td>
<td nowrap="nowrap" align="center" data-plugin="leetcode">✔️</td>
<td nowrap="nowrap" align="center" data-plugin="steam">✔️</td>
</tr>
<tr>
<td nowrap="nowrap">📘 Repository template</td>
@@ -123,6 +125,7 @@
<td nowrap="nowrap" align="center" data-plugin="rss">✔️</td>
<td nowrap="nowrap" align="center" data-plugin="wakatime">❌</td>
<td nowrap="nowrap" align="center" data-plugin="leetcode">❌</td>
<td nowrap="nowrap" align="center" data-plugin="steam">❌</td>
</tr>
<tr>
<td nowrap="nowrap">📙 Terminal template</td>
@@ -164,6 +167,7 @@
<td nowrap="nowrap" align="center" data-plugin="rss">❌</td>
<td nowrap="nowrap" align="center" data-plugin="wakatime">❌</td>
<td nowrap="nowrap" align="center" data-plugin="leetcode">❌</td>
<td nowrap="nowrap" align="center" data-plugin="steam">❌</td>
</tr>
<tr>
<td nowrap="nowrap">📒 Markdown template</td>
@@ -205,9 +209,10 @@
<td nowrap="nowrap" align="center" data-plugin="rss">✔️</td>
<td nowrap="nowrap" align="center" data-plugin="wakatime">✓</td>
<td nowrap="nowrap" align="center" data-plugin="leetcode">✓</td>
<td nowrap="nowrap" align="center" data-plugin="steam">✓</td>
</tr>
<tr>
<td colspan="38"></td>
<td colspan="39"></td>
</tr>
<tr>
<th nowrap="nowrap">Mode/Plugin</th>
@@ -249,6 +254,7 @@
<th nowrap="nowrap" align="center" title="🗼 Rss feed">🗼</th>
<th nowrap="nowrap" align="center" title="⏰ WakaTime">⏰</th>
<th nowrap="nowrap" align="center" title="🗳️ Leetcode">🗳️</th>
<th nowrap="nowrap" align="center" title="🕹️ Steam">🕹️</th>
</tr>
<tr>
<td nowrap="nowrap">👤 User</td>
@@ -290,6 +296,7 @@
<td nowrap="nowrap" align="center" data-plugin="rss">✔️</td>
<td nowrap="nowrap" align="center" data-plugin="wakatime">✔️</td>
<td nowrap="nowrap" align="center" data-plugin="leetcode">✔️</td>
<td nowrap="nowrap" align="center" data-plugin="steam">✔️</td>
</tr>
<tr>
<td nowrap="nowrap">👥 Organization</td>
@@ -331,6 +338,7 @@
<td nowrap="nowrap" align="center" data-plugin="rss">✔️</td>
<td nowrap="nowrap" align="center" data-plugin="wakatime">❌</td>
<td nowrap="nowrap" align="center" data-plugin="leetcode">❌</td>
<td nowrap="nowrap" align="center" data-plugin="steam">✔️</td>
</tr>
<tr>
<td nowrap="nowrap">📓 Repository</td>
@@ -372,6 +380,7 @@
<td nowrap="nowrap" align="center" data-plugin="rss">✔️</td>
<td nowrap="nowrap" align="center" data-plugin="wakatime">❌</td>
<td nowrap="nowrap" align="center" data-plugin="leetcode">❌</td>
<td nowrap="nowrap" align="center" data-plugin="steam">❌</td>
</tr>
</table>

View File

@@ -19,7 +19,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
</tr>
<tr>
<th colspan="2" align="center">
<h3><a href="/README.md#-plugins">🧩 Customizable with 44 plugins and 314 options!</a></h3>
<h3><a href="/README.md#-plugins">🧩 Customizable with 46 plugins and 327 options!</a></h3>
</th>
</tr>
<tr>
@@ -303,62 +303,78 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
<img width="900" height="1" alt="">
</td>
</tr>
<tr>
<th><a href="source/plugins/steam/README.md">🕹️ Steam</a></th>
<th></th>
</tr>
<tr>
<td align="center">
<details open><summary>Recently played games</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.steam.svg" alt=""></img></details>
<details><summary>Profile and detailed game history</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.steam.full.svg" alt=""></img></details>
<img width="900" height="1" alt="">
</td>
<td align="center"><img width="900" height="1" alt=""></td>
</tr>
<tr>
<th colspan="2" align="center">
<a href="/source/plugins/community/README.md">🎲 See also community plugins</a>
</th>
</tr>
<tr>
<th><a href="source/plugins/community/16personalities/README.md">🧠 16personalities</a><br><sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup>
<details><summary>Render example</summary>
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.16personalities.svg" alt=""></img>
<img width="900" height="1" alt="">
</details>
</th>
<th><a href="source/plugins/community/chess/README.md">♟️ Chess</a><br><sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup>
<details><summary>Render example</summary>
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.chess.svg" alt=""></img>
<img width="900" height="1" alt="">
</details>
</th>
</tr>
<tr>
<th><a href="source/plugins/community/fortune/README.md">🥠 Fortune</a><br><sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup>
<details><summary>Render example</summary>
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.fortune.svg" alt=""></img>
<img width="900" height="1" alt="">
</details>
</th>
</tr>
<tr>
<th><a href="source/plugins/community/nightscout/README.md">💉 Nightscout</a><br><sup>by <a href="https://github.com/legoandmars">@legoandmars</a></sup>
<details><summary>Render example</summary>
<img alt="" width="400" src="https://github.com/legoandmars/legoandmars/blob/master/metrics.plugin.nightscout.svg" alt=""></img>
<img width="900" height="1" alt="">
</details>
</th>
</tr>
<tr>
<th><a href="source/plugins/community/poopmap/README.md">💩 PoopMap plugin</a><br><sup>by <a href="https://github.com/matievisthekat">@matievisthekat</a></sup>
<details><summary>Render example</summary>
<img alt="" width="400" src="https://github.com/matievisthekat/matievisthekat/blob/master/metrics.plugin.poopmap.svg" alt=""></img>
<img width="900" height="1" alt="">
</details>
</th>
</tr>
<tr>
<th><a href="source/plugins/community/screenshot/README.md">📸 Website screenshot</a><br><sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup>
<details><summary>Render example</summary>
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.screenshot.svg" alt=""></img>
<img width="900" height="1" alt="">
</details>
</th>
</tr>
<tr>
<th><a href="source/plugins/community/splatoon/README.md">🦑 Splatoon</a><br><sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup>
<details><summary>Render example</summary>
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.splatoon.svg" alt=""></img>
<img width="900" height="1" alt="">
</details>
</th>
</tr>
<tr>
<th><a href="source/plugins/community/stock/README.md">💹 Stock prices</a><br><sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup>
<details><summary>Render example</summary>
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stock.svg" alt=""></img>
<img width="900" height="1" alt="">
</details>
</th>
<th>
</th>
</tr>
<tr>
<th colspan="2" align="center">
@@ -515,11 +531,13 @@ Plugins provide additional content and lets you customize rendered metrics.
* [✒️ Recent posts <sub>`posts`</sub>](/source/plugins/posts/README.md)
* [🗼 Rss feed <sub>`rss`</sub>](/source/plugins/rss/README.md)
* [🗨️ Stack Overflow <sub>`stackoverflow`</sub>](/source/plugins/stackoverflow/README.md)
* [🕹️ Steam <sub>`steam`</sub>](/source/plugins/steam/README.md)
* [🐤 Latest tweets <sub>`tweets`</sub>](/source/plugins/tweets/README.md)
* [⏰ WakaTime <sub>`wakatime`</sub>](/source/plugins/wakatime/README.md)
**🎲 Maintained by community**
* **[Community plugins](/source/plugins/community/README.md)**
* [🧠 16personalities <sub>`16personalities`</sub>](/source/plugins/community/16personalities/README.md) by [@lowlighter](https://github.com/lowlighter)
* [♟️ Chess <sub>`chess`</sub>](/source/plugins/community/chess/README.md) by [@lowlighter](https://github.com/lowlighter)
* [🥠 Fortune <sub>`fortune`</sub>](/source/plugins/community/fortune/README.md) by [@lowlighter](https://github.com/lowlighter)
* [💉 Nightscout <sub>`nightscout`</sub>](/source/plugins/community/nightscout/README.md) by [@legoandmars](https://github.com/legoandmars)

57
action.yml generated
View File

@@ -1230,6 +1230,63 @@ inputs:
description: Display limit (recent)
default: <default-value>
# ====================================================================================
# 🕹️ Steam
plugin_steam:
description: Enable steam plugin
default: <default-value>
plugin_steam_token:
description: Steam token
default: <default-value>
plugin_steam_sections:
description: Displayed sections
default: <default-value>
plugin_steam_user:
description: Steam user id
plugin_steam_games_ignored:
description: Ignored games
default: <default-value>
plugin_steam_games_limit:
description: Display limit (Most played games)
default: <default-value>
plugin_steam_recent_games_limit:
description: Display limit (Recently played games)
default: <default-value>
plugin_steam_achievements_limit:
description: Display limit (Games achievements)
default: <default-value>
plugin_steam_playtime_threshold:
description: Display threshold (Game playtime in hours)
default: <default-value>
# ====================================================================================
# 🧠 16personalities
plugin_16personalities:
description: Enable 16personalities plugin
default: <default-value>
plugin_16personalities_url:
description: Profile URL
default: <default-value>
plugin_16personalities_sections:
description: Displayed sections
default: <default-value>
plugin_16personalities_scores:
description: Display traits scores
default: <default-value>
# ====================================================================================
# ♟️ Chess

7
settings.example.json generated
View File

@@ -180,6 +180,13 @@
"leetcode":{
"enabled": false, "//": "Enable leetcode plugin"
},
"steam":{
"token": "Steam token",
"enabled": false, "//": "Enable steam plugin"
},
"16personalities":{
"enabled": false, "//": "Enable 16personalities plugin"
},
"chess":{
"token": "Chess platform token",
"enabled": false, "//": "Enable chess plugin"

View File

@@ -44,11 +44,13 @@ Plugins provide additional content and lets you customize rendered metrics.
* [✒️ Recent posts <sub>`posts`</sub>](/source/plugins/posts/README.md)
* [🗼 Rss feed <sub>`rss`</sub>](/source/plugins/rss/README.md)
* [🗨️ Stack Overflow <sub>`stackoverflow`</sub>](/source/plugins/stackoverflow/README.md)
* [🕹️ Steam <sub>`steam`</sub>](/source/plugins/steam/README.md)
* [🐤 Latest tweets <sub>`tweets`</sub>](/source/plugins/tweets/README.md)
* [⏰ WakaTime <sub>`wakatime`</sub>](/source/plugins/wakatime/README.md)
**🎲 Maintained by community**
* **[Community plugins](/source/plugins/community/README.md)**
* [🧠 16personalities <sub>`16personalities`</sub>](/source/plugins/community/16personalities/README.md) by [@lowlighter](https://github.com/lowlighter)
* [♟️ Chess <sub>`chess`</sub>](/source/plugins/community/chess/README.md) by [@lowlighter](https://github.com/lowlighter)
* [🥠 Fortune <sub>`fortune`</sub>](/source/plugins/community/fortune/README.md) by [@lowlighter](https://github.com/lowlighter)
* [💉 Nightscout <sub>`nightscout`</sub>](/source/plugins/community/nightscout/README.md) by [@legoandmars](https://github.com/legoandmars)

View File

@@ -1,12 +1,113 @@
<!--header-->
<table>
<tr><td colspan="2"><a href="/README.md#-plugins">← Back to plugins index</a></td></tr>
<tr><th colspan="2"><h3>🧠 16personalities</h3></th></tr>
<tr><td colspan="2" align="center"><p>This plugin displays personality profile from a <a href="https://www.16personalities.com/profile">16personalities profile</a>.</p>
</td></tr>
<tr><th>⚠️ Disclaimer</th><td><p>This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with <a href="https://www.16personalities.com">16personalities</a>.
All product and company names are trademarks™ or registered® trademarks of their respective holders.</p>
</td></tr>
<tr><th>Authors</th><td><a href="https://github.com/lowlighter">@lowlighter</a></td></tr>
<tr>
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
<td><a href="/source/templates/classic/README.md"><code>📗 Classic template</code></a></td>
</tr>
<tr>
<td><code>👤 Users</code></td>
</tr>
<tr>
<td><i>No tokens are required for this plugin</i></td>
</tr>
<tr>
<td colspan="2" align="center">
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.16personalities.svg" alt=""></img>
<img width="900" height="1" alt="">
</td>
</tr>
</table>
<!--/header-->
## ➡️ Available options
<!--options-->
<table>
<tr>
<td align="center" nowrap="nowrap">Option</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_16personalities</code></h4></td>
<td rowspan="2"><p>Enable 16personalities plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
🌐 Web instances must configure <code>settings.json</code>:
<ul>
<li><i>metrics.run.puppeteer.scrapping</i></li>
</ul>
<b>type:</b> <code>boolean</code>
<br>
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_16personalities_url</code></h4></td>
<td rowspan="2"><p>Profile URL</p>
<p>This can be obtained after doing the <a href="https://www.16personalities.com/free-personality-test">test on 16personalities</a> and registering an email.
Login with the generated password received in your mailbox and copy the link that is displayed when sharing the profile.</p>
<img src="/.github/readme/imgs/plugin_16personalities_profile.png" width="800" />
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
<b>type:</b> <code>string</code>
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_16personalities_sections</code></h4></td>
<td rowspan="2"><p>Displayed sections</p>
<ul>
<li><code>personality</code> will display personality type</li>
<li><code>profile</code> will display role and strategy</li>
<li><code>traits</code> will display mind, energy, nature, tactics and identity traits</li>
</ul>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
<b>type:</b> <code>array</code>
<i>(comma-separated)</i>
<br>
<b>default:</b> personality<br>
<b>allowed values:</b><ul><li>personality</li><li>profile</li><li>traits</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_16personalities_scores</code></h4></td>
<td rowspan="2"><p>Display traits scores</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
<b>type:</b> <code>boolean</code>
<br>
<b>default:</b> yes<br></td>
</tr>
</table>
<!--/options-->
## Examples workflows
<!--examples-->
```yaml
name: MBTI Personality profile
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.16personalities.svg
token: ${{ secrets.METRICS_TOKEN }}
base: ""
plugin_16personalities: yes
plugin_16personalities_url: ${{ secrets.SIXTEEN_PERSONALITIES_URL }}
plugin_16personalities_sections: personality, traits
plugin_16personalities_scores: no
```
<!--/examples-->

View File

@@ -3,54 +3,57 @@
<tr><th colspan="2"><h3>🎲 Community plugins</h3></th></tr>
<tr><td colspan="2" align="center">Additional plugins maintained by community for even more features!</td></tr>
<tr>
<th><a href="/source/plugins/community/16personalities/README.md">🧠 16personalities</a><br><sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup></th>
<th><a href="/source/plugins/community/chess/README.md">♟️ Chess</a><br><sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup></th>
<th><a href="/source/plugins/community/fortune/README.md">🥠 Fortune</a><br><sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup></th>
</tr>
<tr>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.16personalities.svg" alt=""></img>
<img width="900" height="1" alt="">
</td>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.chess.svg" alt=""></img>
<img width="900" height="1" alt="">
</td>
</tr> <tr>
<th><a href="/source/plugins/community/fortune/README.md">🥠 Fortune</a><br><sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup></th>
<th><a href="/source/plugins/community/nightscout/README.md">💉 Nightscout</a><br><sup>by <a href="https://github.com/legoandmars">@legoandmars</a></sup></th>
</tr>
<tr>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.fortune.svg" alt=""></img>
<img width="900" height="1" alt="">
</td>
</tr> <tr>
<th><a href="/source/plugins/community/nightscout/README.md">💉 Nightscout</a><br><sup>by <a href="https://github.com/legoandmars">@legoandmars</a></sup></th>
<th><a href="/source/plugins/community/poopmap/README.md">💩 PoopMap plugin</a><br><sup>by <a href="https://github.com/matievisthekat">@matievisthekat</a></sup></th>
</tr>
<tr>
<td align="center">
<img alt="" width="400" src="https://github.com/legoandmars/legoandmars/blob/master/metrics.plugin.nightscout.svg" alt=""></img>
<img width="900" height="1" alt="">
</td>
</tr> <tr>
<th><a href="/source/plugins/community/poopmap/README.md">💩 PoopMap plugin</a><br><sup>by <a href="https://github.com/matievisthekat">@matievisthekat</a></sup></th>
<th><a href="/source/plugins/community/screenshot/README.md">📸 Website screenshot</a><br><sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup></th>
</tr>
<tr>
<td align="center">
<img alt="" width="400" src="https://github.com/matievisthekat/matievisthekat/blob/master/metrics.plugin.poopmap.svg" alt=""></img>
<img width="900" height="1" alt="">
</td>
</tr> <tr>
<th><a href="/source/plugins/community/screenshot/README.md">📸 Website screenshot</a><br><sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup></th>
<th><a href="/source/plugins/community/splatoon/README.md">🦑 Splatoon</a><br><sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup></th>
</tr>
<tr>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.screenshot.svg" alt=""></img>
<img width="900" height="1" alt="">
</td>
</tr> <tr>
<th><a href="/source/plugins/community/splatoon/README.md">🦑 Splatoon</a><br><sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup></th>
<th><a href="/source/plugins/community/stock/README.md">💹 Stock prices</a><br><sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup></th>
</tr>
<tr>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.splatoon.svg" alt=""></img>
<img width="900" height="1" alt="">
</td>
</tr> <tr>
<th><a href="/source/plugins/community/stock/README.md">💹 Stock prices</a><br><sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup></th>
<th></th>
</tr>
<tr>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stock.svg" alt=""></img>
<img width="900" height="1" alt="">
</td>
<td align="center"><img width="900" height="1" alt=""></td>
</tr>
</table>

View File

@@ -1,9 +1,161 @@
<!--header-->
<table>
<tr><td colspan="2"><a href="/README.md#-plugins">← Back to plugins index</a></td></tr>
<tr><th colspan="2"><h3>🕹️ Steam</h3></th></tr>
<tr><td colspan="2" align="center"><p>This plugin can display your player profile and played games from your Steam account.</p>
</td></tr>
<tr><th>⚠️ Disclaimer</th><td><p>This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with <a href="https://store.steampowered.com">Steam</a>.
All product and company names are trademarks™ or registered® trademarks of their respective holders.</p>
</td></tr>
<tr>
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
<td><a href="/source/templates/classic/README.md"><code>📗 Classic template</code></a></td>
</tr>
<tr>
<td><code>👤 Users</code> <code>👥 Organizations</code></td>
</tr>
<tr>
<td><code>🗝️ plugin_steam_token</code></td>
</tr>
<tr>
<td colspan="2" align="center">
<details open><summary>Recently played games</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.steam.svg" alt=""></img></details>
<details><summary>Profile and detailed game history</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.steam.full.svg" alt=""></img></details>
<img width="900" height="1" alt="">
</td>
</tr>
</table>
<!--/header-->
## ➡️ Available options
<!--options-->
<table>
<tr>
<td align="center" nowrap="nowrap">Option</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_steam</code></h4></td>
<td rowspan="2"><p>Enable steam plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
<b>type:</b> <code>boolean</code>
<br>
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_steam_token</code></h4></td>
<td rowspan="2"><p>Steam token</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🔐 Token<br>
✨ On <code>master</code>/<code>main</code><br>
🌐 Web instances must configure <code>settings.json</code>:
<ul>
<li><i>metrics.api.steam</i></li>
</ul>
<b>type:</b> <code>token</code>
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_steam_sections</code></h4></td>
<td rowspan="2"><p>Displayed sections</p>
<ul>
<li><code>player</code>: display profile</li>
<li><code>most-played</code>: display most played games</li>
<li><code>recently-played</code>: display recently played games</li>
</ul>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
<b>type:</b> <code>array</code>
<i>(comma-separated)</i>
<br>
<b>default:</b> player, most-played, recently-played<br></td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_steam_user</code></h4></td>
<td rowspan="2"><p>Steam user id</p>
<p>This can be found on your Steam user account details</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏯️ Cannot be preset<br>
✨ On <code>master</code>/<code>main</code><br>
<b>type:</b> <code>string</code>
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_steam_games_ignored</code></h4></td>
<td rowspan="2"><p>Ignored games</p>
<p>Use App id as they are referenced in Steam catalog</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
<b>type:</b> <code>array</code>
<i>(comma-separated)</i>
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_steam_games_limit</code></h4></td>
<td rowspan="2"><p>Display limit (Most played games)</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
<b>type:</b> <code>number</code>
<i>(0 ≤
𝑥)</i>
<br>
<b>zero behaviour:</b> disable</br>
<b>default:</b> 1<br></td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_steam_recent_games_limit</code></h4></td>
<td rowspan="2"><p>Display limit (Recently played games)</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
<b>type:</b> <code>number</code>
<i>(0 ≤
𝑥)</i>
<br>
<b>zero behaviour:</b> disable</br>
<b>default:</b> 1<br></td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_steam_achievements_limit</code></h4></td>
<td rowspan="2"><p>Display limit (Games achievements)</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
<b>type:</b> <code>number</code>
<i>(0 ≤
𝑥)</i>
<br>
<b>default:</b> 2<br></td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_steam_playtime_threshold</code></h4></td>
<td rowspan="2"><p>Display threshold (Game playtime in hours)</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
<b>type:</b> <code>number</code>
<i>(0 ≤
𝑥)</i>
<br>
<b>default:</b> 2<br></td>
</tr>
</table>
<!--/options-->
## 🗝️ Obtaining a *Steam Web API* token
@@ -19,4 +171,30 @@ To retrieve your Steam ID, access your user account on [store.steampowered.com/a
## Examples workflows
<!--examples-->
```yaml
name: Recently played games
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.steam.svg
token: NOT_NEEDED
base: ""
plugin_steam_token: ${{ secrets.STEAM_TOKEN }}
plugin_steam: yes
plugin_steam_user: 0
plugin_steam_sections: recently-played
plugin_steam_achievements_limit: 0
```
```yaml
name: Profile and detailed game history
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.steam.full.svg
token: NOT_NEEDED
base: ""
plugin_steam_token: ${{ secrets.STEAM_TOKEN }}
plugin_steam: yes
plugin_steam_user: 0
```
<!--/examples-->

View File

@@ -7,7 +7,7 @@ This is also the default template.</p>
</td></tr>
<tr>
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
<td><a href="/source/plugins/achievements/README.md" title="🏆 Achievements">🏆</a> <a href="/source/plugins/activity/README.md" title="📰 Recent activity">📰</a> <a href="/source/plugins/anilist/README.md" title="🌸 Anilist watch list and reading list">🌸</a> <a href="/source/plugins/calendar/README.md" title="📆 Commit calendar">📆</a> <a href="/source/plugins/code/README.md" title="♐ Random code snippet">♐</a> <a href="/source/plugins/chess/README.md" title="♟️ Chess">♟️</a> <a href="/source/plugins/fortune/README.md" title="🥠 Fortune">🥠</a> <a href="/source/plugins/nightscout/README.md" title="💉 Nightscout">💉</a> <a href="/source/plugins/poopmap/README.md" title="💩 PoopMap plugin">💩</a> <a href="/source/plugins/screenshot/README.md" title="📸 Website screenshot">📸</a> <a href="/source/plugins/splatoon/README.md" title="🦑 Splatoon">🦑</a> <a href="/source/plugins/stock/README.md" title="💹 Stock prices">💹</a> <a href="/source/plugins/discussions/README.md" title="💬 Discussions">💬</a> <a href="/source/plugins/followup/README.md" title="🎟️ Follow-up of issues and pull requests">🎟️</a> <a href="/source/plugins/gists/README.md" title="🎫 Gists">🎫</a> <a href="/source/plugins/habits/README.md" title="💡 Coding habits and activity">💡</a> <a href="/source/plugins/introduction/README.md" title="🙋 Introduction">🙋</a> <a href="/source/plugins/isocalendar/README.md" title="📅 Isometric commit calendar">📅</a> <a href="/source/plugins/languages/README.md" title="🈷️ Languages activity">🈷️</a> <a href="/source/plugins/leetcode/README.md" title="🗳️ Leetcode">🗳️</a> <a href="/source/plugins/lines/README.md" title="👨‍💻 Lines of code changed">👨‍💻</a> <a href="/source/plugins/music/README.md" title="🎼 Music activity and suggestions">🎼</a> <a href="/source/plugins/notable/README.md" title="🎩 Notable contributions">🎩</a> <a href="/source/plugins/pagespeed/README.md" title="⏱️ Google PageSpeed">⏱️</a> <a href="/source/plugins/people/README.md" title="🧑‍🤝‍🧑 People">🧑‍🤝‍🧑</a> <a href="/source/plugins/posts/README.md" title="✒️ Recent posts">✒️</a> <a href="/source/plugins/projects/README.md" title="🗂️ GitHub projects">🗂️</a> <a href="/source/plugins/reactions/README.md" title="🎭 Comment reactions">🎭</a> <a href="/source/plugins/repositories/README.md" title="📓 Featured repositories">📓</a> <a href="/source/plugins/rss/README.md" title="🗼 Rss feed">🗼</a> <a href="/source/plugins/skyline/README.md" title="🌇 GitHub Skyline">🌇</a> <a href="/source/plugins/sponsors/README.md" title="💕 GitHub Sponsors">💕</a> <a href="/source/plugins/sponsorships/README.md" title="💝 GitHub Sponsorships">💝</a> <a href="/source/plugins/stackoverflow/README.md" title="🗨️ Stack Overflow">🗨️</a> <a href="/source/plugins/stargazers/README.md" title="✨ Stargazers">✨</a> <a href="/source/plugins/starlists/README.md" title="💫 Star lists">💫</a> <a href="/source/plugins/stars/README.md" title="🌟 Recently starred repositories">🌟</a> <a href="/source/plugins/support/README.md" title="💭 GitHub Community Support">💭</a> <a href="/source/plugins/topics/README.md" title="📌 Starred topics">📌</a> <a href="/source/plugins/traffic/README.md" title="🧮 Repositories traffic">🧮</a> <a href="/source/plugins/tweets/README.md" title="🐤 Latest tweets">🐤</a> <a href="/source/plugins/wakatime/README.md" title="⏰ WakaTime">⏰</a></td>
<td><a href="/source/plugins/achievements/README.md" title="🏆 Achievements">🏆</a> <a href="/source/plugins/activity/README.md" title="📰 Recent activity">📰</a> <a href="/source/plugins/anilist/README.md" title="🌸 Anilist watch list and reading list">🌸</a> <a href="/source/plugins/calendar/README.md" title="📆 Commit calendar">📆</a> <a href="/source/plugins/code/README.md" title="♐ Random code snippet">♐</a> <a href="/source/plugins/16personalities/README.md" title="🧠 16personalities">🧠</a> <a href="/source/plugins/chess/README.md" title="♟️ Chess">♟️</a> <a href="/source/plugins/fortune/README.md" title="🥠 Fortune">🥠</a> <a href="/source/plugins/nightscout/README.md" title="💉 Nightscout">💉</a> <a href="/source/plugins/poopmap/README.md" title="💩 PoopMap plugin">💩</a> <a href="/source/plugins/screenshot/README.md" title="📸 Website screenshot">📸</a> <a href="/source/plugins/splatoon/README.md" title="🦑 Splatoon">🦑</a> <a href="/source/plugins/stock/README.md" title="💹 Stock prices">💹</a> <a href="/source/plugins/discussions/README.md" title="💬 Discussions">💬</a> <a href="/source/plugins/followup/README.md" title="🎟️ Follow-up of issues and pull requests">🎟️</a> <a href="/source/plugins/gists/README.md" title="🎫 Gists">🎫</a> <a href="/source/plugins/habits/README.md" title="💡 Coding habits and activity">💡</a> <a href="/source/plugins/introduction/README.md" title="🙋 Introduction">🙋</a> <a href="/source/plugins/isocalendar/README.md" title="📅 Isometric commit calendar">📅</a> <a href="/source/plugins/languages/README.md" title="🈷️ Languages activity">🈷️</a> <a href="/source/plugins/leetcode/README.md" title="🗳️ Leetcode">🗳️</a> <a href="/source/plugins/lines/README.md" title="👨‍💻 Lines of code changed">👨‍💻</a> <a href="/source/plugins/music/README.md" title="🎼 Music activity and suggestions">🎼</a> <a href="/source/plugins/notable/README.md" title="🎩 Notable contributions">🎩</a> <a href="/source/plugins/pagespeed/README.md" title="⏱️ Google PageSpeed">⏱️</a> <a href="/source/plugins/people/README.md" title="🧑‍🤝‍🧑 People">🧑‍🤝‍🧑</a> <a href="/source/plugins/posts/README.md" title="✒️ Recent posts">✒️</a> <a href="/source/plugins/projects/README.md" title="🗂️ GitHub projects">🗂️</a> <a href="/source/plugins/reactions/README.md" title="🎭 Comment reactions">🎭</a> <a href="/source/plugins/repositories/README.md" title="📓 Featured repositories">📓</a> <a href="/source/plugins/rss/README.md" title="🗼 Rss feed">🗼</a> <a href="/source/plugins/skyline/README.md" title="🌇 GitHub Skyline">🌇</a> <a href="/source/plugins/sponsors/README.md" title="💕 GitHub Sponsors">💕</a> <a href="/source/plugins/sponsorships/README.md" title="💝 GitHub Sponsorships">💝</a> <a href="/source/plugins/stackoverflow/README.md" title="🗨️ Stack Overflow">🗨️</a> <a href="/source/plugins/stargazers/README.md" title="✨ Stargazers">✨</a> <a href="/source/plugins/starlists/README.md" title="💫 Star lists">💫</a> <a href="/source/plugins/stars/README.md" title="🌟 Recently starred repositories">🌟</a> <a href="/source/plugins/steam/README.md" title="🕹️ Steam">🕹️</a> <a href="/source/plugins/support/README.md" title="💭 GitHub Community Support">💭</a> <a href="/source/plugins/topics/README.md" title="📌 Starred topics">📌</a> <a href="/source/plugins/traffic/README.md" title="🧮 Repositories traffic">🧮</a> <a href="/source/plugins/tweets/README.md" title="🐤 Latest tweets">🐤</a> <a href="/source/plugins/wakatime/README.md" title="⏰ WakaTime">⏰</a></td>
</tr>
<tr>
<td><code>👤 Users</code> <code>👥 Organizations</code></td>