steam-box
Automatically update your GitHub profile README or pinned gist with a Steam playtime leaderboard using GitHub Actions.
What is steam-box?
Steam-box is a GitHub Action that automatically updates your GitHub profile README or pinned gist with a leaderboard of your Steam game playtimes. It fetches data from the Steam API and displays your most-played games, allowing you to showcase your gaming activity directly on your GitHub profile.
Developers and gamers who use GitHub and want to display their Steam gaming statistics on their profile for personalization or community engagement.
It provides an automated, customizable way to integrate gaming data into GitHub profiles using secure, token-based authentication and flexible display options through GitHub Actions.
Overview
🎮 Update profile README / pinned gist to contain your Steam playtime leaderboard. 在你的 profile README / pinned gist 上显示你的 steam 游玩时间排行榜。
Use Cases
Best For
- Adding personalized gaming stats to your GitHub profile README
- Automatically updating a pinned gist with Steam playtime leaderboards
- Showcasing your most-played Steam games to visitors of your GitHub profile
- Integrating Steam API data with GitHub workflows
- Creating dynamic, auto-updating content for developer profiles
- Experimenting with GitHub Actions for personal automation projects
Not Ideal For
- Users with private Steam profiles or restricted API access
- Projects requiring real-time data updates or instant sync
- Developers using platforms other than GitHub, like GitLab or personal sites
- Teams needing collaborative gaming stats or in-depth analytics
Pros & Cons
Pros
Leverages GitHub Actions to regularly fetch and update Steam playtime data without manual intervention, as highlighted in the automated updates feature and workflow setup.
Supports updating both pinned GitHub Gists and profile README markdown files, allowing users to choose their preferred format, based on the flexible display options described.
Uses GitHub Secrets to securely store Steam API keys and tokens, preventing exposure in code, as emphasized in the secure token handling section.
Allows specifying which Steam games to display using the APP_ID environment variable, enabling focused leaderboards, as per the customizable game list feature.
Cons
Requires multiple steps like creating a Gist, generating tokens, obtaining a Steam API key, and finding Steam ID, which can be cumbersome, as detailed in the prep work and project setup.
Tied exclusively to GitHub and Steam; cannot be used with other version control platforms or gaming services, limiting versatility and portability.
Relies on Steam API availability and rate limits, with potential breaking changes that could disrupt functionality without maintainer updates, a risk inherent in the integration.
Frequently Asked Questions
Related Projects
waka-box📊 Update a pinned gist to contain your weekly WakaTime stats
bird-box🐦💬 Update a gist to contain your latest tweet
waka-box-go📊 Update profile README / pinned gist to contain your weekly WakaTime stats. This is a Golang implementation, see the original version https://github.com/matchai/waka-box. 将你的 WakaTime 每周语言使用统计显示在 profile README / pined gist。
spotify-box🎶 Automatic update pinned gist to show your recent Spotify top tracks.
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.