Update pinned gist / profile README to contain your Steam playtime leaderboard.
English | ็ฎไฝไธญๆ
๐โจ For more pinned-gist projects like this one, check out: https://github.com/matchai/awesome-pinned-gists
if only want's to update a markdown,like profile README,skip step 1 and step 2.
-
Create a new public GitHub Gist (https://gist.github.com/)
-
Create a token with the
gist
scope and copy it. (https://github.com/settings/tokens/new) -
Create a Steam API key. (https://steamcommunity.com/dev/apikey)
-
Find the steam ID (steamID64) of your account. (https://steamid.io)
-
For updating a markdown file, add comments to the place where you want to update in the markdown file.
<!-- steam-box start -->
๐ฎ Dyson Sphere Program ๐ 379 hrs 19 mins
๐ป Wallpaper Engine ๐ 147 hrs 56 mins
๐ฎ ๅ้ - Variables ๐ 119 hrs 29 mins
๐ฎ Sid Meier's Civilization VI ๐ 92 hrs 9 mins
๐ฎ Bloons TD 6 ๐ 68 hrs 36 mins
### ๐ Project setup
1. Fork this repo
1. Edit the [environment variable](https://github.com/YouEclipse/steam-box/actions/runs/126970182/workflow#L17-L19) in `.github/workflows/schedule.yml`:
> For updating github profile README, you can follow [steam-box.yml](https://github.com/YouEclipse/YouEclipse/blob/master/.github/workflows/steam-box.yml) in [YouEclipse](https://github.com/YouEclipse/YouEclipse) to create a Action in your README repo. Remember it's unsafe to use token with **`repo`** scope for updating the repo, steam-box update the profile repo using git command in Github Action instead of using github API.
- **GIST_ID:** The ID portion from your gist url: `https://gist.github.com/YouEclipse/`**`9bc7025496e478f439b9cd43eba989a4`**.
1. Go to the repo **Settings > Secrets**
1. Add the following environment variables:
- **GH_TOKEN:** The GitHub token generated above.
- **STEAM_API_KEY:** The steam API key you created above.
- **STEAM_ID:** The steam ID of your account.
1. 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/`
## ๐ต๏ธ How it works
- Get your games playtime from [Steamwork Web API](https://partner.steamgames.com/doc/webapi)
- Update Gist with Github API
- Use Github Actions for updating Gist
## ๐ License
This project is licensed under [Apache-2.0](./LICENSE)