@kabeep/node-steam-library

node-steam-library

Obtain the installation directory and application list of Steam through the Windows registry.

English | 简体中文

📖 Introduction

[!IMPORTANT] Only Windows supported.

Node module that interacts with the Steam installation on a user's system. This library provides utilities to get Steam root path, retrieve Steam library information, and list installed apps.

⚙️ Installation

npm install @kabeep/node-steam-library --save

yarn add @kabeep/node-steam-library

pnpm add @kabeep/node-steam-library

🚀 Usage

CommonJS

const steamLib = require('@kabeep/node-steam-library');

or ESModule

import steamLib from '@kabeep/node-steam-library';

Methods: getRootPath()

Retrieve the installation path of Steam from the Windows registry.

steamLib.getRootPath
    .then(console.log)
    .catch(console.error);

Returns: Promise<string>

Methods: getLibrary()

Retrieve the Steam library information.

steamLib.getLibrary
    .then(console.log)
    .catch(console.error);

Returns: Promise<SteamLibraryOption[]>

SteamLibraryOption:

Property	Type	Description	Example
library	string	Path to the library folder	"G:\\path\\to\\SteamLibrary"
id	string	Apps ID	"321"

Methods: getApps()

Retrieve all the application information of the Steam library.

steamLib.getApps
    .then(console.log)
    .catch(console.error);

Returns: Promise<SteamAppOption[]>

SteamAppOption:

Property	Type	Description	Example
id	number	Apps ID	321
name	string	Apps name	"Counter-Strike: Global Offensive"
installPath	string	Apps install path	"G:\\path\\to\\SteamLibrary\\Counter-Strike: Global Offensive"
modPath	string	Apps mod path	"G:\\path\\to\\SteamLibrary\\Counter-Strike: Global Offensive\\steamapps\\workshop\\content\\321"
language	string	Apps locale	"english"

🔗 Related

• vdf - Module to convert Valve's KeyValue format to JSON and back.
• node-winreg - node module that provides access to the Windows Registry through the REG commandline tool.

🤝 Contribution

Contributions via Pull Requests or Issues are welcome.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.