Skip to content

Steam Stats

Showcase your Steam gaming statistics on GitHub profiles with automated cards

Steam Stats is a GitHub Action that fetches your Steam user data and generates PNG cards for embedding in your profile README. It supports:

  • Steam User Summary (profile info, account status)
  • Recently Played Games (last two weeks’ playtime and artwork)
  • Steam Workshop Overview (total subscribers, favorites, visitors)

What It Creates

Steam User Summary Card

A clean card displaying your Steam username, avatar, profile status and more.

Recently Played Games Card

A grid of your most recently played titles over the last two weeks, with playtime statistics and game logo.

Steam Workshop Card (Optional)

Display aggregated totals for all your Steam Workshop items: subscribers, favorites and unique visitors.

Key Features

  • Docker-powered container for reliable execution
  • Native GitHub Actions integration for automated updates
  • High-quality PNG output for seamless README embedding
  • Official Steam Web API for user data and recent games
  • Web scraping for Workshop statistics not exposed by the API
  • Configurable schedule via GitHub Actions cron or manual trigger

Quick Start

  1. Obtain your Steam Web API key from the Steam developer site.
  2. Store your Steam API key, Steam ID and Steam Custom ID in GitHub Repo Secrets and Variables respectively.
  3. Add a workflow file named .github/workflows/steam-stats.yml to your repo with: 
    name: Steam Stats
on:
workflow_dispatch:
schedule:
    # Runs every Monday at 12 AM IST (UTC+5:30)
    - cron: "30 18 * * 0"
jobs:
steam-stats:
    name: Steam Stats
    runs-on: ubuntu-latest
    steps:
    - name: Steam Stats
        uses: nicconike/steam-stats@master
        with:
        STEAM_API_KEY: ${{ secrets.STEAM_API_KEY }}
        STEAM_ID: ${{ vars.STEAM_ID }}
        STEAM_CUSTOM_ID: ${{ vars.STEAM_CUSTOM_ID }}
        WORKSHOP_STATS: True # Optional
        LOG_SCALE: True # Optional
  4. In your README.md file, add these comment pairs where you want the cards inserted:
    1. Steam Stats 
      <!-- Steam-Stats start -->
<!-- Steam-Stats end -->
    2. Steam Workshop Stats (Optional) 
      <!-- Steam-Workshop start -->
<!-- Steam-Workshop end -->

Output Examples & Preview

Here’s a sample of what gets generated:

  • Steam Profile Summary

    Steam Summary Card

  • Recently Played Games (Linear / Log Scale)

    Recently Played Games

  • Steam Workshop Stats (Optional)

    Steam Workshop Stats

Why Steam Stats

Steam Stats makes it easy to display your gaming statistics alongside your coding projects. It requires minimal setup, handles errors and rate limits automatically, and keeps your profile up to date with fresh data.

Next Steps

  • Setup Guide: setup.md
  • Getting Started: getting-started/index.md
  • User Guide: user-guide/index.md
  • Examples: examples/index.md
  • Contributing: developer-guide/contributing.md

Built by a Gamer who codes (sometimes ). Star the project on GitHub if you find it useful!