Skip to content

Latest commit

 

History

History
524 lines (359 loc) · 23.3 KB

README.md

File metadata and controls

524 lines (359 loc) · 23.3 KB
Raw

Steam App ID Finder

Steam Banner

This project is a collection of utilities that can be used to find Steam App IDs from a variety of sources.

Choose from one of the modes described in this section to find the Steam App IDs from the source you are interested in.

Table of contents

Setup

Run npm install to install the required dependencies first.

Following this, create a config.json file in the config directory of the project and fill it with your desired configuration. Use the default configuration file (config.<mode>.default.json) for the mode in which you wish to run the utility as a template if you wish.

Usage

After providing the config.json configuration file and any additional input files if required by the mode, you can run the script using

node index.js

Output

All modes will save their respective output in the output/<mode> folder. You can find additional information about the output of each mode in the respective section below.

Configuration

The different modes have different requirements when it comes to the kind of input they require, and each mode gives you different options to configure the script's behaviour. For each mode, a default configuration is provided in the config.<mode>.default.json file, which you can use as a template for your own configuration file.

Schema validation

The project provides an extensive JSON validation schema, which can help you with formatting your input and give you an idea of the options you have.

The schema can be found in the config.schema.json file and used within your config.json by adding the following property:

"$schema": "config.schema.json"

NOTE: The script will always test your provided config.json against this schema, so make sure your configuration is valid. By adding the schema to your config.json, you will receive information about mistakes in the configuration.

Properties

The following is a list of all configuration items that are required no matter which mode you choose.

If any given property is not present in the configuration file, it will automatically be assumed to have a value of false (or equivalent, depending on the property type).

mode

The mode in which the script should run. Choose from any of the supported modes listed in the sections below.

Type Default value Possible values Required
string gameNames gameNames, steamAccount Yes

Modes

You can choose from any of the following modes when running the script:

  • gameNames: Do you have a list of game names and want to know which Steam App IDs they correspond to? This mode is able to find the Steam App IDs for any number of provided game names, even if the provided name is not an exact match to the game in the Steam database.
  • steamAccount: This mode will fetch all apps (this includes games, but also e.g. soundtracks or movies) from a given Steam account and save them to a file. Make sure that the account's game library is public, otherwise the script will not be able to access it.
  • gogAccount: With this mode, you can get the names for all games in your GOG account. You can then use this output as input for the gameNames mode to find the Steam App IDs for the games.
  • epicGamesAccount: This mode enables you to get a list of all games you have ever purchased (excluding those that are refunded) on the Epic Games Store - including the weekly free game giveaways. You can then use this output as input for the gameNames mode to find the Steam App IDs for the games.

Mode: gameNames

Do you have a list of game names and want to know which Steam App IDs they correspond to? This mode is able to find the Steam App IDs for any number of provided game names, even if the provided name is not an exact match to the game in the Steam database.

When running the script in the gameNames mode, it will find the Steam App IDs for all game names provided in the specified input file, starting with those that have an exact match in the Steam database. If no exact match is found, the script will match the resulting game names to the Steam App ID of the game with the highest similarity score.

Note that the script will always find a match, even if the provided game name is not on Steam. You can correct the number of false positives this may produce by providing a partialMatchThreshold in the configuration file. Through testing, I found that a threshold of 0.65 finds almost all correct matches (i.e. games with a lower score are probably not on Steam) without too much clutter, but you can adjust this depending on your list of games.

Output

You will find the resulting data in the created output/gameNames folder.

For games with a single full match, the results will be saved in a file called steamAppIds_fullMatches.json, with the games' names as keys and their corresponding Steam App IDs as values.

For games with multiple full matches, the results will be saved in a file called steamAppIds_multipleFullMatches.json, with the games' names as keys and an array of the corresponding Steam App IDs as values. You can use tools such as steamDB to find out which of the found Steam App IDs is the correct one for your game.

For partial matches, the results will be saved in a file called steamAppIds_partialMatches.json, with the games' names as keys and the name and Steam App ID of the most similar game name as well as the similarity score as value.

Games for which no satisfying match was found (due to the similarity score being below the partialMatchThreshold) will be saved in a file called steamAppIds_noMatch.json for your convenience.

Find some examples of the output format for a partial match below:

Examples

{
  "Fallout Tactics: Brotherhood of Steel": {
    "appId": 38420,
    "similarity": 0.5777777777777777,
    "steamName": "Fallout Tactics"
  },
}

In this case, the matched game was correct, but this is not always the case:

{
  "DEATH STRANDING": {
    "appId": 1507790,
    "similarity": 0.6666666666666666,
    "steamName": "Witch Strandings"
  },
}

Such a mismatch can have a number of reasons, in the case of DEATH STRANDING it is that Steam only has DEATH STRANDING DIRECTOR'S CUT in its database, but not the original game, which leads to Witch Strandings being the closest match.

These examples also show well how a higher similarity score does not necessarily mean a better match.

Matches with a similarity score of 1

It is possible for a game to have a partial match with a similarity score of 1. This can happen as the search for full matches is case-sensitive, but the search for partial matches is not, meaning that the following two game names would not be considered a full match, but their similarity score would be 1:

  • My Time at Portia
  • My Time At Portia

Configuration: gameNames

Properties

The following is a list of all configuration items, their defaults and the values they can take.

inputFile

The file to read the game names from.

Type Default value Possible values Required
object See item below See sections below Yes 
"inputFile": {
  "fileName": "gameNames",
  "fileType": "txt",
  "delimiter": ","
}

Possible values

fileName

The name of the file to read the game names from.

Note: Do not provide the file's type/extension here.

Type Default value Possible values Required
string gameNames Any valid file name Yes

fileType

The file type of the input file. Choose from any of the supported file types listed.

Type Default value Possible values Required
string txt txt, csv Yes

delimiter

The delimiter to use when parsing the input file.

Type Default value Possible values Required
string , Any valid delimiter Yes, if the file type requires it (txt, csv)
onlyFullMatches

Whether to only get Steam App IDs for full matches or also for partial matches. If set to false, partial matches will be saved to a different output file.

Type Default value Possible values Required
boolean false true, false No
partialMatchThreshold

The threshold for partial matches. This means that the most similar game name must have a similarity score of at least this threshold to be added to the output. The threshold must be between 0 and 1. Use 0 to get a match for every game and 1 to only get full matches. If the value is omitted, a match will be found for every game.

Type Default value Possible values Required
number 0.8 Number between 0 and 1 No

Mode: steamAccount

This mode will fetch all apps (this includes games, but also e.g. soundtracks or movies) from a given Steam account and save them to a file. Make sure that the account's game library is public, otherwise the script will not be able to access it.

You can check if the game library for a given accountName is public by logging out of Steam (or opening a private browsing session) and visiting this link: https://steamcommunity.com/id/accountName/games

To set your game library to public, visit this link while logged in: https://steamcommunity.com/my/edit/settings

Output

You will find the resulting data in the created output/gameNames folder in a file named after your Steam account name.

Configuration: steamAccount

Properties

The following is a list of all configuration items, their defaults and the values they can take.

steamAccount

The name or ID of the Steam account for which the App IDs should be fetched. Your account's game library must be set to public for the script to work. Check via this link: https://steamcommunity.com/id/accountName/games or this link: https://steamcommunity.com/profiles/accountName/games while not logged in.

Type Default value Possible values Required
string accountName A valid Steam account name or ID Yes
outputProperties

Which of the properties provided by the Steam API should be included in the resulting JSON object. Properties that are not available for an app will be omitted in the output.

Type Default value Possible values Required
object See item below See sections below Yes, and at least one property defined 
{
	"appId": true,
	"name": true,
	"logo": false,
	"storeLink": false,
	"statsLink": false,
	"globalStatsLink": false
}

outputProperties

You can choose any combination (at least one) of the following properties to be included in the output file:

appID

The App ID of the game.

Type Default value Possible values Required
boolean true true, false No
name

The name of the game.

Type Default value Possible values Required
boolean true true, false No
logo

The URL to the game's logo.

Type Default value Possible values Required
boolean false true, false No
storeLink

The URL to the game's store page.

Type Default value Possible values Required
boolean false true, false No
statsLink

The URL to this users stats page for this game.

Type Default value Possible values Required
boolean false true, false No
globalStatsLink

The URL to the global stats page for this game.

Type Default value Possible values Required
boolean false true, false No

Mode: gogAccount

With this mode, you can get the names for all games in your GOG account. You can then use this output as input for the gameNames mode to find the Steam App IDs for the games.

Unfortunately, due to limitations of the GOG API, setup for this mode is a bit more complicated than for the other modes:

Setup

Start setting up as usual by creating a config.json file in the config folder with the mode set to gogAccount.

If you are using this mode for the first time, you will need to log in to your GOG account using this link to the official GOG login page, with a custom response type.

After logging in, you will be redirected to a blank page with a URL that looks something like this:

https://embed.gog.com/on_login_success?origin=client&code=1234567890abcdef

Copy the value of the code parameter from this URL and set it as the value of the gogLoginCode property in the config.json file. This allows the script to generate an access token for your GOG account, which authenticates you for the GOG API.

After setting the gogLoginCode property, run the script immediately - the login code is only valid for 60 seconds, after which it will expire and you would need to log in again.

After running the script once, you will find a file named gogRefreshToken.json in the output/gogAccount folder. This file contains the refresh token for your GOG account, which allows the script to generate a new access token when the current one expires. To run the script with this refresh token in use, set it as the value of the gogRefreshToken property in the config.json file. You can then remove the gogLoginCode property from the config.json file.

Output

You will find the list of games in your GOG account in the output/gogAccount folder as a .txt file named gogGameNames.txt. You can use this file as input for the gameNames mode to find the Steam App IDs for the games. To do this, simply set the following as the value of the inputFile property in the config.json file, along with the other configuration options:

"inputFile": {
	"fileName": "output/gogAccount/gogGameNames.txt",
	"fileType": "txt",
	"delimiter": "\n"
}

The script will also save the current refresh token to the gogRefreshToken.json file in the output/gogAccount folder. You can use this token to avoid needing to log in again when using the script in the (near) future.

Configuration: gogAccount

Properties

The following is a list of all configuration items, their defaults and the values they can take.

gogLoginCode

The code you received after logging in. Be fast, this code is only valid for one minute. If you don't start the script within that time, it will not be able to generate an access token from it. If a refresh token is also provided, this option is ignored.

Type Default value Possible values Required
string "gogLoginCodeHereIfAvailable" A valid login code for your account Yes, if no gogRefreshToken is provided
gogRefreshToken

If you have used the script before and have a refresh token, enter it here to avoid having to log in again to generate a login code. After running the script, the refresh token will be saved to output/gogAccount/gogRefreshToken.txt. You can then use it here to avoid having to log in again.

Type Default value Possible values Required
string "gogRefreshTokenHereIfAvailable" A valid refresh token for your account Yes, if no gogLoginCode is provided

Mode: epicGamesAccount

It is possible that running the tool in this mode will not work due to Epic Games running an additional security check (captcha) when trying to access the purchase history. If you encounter this issue, please use the workaround provided below.

This mode enables you to get a list of all games you have ever purchased (excluding those that are refunded) on the Epic Games Store - including the weekly free game giveaways. You can then use this output as input for the gameNames mode to find the Steam App IDs for the games.

Unfortunately, due to Epic Games not providing a dedicated public API for this, the setup for this mode is a bit more complicated than for the other modes:

Setup

Start setting up as usual by creating a config.json file in the config folder with the mode set to epicGamesAccount.

You will see that you only need to provide one additional configuration item: epicGamesCookie. As mentioned before, Epic Games does not provide a public API for getting a list of games owned by a user (as e.g. Steam does), so we need to use a workaround to get this information.

To allow the script to access your account's purchase history, you need to provide it with a cookie (EPIC_BEARER_TOKEN) that allows temporary access to your account purchase history. You can get this cookie by following the steps below:

  1. Open the following page in your browser: https://www.epicgames.com/account/transactions, logging in if necessary.
  2. Open the cookie-popup of the page, in browsers such as Google Chrome or Microsoft Edge this can be done by clicking the lock icon in the address bar.
  3. Find the following cookie (under epicgames.com->Cookies): EPIC_BEARER_TOKEN. This token will be valid for 8 hours, after which you will need to repeat the steps above to get a new cookie.
  4. Copy the value (Content) of this cookie and set the following as the value of the epicGamesCookie property in the config.json file:
"epicGamesCookie": "EPIC_BEARER_TOKEN=<yourCopiedCookieContent>"

You can now run the script as usual to get a list of all games that are present in the Epic Games purchase history of your account. It is possible that the number of game names you get from this utility is shorter than the amount of games you see in your library, as items such as beta branches and DLCs are sometimes not included in the purchase history.

Output

You will find the list of games in your Epic Games purchase history in the output/epicGamesAccount folder as a .txt file named epicGamesGameNames.txt. You can use this file as input for the gameNames mode to find the Steam App IDs for the games. To do this, simply set the following as the value of the inputFile property in the config.json file, along with the other configuration options:

"inputFile": {
	"fileName": "output/epicGamesAccount/epicGamesGameNames.txt",
	"fileType": "txt",
	"delimiter": "\n"
}

Workaround if the tool throws an error

If the tool throws an error when trying to fetch games from your Epic Games account, it is possible that the tool's access to your account is being blocked by an additional security check run by Epic Games. As a workaround, please follow the following steps to manually fetch a list of games from the browser:

  1. Log in to your account and go to https://www.epicgames.com/account/transactions.
  2. Open the developer console of your browser (usually by pressing F12 or Ctrl+Shift+I).
  3. Go to the Console tab of the console. This is usually the default tab when opening the developer view.
  4. Paste the following code snippet into the console and press Enter. This will fetch the list of purchased games from your account using the same method as the tool would.
const fetchGamesList = async (pageToken = '', existingList = []) => { 
  const data = await (await fetch(`https://www.epicgames.com/account/v2/payment/ajaxGetOrderHistory?sortDir=DESC&sortBy=DATE&nextPageToken=${pageToken}&locale=en-US`)).json(); 
  const gamesList = data.orders.reduce((acc, value) => [...acc, ...value.items.map(v => v.description)], []);
  console.log(`Games on this page: ${gamesList.length}, Next page starts from date: ${data.nextPageToken}`);
  const newList = [...existingList, ...gamesList];
  if (!data.nextPageToken) return newList; 
  return await fetchGamesList(data.nextPageToken, newList);
}
fetchGamesList().then(console.log);
  1. The console will output the list of games you have purchased on the Epic Games Store.
  2. Right-click on the output (the list of game names) and select Copy object.
  3. Create a new text (.txt) file (e.g. through Notepad), paste the copied object into the file and save it.

Optionally, you can now use the saved file as input for the gameNames mode to find the Steam App IDs for the games. Note that due to the formatting of the output you get from the workaround, you will need to set the following as the delimiter option in your configuration file to get the best results: \",\r\n \" For best results, also remove the leading [ and trailing ] from the file.

Configuration: epicGamesAccount

Properties

The following is a list of all configuration items, their defaults and the values they can take.

epicGamesCookie

The cookie you extracted from the initial request required to get this mode to work. You can find more information in the setup section above.

Type Default value Possible values Required
string "EPIC_BEARER_TOKEN=1234567890abcdef" A valid EPIC_BEARER_TOKEN cookie Yes

Related projects

Wondering what to do with the Steam App IDs you just found? You could try organizing all of your Steam games in Notion using the Notion Steam API integration.

Would you like to know what games are currently available on Game Pass for your platform? Check out the Game Pass API project.

Feedback

If you have any question, feedback or feature requests, feel free to open an issue.