← 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
type: boolean
default: no

plugin_steam_token

Steam token
🔐 Token
🌐 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
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
type: string

plugin_steam_games_ignored

Ignored games

Use App id as they are referenced in Steam catalog
type: array (comma-separated)

plugin_steam_games_limit

Display limit (Most played games)
type: number (0 ≤ 𝑥)
zero behaviour: disable
default: 1

plugin_steam_recent_games_limit

Display limit (Recently played games)
type: number (0 ≤ 𝑥)
zero behaviour: disable
default: 1

plugin_steam_achievements_limit

Display limit (Games achievements)
type: number (0 ≤ 𝑥)
default: 2

plugin_steam_playtime_threshold

Display threshold (Game playtime in hours)
type: number (0 ≤ 𝑥)
default: 2
## 🗝️ Obtaining a *Steam Web API* token Go to [steamcommunity.com/dev/apikey](https://steamcommunity.com/dev/apikey) to obtain a Steam Web API token: ![Token](/.github/readme/imgs/plugin_steam_webtoken.png) To retrieve your Steam ID, access your user account on [store.steampowered.com/account](https://store.steampowered.com/account) and copy the identifier located behind the header: ![User ID](/.github/readme/imgs/plugin_steam_userid.png) ## ℹ️ 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" ```