diff --git a/.github/readme/partials/documentation/compatibility.md b/.github/readme/partials/documentation/compatibility.md index 3923c6c5..da009dfa 100644 --- a/.github/readme/partials/documentation/compatibility.md +++ b/.github/readme/partials/documentation/compatibility.md @@ -41,6 +41,7 @@ ๐Ÿ—ผ โฐ ๐Ÿ—ณ๏ธ + ๐Ÿ•น๏ธ ๐Ÿ“— Classic template @@ -82,6 +83,7 @@ โœ”๏ธ โœ”๏ธ โœ”๏ธ + โœ”๏ธ ๐Ÿ“˜ Repository template @@ -123,6 +125,7 @@ โœ”๏ธ โŒ โŒ + โŒ ๐Ÿ“™ Terminal template @@ -164,6 +167,7 @@ โŒ โŒ โŒ + โŒ ๐Ÿ“’ Markdown template @@ -205,9 +209,10 @@ โœ”๏ธ โœ“ โœ“ + โœ“ - + Mode/Plugin @@ -249,6 +254,7 @@ ๐Ÿ—ผ โฐ ๐Ÿ—ณ๏ธ + ๐Ÿ•น๏ธ ๐Ÿ‘ค User @@ -290,6 +296,7 @@ โœ”๏ธ โœ”๏ธ โœ”๏ธ + โœ”๏ธ ๐Ÿ‘ฅ Organization @@ -331,6 +338,7 @@ โœ”๏ธ โŒ โŒ + โœ”๏ธ ๐Ÿ““ Repository @@ -372,6 +380,7 @@ โœ”๏ธ โŒ โŒ + โŒ diff --git a/README.md b/README.md index 74b6e71c..d68554e4 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile -

๐Ÿงฉ Customizable with 44 plugins and 314 options!

+

๐Ÿงฉ Customizable with 46 plugins and 327 options!

@@ -303,62 +303,78 @@ Generate metrics that can be embedded everywhere, including your GitHub profile + + ๐Ÿ•น๏ธ Steam + + + + +
Recently played games
+
Profile and detailed game history
+ + + + ๐ŸŽฒ See also community plugins + ๐Ÿง  16personalities
by @lowlighter +
Render example + + +
+ โ™Ÿ๏ธ Chess
by @lowlighter
Render example
+ + ๐Ÿฅ  Fortune
by @lowlighter
Render example
- - ๐Ÿ’‰ Nightscout
by @legoandmars
Render example
+ + ๐Ÿ’ฉ PoopMap plugin
by @matievisthekat
Render example
- - ๐Ÿ“ธ Website screenshot
by @lowlighter
Render example
+ + ๐Ÿฆ‘ Splatoon
by @lowlighter
Render example
- - ๐Ÿ’น Stock prices
by @lowlighter
Render example
- - @@ -515,11 +531,13 @@ Plugins provide additional content and lets you customize rendered metrics. * [โœ’๏ธ Recent posts `posts`](/source/plugins/posts/README.md) * [๐Ÿ—ผ Rss feed `rss`](/source/plugins/rss/README.md) * [๐Ÿ—จ๏ธ Stack Overflow `stackoverflow`](/source/plugins/stackoverflow/README.md) + * [๐Ÿ•น๏ธ Steam `steam`](/source/plugins/steam/README.md) * [๐Ÿค Latest tweets `tweets`](/source/plugins/tweets/README.md) * [โฐ WakaTime `wakatime`](/source/plugins/wakatime/README.md) **๐ŸŽฒ Maintained by community** * **[Community plugins](/source/plugins/community/README.md)** + * [๐Ÿง  16personalities `16personalities`](/source/plugins/community/16personalities/README.md) by [@lowlighter](https://github.com/lowlighter) * [โ™Ÿ๏ธ Chess `chess`](/source/plugins/community/chess/README.md) by [@lowlighter](https://github.com/lowlighter) * [๐Ÿฅ  Fortune `fortune`](/source/plugins/community/fortune/README.md) by [@lowlighter](https://github.com/lowlighter) * [๐Ÿ’‰ Nightscout `nightscout`](/source/plugins/community/nightscout/README.md) by [@legoandmars](https://github.com/legoandmars) diff --git a/action.yml b/action.yml index 64976d20..7026ff9b 100644 --- a/action.yml +++ b/action.yml @@ -1230,6 +1230,63 @@ inputs: description: Display limit (recent) default: + # ==================================================================================== + # ๐Ÿ•น๏ธ Steam + + plugin_steam: + description: Enable steam plugin + default: + + plugin_steam_token: + description: Steam token + default: + + plugin_steam_sections: + description: Displayed sections + default: + + plugin_steam_user: + description: Steam user id + + plugin_steam_games_ignored: + description: Ignored games + default: + + plugin_steam_games_limit: + description: Display limit (Most played games) + default: + + plugin_steam_recent_games_limit: + description: Display limit (Recently played games) + default: + + plugin_steam_achievements_limit: + description: Display limit (Games achievements) + default: + + plugin_steam_playtime_threshold: + description: Display threshold (Game playtime in hours) + default: + + # ==================================================================================== + # ๐Ÿง  16personalities + + plugin_16personalities: + description: Enable 16personalities plugin + default: + + plugin_16personalities_url: + description: Profile URL + default: + + plugin_16personalities_sections: + description: Displayed sections + default: + + plugin_16personalities_scores: + description: Display traits scores + default: + # ==================================================================================== # โ™Ÿ๏ธ Chess diff --git a/settings.example.json b/settings.example.json index b106ec69..c329ef14 100644 --- a/settings.example.json +++ b/settings.example.json @@ -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" diff --git a/source/plugins/README.md b/source/plugins/README.md index e34fa9b4..d7b7345d 100644 --- a/source/plugins/README.md +++ b/source/plugins/README.md @@ -44,11 +44,13 @@ Plugins provide additional content and lets you customize rendered metrics. * [โœ’๏ธ Recent posts `posts`](/source/plugins/posts/README.md) * [๐Ÿ—ผ Rss feed `rss`](/source/plugins/rss/README.md) * [๐Ÿ—จ๏ธ Stack Overflow `stackoverflow`](/source/plugins/stackoverflow/README.md) + * [๐Ÿ•น๏ธ Steam `steam`](/source/plugins/steam/README.md) * [๐Ÿค Latest tweets `tweets`](/source/plugins/tweets/README.md) * [โฐ WakaTime `wakatime`](/source/plugins/wakatime/README.md) **๐ŸŽฒ Maintained by community** * **[Community plugins](/source/plugins/community/README.md)** + * [๐Ÿง  16personalities `16personalities`](/source/plugins/community/16personalities/README.md) by [@lowlighter](https://github.com/lowlighter) * [โ™Ÿ๏ธ Chess `chess`](/source/plugins/community/chess/README.md) by [@lowlighter](https://github.com/lowlighter) * [๐Ÿฅ  Fortune `fortune`](/source/plugins/community/fortune/README.md) by [@lowlighter](https://github.com/lowlighter) * [๐Ÿ’‰ Nightscout `nightscout`](/source/plugins/community/nightscout/README.md) by [@legoandmars](https://github.com/legoandmars) diff --git a/source/plugins/community/16personalities/README.md b/source/plugins/community/16personalities/README.md index 3eff2a87..734953cc 100644 --- a/source/plugins/community/16personalities/README.md +++ b/source/plugins/community/16personalities/README.md @@ -1,12 +1,113 @@ + + + + + + + + + + + + + + + + + + + +
โ† Back to plugins index

๐Ÿง  16personalities

This plugin displays personality profile from a 16personalities profile.

+
โš ๏ธ Disclaimer

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

+
Authors@lowlighter
Supported features
โ†’ Full specification		๐Ÿ“— Classic template
๐Ÿ‘ค Users
No tokens are required for this plugin
+ + +
## โžก๏ธ Available options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionDescription

plugin_16personalities

Enable 16personalities plugin

+
โœจ On master/main
+๐ŸŒ Web instances must configure settings.json: +
    +
  • metrics.run.puppeteer.scrapping
    • +
+type: boolean +
+default: no

plugin_16personalities_url

Profile URL

+

This can be obtained after doing the test on 16personalities and registering an email. +Login with the generated password received in your mailbox and copy the link that is displayed when sharing the profile.

+ +
โœจ On master/main
+type: string +

plugin_16personalities_sections

Displayed sections

+
    +
  • personality will display personality type
    • +
  • profile will display role and strategy
    • +
  • traits will display mind, energy, nature, tactics and identity traits
    • +
+
โœจ On master/main
+type: array +(comma-separated) +
+default: personality
+allowed values:
  • personality
  • profile
  • traits

plugin_16personalities_scores

Display traits scores

+
โœจ On master/main
+type: boolean +
+default: yes
## โ„น๏ธ Examples workflows +```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 + +``` diff --git a/source/plugins/community/README.md b/source/plugins/community/README.md index 50a48e1c..8c64563e 100644 --- a/source/plugins/community/README.md +++ b/source/plugins/community/README.md @@ -3,54 +3,57 @@

๐ŸŽฒ Community plugins

Additional plugins maintained by community for even more features! + ๐Ÿง  16personalities
by @lowlighter โ™Ÿ๏ธ Chess
by @lowlighter - ๐Ÿฅ  Fortune
by @lowlighter + + + + + + ๐Ÿฅ  Fortune
by @lowlighter + ๐Ÿ’‰ Nightscout
by @legoandmars + + - - ๐Ÿ’‰ Nightscout
by @legoandmars - ๐Ÿ’ฉ PoopMap plugin
by @matievisthekat - - + + ๐Ÿ’ฉ PoopMap plugin
by @matievisthekat + ๐Ÿ“ธ Website screenshot
by @lowlighter + + - - ๐Ÿ“ธ Website screenshot
by @lowlighter - ๐Ÿฆ‘ Splatoon
by @lowlighter - - + + ๐Ÿฆ‘ Splatoon
by @lowlighter + ๐Ÿ’น Stock prices
by @lowlighter + + - - ๐Ÿ’น Stock prices
by @lowlighter - - - - diff --git a/source/plugins/steam/README.md b/source/plugins/steam/README.md index 8d720a2a..a2c5fec7 100644 --- a/source/plugins/steam/README.md +++ b/source/plugins/steam/README.md @@ -1,9 +1,161 @@ + + + + + + + + + + + + + + + + + + +
โ† Back to plugins index

๐Ÿ•น๏ธ Steam

This plugin can display your player profile and played games from your Steam account.

+
โš ๏ธ Disclaimer

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

+
Supported features
โ†’ Full specification		๐Ÿ“— Classic template
๐Ÿ‘ค Users ๐Ÿ‘ฅ Organizations
๐Ÿ—๏ธ plugin_steam_token
+
Recently played games
+
Profile and detailed game history
+ +
## โžก๏ธ Available options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionDescription

plugin_steam

Enable steam plugin

+
โœจ On master/main
+type: boolean +
+default: no

plugin_steam_token

Steam token

+
๐Ÿ” Token
+โœจ On master/main
+๐ŸŒ Web instances must configure settings.json: +
    +
  • metrics.api.steam
    • +
+type: token +

plugin_steam_sections

Displayed sections

+
    +
  • player: display profile
    • +
  • most-played: display most played games
    • +
  • recently-played: display recently played games
    • +
+
โœจ On master/main
+type: array +(comma-separated) +
+default: player, most-played, recently-played

plugin_steam_user

Steam user id

+

This can be found on your Steam user account details

+
โฏ๏ธ Cannot be preset
+โœจ On master/main
+type: string +

plugin_steam_games_ignored

Ignored games

+

Use App id as they are referenced in Steam catalog

+
โœจ On master/main
+type: array +(comma-separated) +

plugin_steam_games_limit

Display limit (Most played games)

+
โœจ On master/main
+type: number +(0 โ‰ค +๐‘ฅ) +
+zero behaviour: disable
+default: 1

plugin_steam_recent_games_limit

Display limit (Recently played games)

+
โœจ On master/main
+type: number +(0 โ‰ค +๐‘ฅ) +
+zero behaviour: disable
+default: 1

plugin_steam_achievements_limit

Display limit (Games achievements)

+
โœจ On master/main
+type: number +(0 โ‰ค +๐‘ฅ) +
+default: 2

plugin_steam_playtime_threshold

Display threshold (Game playtime in hours)

+
โœจ On master/main
+type: number +(0 โ‰ค +๐‘ฅ) +
+default: 2
## ๐Ÿ—๏ธ 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 +```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 + +``` diff --git a/source/templates/classic/README.md b/source/templates/classic/README.md index 23509ab1..c91562c8 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