Steam Box for readme

A little fork of steam-box to help you update your readme file with Steam playtime leaderboard and Steam recent played games.
Report a bug or request a feature

Table of Contents

• Installation
  • Preparation work
  • Project setup
• Example
• Contributing
• License

---

Installation

Preparation work

1. Create a Steam API key. (https://steamcommunity.com/dev/apikey)
2. Find the steam ID (steamID64) of your account. (https://steamid.io)
3. Add comments to the place where you want to update in your markdown file.

You can add your most played games leaderboard with:

 <!-- steam-box-playtime start -->
 <!-- steam-box-playtime end -->

And you can add your recent played games leaderboard with:

 <!-- steam-box-recent start -->
 <!-- steam-box-recent end -->

Project setup

For updating your github profile README, you can follow steam-box.yml to create a GitHub Action in your README repository.

1. Go to the repo Settings > Secrets
2. Add the following environment variables:
   • STEAM_API_KEY: The steam API key you created above.
   • STEAM_ID: The steam ID of your account.
3. If you want to show specific games,put the ids in environmet variable APP_ID:
   • like APP_ID=431960,730
   • you can get the id of a game from the store url: https://store.steampowered.com/app/730/CounterStrike_Global_Offensive/

Example

Here is an example from my own profile that you could obtain:

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature)
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the Apache-2.0 License. See LICENSE for more information.