Code Monkey home page Code Monkey logo

gist_steambox's Introduction

steam-box

Update pinned gist / profile README to contain your Steam playtime leaderboard.

Update gist with Steam Playtime


English | 简体中文

📌✨ For more pinned-gist projects like this one, check out: https://github.com/matchai/awesome-pinned-gists

💻 Setup

🎒 Prep work

if only want's to update a markdown,like profile README,skip step 1 and step 2.

  1. Create a new public GitHub Gist (https://gist.github.com/)
  2. Create a token with the gist scope and copy it. (https://github.com/settings/tokens/new)
  3. Create a Steam API key. (https://steamcommunity.com/dev/apikey)
  4. Find the steam ID (steamID64) of your account. (https://steamid.io)
  5. For updating a markdown file,add comments to the place where you want to update in the markdown file.
     <!-- steam-box start -->
     <!-- steam-box end -->
     

🚀 Project setup

  1. Fork this repo
  2. Edit the environment variable in .github/workflows/schedule.yml:

For updating github profile README,you can follow steam-box.yml in 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
  2. 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.
  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/

🕵️ How it works

  • Get your games playtime from Steamwork Web API
  • Update Gist with Github API
  • Use Github Actions for updating Gist

📄 License

This project is licensed under Apache-2.0

gist_steambox's People

Contributors

youeclipse avatar zalbani avatar sciencepal avatar keanu73 avatar siner308 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.