Skip to content

Prerequisites

Nicco edited this page Jul 4, 2024 · 8 revisions

Wiki Page for the explanation of Prerequisites in a detailed manner


Table of Contents

  1. Steam Web API Key
  2. Markdown Comments
  3. Steam ID
  4. Steam Custom ID

Steam Web API Key

  • Open this link in a new browser tab.
  • You will see a webpage like below. Now click on the highlighted text as shown in the screenshot below. You can click on any one of the 3 highlighted ways to continue Steam Web API Key
  • By clicking on it you will be prompted to login to your steam account first. After logging in you see below page: Register Key
  • Write any text in domain name. For example, Steam Stats or Github Profile, etc
  • Agree to the Steam Web API Terms of Use and click on register.
  • If you have enabled Steam Guard Mobile Authenticator(which you should enable) then you will get a confirmation request for approval like below: Steam Guard Confirm API Creation
  • Copy the generated API key and save it in the GitHub Repo Secrets Repo Secrets

Markdown Comments

  • Steam User Stats - Add below comments in your readme file to get Steam Account Stats & Recently Played Games where you want the steam stats to be generated and embedded on
    <!-- Steam-Stats start -->
    <!-- Steam-Stats end -->
  • Steam Workshop Stats - Add below comments in your readme file to get Steam Workshop Stats from your Steam Account
    <!-- Steam-Workshop start -->
    <!-- Steam-Workshop end -->
  • Note: Steam Workshop Stats is a optional feature and you can ignore it if there is no content uploaded in your Steam Workshop

Steam ID

Well, there are multiple ways to get your steam ID and below is one from the many:

  • Go to your profile in the steam desktop client, you will be able to see the profile link and from this url you can take the steam id. But if you have set a custom ID then the URL would have been replaced by the custom name

  • If the above step didn't help you in getting the steam id, then follow this:

  • Go to your profile on top right and click on Account details

    Steam Profile

  • Now copy your Steam ID from the webpage as shown below

    Steam ID

  • Save it in your repo as Repository Variables

    Repo Variables


Steam Custom ID

  • If you have already set your custom ID or URL previously then you can get it directly from your steam profile URL
  • If not set yet, then go to your profile settings - General tab
  • Add a custom name as shown below in the screenshot. And this will be your Steam Custom ID as well Custom URL

Atmost it will take 5 mins to setup all the Prerequisites. Thank you for your patience!