https://github.com/mendhak/steam-github-profile-status

Set your Github profile status with the game currently being played on Steam. Available as Docker image, Github Action or script.
https://github.com/mendhak/steam-github-profile-status

Last synced: 8 months ago
JSON representation

Set your Github profile status with the game currently being played on Steam. Available as Docker image, Github Action or script.

• Host: GitHub
• URL: https://github.com/mendhak/steam-github-profile-status
• Owner: mendhak
• Created: 2022-06-26T11:52:41.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-11-26T18:36:39.000Z (over 3 years ago)
• Last Synced: 2025-09-06T17:52:32.059Z (9 months ago)
• Language: JavaScript
• Homepage: https://code.mendhak.com/steam-github-profile-status/
• Size: 178 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
This script will attempt to update your [Github user profile status](https://github.blog/changelog/2019-01-09-set-your-status/) with the game currently being played on Steam.  

* Your Steam Profile page must be set to public.  

* The status will be set to expire after 1 hour, and not marked as Busy.  This can be configured through environment variables.   

![screenshot](screenshot.png)

## How to use

To use this script, you'll first need to generate a [Github Access Token](https://github.com/settings/tokens) with the `user` scope.  

You'll also need to know your [Steam ID](https://steamid.io/lookup/76561197984170060) — not the username, but the SteamID64 value.  

### Run it as a Github Action

You can consider running it [on a Github Action schedule](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule).  

      - name: Set My Github Status From Steam

        uses: mendhak/steam-github-profile-status@v1.1

        env:

          STEAM_USER_ID: "YOUR_STEAM_USER_ID"

          GITHUB_ACCESS_TOKEN: "${{ secrets.MY_GITHUB_ACCESS_TOKEN }}"

Where `MY_GITHUB_ACCESS_TOKEN` is an Actions Secret in your repository, and it contains the Github Access Token value generated above. 

### Run it in a Docker container

To run it in a Docker container:

    docker run --rm -e GITHUB_ACCESS_TOKEN=xxxxxxxxxxxxxxxxx -e STEAM_USER_ID=76561197984170060 mendhak/steam-github-profile-status:latest

### Run it standalone

To run it as a standalone NodeJS script:

    export STEAM_USER_ID=76561197984170060

    export GITHUB_ACCESS_TOKEN=xxxxxxxxxxxxxxxxx

    node index.js

### Additional variables

You can choose whether you are shown as busy or not by passing a `GITHUB_STATUS_SHOW_BUSY=True` environment variable.

You can set the status expiry time in hours by passing a `GITHUB_STATUS_EXPIRES_AFTER=3` environment variable.