Skip to content

A dynamic, customisable, real-time Steam is playing widget that seamlessly integrates with your website or GitHub markdown file!

License

Notifications You must be signed in to change notification settings

KinhoLeung/Steam-Readme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Steam-Readme

This project is designed to provide a dynamic display of a user's Steam gaming status for their GitHub personal profile. It allows others to see what games the user has been playing recently.

Previews

Default

/

Preview

Dark Theme

?theme=dark

Preview

Deployment

Note

This will take approximately 5 minutes to set up.

0. Star This Repo (Mandatory) 🌟

  • Yes, this step is required.

1. Fork This Repo 🍴

2.Get Steam's ID And API Key 🎮

  • STEAM_ID

  • STEAM_API_KEY

img

img

img

img

image-20241002202712773

image-20241002130213271

3. Deploy Projects To Vercel 🛠️

  • Remember to add environment variables(STEAM_ID and STEAM_API_KEY)

4. Add To Your Github Readme🚀

<div align="center">
  <a href="https://github.com/KinhoLeung/Steam-Readme">
    <picture>
      <source media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)" srcset="https://steam-readme.vercel.app?theme=light" />
      <source media="(prefers-color-scheme: dark)" srcset="https://steam-readme.vercel.app?theme=dark" />
      <img alt="Current Spotify Song" src="https://steam-readme.vercel.app?theme=light" /> 
    </picture>
  </a>
</div>

Note

This project is inspired by the Spotify-Readme, if you want to do secondary development, you can check the steam web api at this URL.

About

A dynamic, customisable, real-time Steam is playing widget that seamlessly integrates with your website or GitHub markdown file!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published