Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 2.87 KB

README_zh.md

File metadata and controls

63 lines (42 loc) · 2.87 KB
Raw

steam-box

将你的 steam 游玩时间显示在 profile README/pinned gist.

Update gist with Steam Playtime

English | 简体中文

📌✨ 查看更多像这样的 Pinned Gist 项目,传送门: https://github.com/matchai/awesome-pinned-gists

💻 安装

🎒 前置工作

  1. 创建一个公开的 GitHub Gist (https://gist.github.com/)

  2. 创建一个拥有 gist 权限的 token 并复制. (https://github.com/settings/tokens/new)

  3. 创建你的 Steam API key. (https://steamcommunity.com/dev/apikey)

  4. 找到你的账号的 64 位 ID. (https://steamid.io)

  5. 如果需要更新到某个 markdown 文件(比如profile README)，请在对应文件需要更新的地方添加以下注释

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

🚀 开始安装

  1. Fork 这个仓库

  2. 编辑 .github/workflows/schedule.yml 中的环境变量 :

    如果是需要更新 github profile README,可以在 profile README 的仓库中创建 Action，具体配置参考 我的 YouEclipse 中的 steam-box.yml.因为使用 repo 权限的token 来通过 API 更新仓库，可能会不安全，所以我的示例中使用 git 命令来更新，这样更加安全。

    • GIST_ID: ID 是 gist url 的后缀 : https://gist.github.com/YouEclipse/9bc7025496e478f439b9cd43eba989a4.

  3. 前往 fork 后的仓库的 Settings > Secrets

  4. 添加以下环境变量:

    • GH_TOKEN: 前置工作中生成的 github token.
    • STEAM_API_KEY: 前置工作中创建的 steam API key.
    • STEAM_ID: 你的 steam 64 位 ID.

  5. 如果你想展示某几个指定的游戏,可以把他们的 ID 设置在环境变量 APP_ID：

  • 如 APP_ID=431960,730
  • 你可以在对应游戏的 steam 商店的 url 获取到游戏 id: https://store.steampowered.com/app/730/CounterStrike_Global_Offensive/

🕵️ 工作原理

  • 基于 Steam API 获取游戏的游玩时间
  • 基于 Github API 更新 Gist
  • 使用 Github Actions 自动更新 Gist

📄 开源协议

本项目使用 Apache-2.0 协议