Steam Stats📶

Automated GitHub Action and Docker container to generate Steam user stats cards for your profile README.

From one Passionate Gamer to Another 🍻

Badges

Workflow Status

Code Quality & Coverage

Packaging & Deployment

Environments

Documentation & Repo

License & Security

Time Tracking

📚 Complete Documentation

Sample Output

Steam Stats Cards

Steam Workshop Stats (Optional)

Quick Start

1. Get your Steam Web API Key
2. Get your Steam ID and Custom ID
3. Save them as GitHub Secrets & GitHub Variables in your profile repository
4. Add to your workflow:

name: Steam Stats

on:
  push:
    branches: [master]
  workflow_dispatch:
  schedule:
    # Runs every Monday at 12AM IST (UTC+5:30)
    - cron: "30 18 * * 0"

jobs:
  steam-stats:
    name: Steam Stats
    runs-on: ubuntu-latest
    steps:
      - uses: nicconike/steam-stats@master
        with:
          STEAM_API_KEY: ${{ secrets.STEAM_API_KEY }} # Steam API key env var
          STEAM_ID: ${{ vars.STEAM_ID }} # Steam ID env var
          STEAM_CUSTOM_ID: ${{ vars.STEAM_CUSTOM_ID }} # Custom ID env var
          WORKSHOP_STATS: True # Optional
          LOG_SCALE: True # Optional

5. Add markdown comments to your README for Steam Stats

   <!-- Steam-Stats start -->
   <!-- Steam-Stats end -->

6. Add these markdown comments for Steam Workshop Stats (Optional)

   <!-- Steam-Workshop start -->
   <!-- Steam-Workshop end -->

Full Setup Guide

Features

Feature	Description
🎮 Player Summary	Steam profile stats
🕹️ Recently Played Games	Last 2 weeks activity
🛠️ Workshop Stats	Unique visitors & subscribers
🐳 Docker Support	Containerized execution
⚡ Automated Updates	Scheduled via GitHub Actions

View All Features & Configuration

Documentation

Section	Description
🚀 Getting Started	Setup Guide
⚙️ Configuration	Feature Flags & Options
🛠️ Troubleshooting	Common Issues
🤝 Contributing	Developer Guide
📚 API Reference	Python Code

Support 💙

Star ⭐ this project if you find it useful!

For detailed support options: Support & Contributing Guide

---

📖 Full Documentation • 🐛 Report Issues • 💬 Discussions