{"id":26665226,"url":"https://github.com/kabeep/node-steam-library","last_synced_at":"2026-02-24T10:05:00.055Z","repository":{"id":257536347,"uuid":"858576627","full_name":"kabeep/node-steam-library","owner":"kabeep","description":"🎮 Get the installation directory and application list of Steam through the Windows registry.","archived":false,"fork":false,"pushed_at":"2024-12-09T07:08:32.000Z","size":21,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-24T10:40:34.288Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kabeep.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-17T06:37:11.000Z","updated_at":"2025-01-08T18:51:58.000Z","dependencies_parsed_at":"2025-03-25T17:40:42.173Z","dependency_job_id":"a7042866-b969-4731-a1cb-e19158355408","html_url":"https://github.com/kabeep/node-steam-library","commit_stats":null,"previous_names":["kabeep/node-steam-library"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/kabeep/node-steam-library","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kabeep%2Fnode-steam-library","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kabeep%2Fnode-steam-library/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kabeep%2Fnode-steam-library/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kabeep%2Fnode-steam-library/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kabeep","download_url":"https://codeload.github.com/kabeep/node-steam-library/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kabeep%2Fnode-steam-library/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29779262,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-24T04:54:30.205Z","status":"ssl_error","status_checked_at":"2026-02-24T04:53:58.628Z","response_time":75,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-25T17:28:35.218Z","updated_at":"2026-02-24T10:05:00.040Z","avatar_url":"https://github.com/kabeep.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# node-steam-library\n\nObtain the installation directory and application list of Steam through the Windows registry.\n\n---\n\nEnglish | [简体中文](README.zh-CN.md)\n\n[![Alt](https://repobeats.axiom.co/api/embed/560bbf7278f0bec27acffbc3a64fc11cfff02782.svg \"Repobeats analytics image\")](#)\n\n\u003c/div\u003e\n\n## 📖 Introduction\n\n\u003e [!IMPORTANT]\n\u003e Only Windows supported.\n\nNode module that interacts with the Steam installation on a user's system. This library provides utilities to get Steam\nroot path, retrieve Steam library information, and list installed apps.\n\n## ⚙️ Installation\n\n```bash\nnpm install @kabeep/node-steam-library --save\n```\n\n```bash\nyarn add @kabeep/node-steam-library\n```\n\n```bash\npnpm add @kabeep/node-steam-library\n```\n\n## 🚀 Usage\n\nCommonJS\n\n```javascript\nconst steamLib = require('@kabeep/node-steam-library');\n```\n\nor ESModule\n\n```javascript\nimport steamLib from '@kabeep/node-steam-library';\n```\n\n---\n\n#### Methods: `getRootPath()`\n\nRetrieve the installation path of Steam from the Windows registry.\n\n```javascript\nsteamLib.getRootPath\n    .then(console.log)\n    .catch(console.error);\n```\n\n#### Returns: `Promise\u003cstring\u003e`\n\n---\n\n#### Methods: `getLibrary()`\n\nRetrieve the Steam library information.\n\n```javascript\nsteamLib.getLibrary\n    .then(console.log)\n    .catch(console.error);\n```\n\n#### Returns: `Promise\u003cSteamLibraryOption[]\u003e`\n\n**SteamLibraryOption:**\n\n| Property | Type     | Description                | Example                        |\n|----------|----------|----------------------------|--------------------------------|\n| library  | `string` | Path to the library folder | `\"G:\\\\path\\\\to\\\\SteamLibrary\"` |\n| id       | `string` | Apps ID                    | `\"321\"`                        |\n\n---\n\n#### Methods: `getApps()`\n\nRetrieve all the application information of the Steam library.\n\n```javascript\nsteamLib.getApps\n    .then(console.log)\n    .catch(console.error);\n```\n\n#### Returns: `Promise\u003cSteamAppOption[]\u003e`\n\n**SteamAppOption:**\n\n| Property    | Type     | Description       | Example                                                                                             |\n|-------------|----------|-------------------|-----------------------------------------------------------------------------------------------------|\n| id          | `number` | Apps ID           | `321`                                                                                               |\n| name        | `string` | Apps name         | `\"Counter-Strike: Global Offensive\"`                                                                |\n| installPath | `string` | Apps install path | `\"G:\\\\path\\\\to\\\\SteamLibrary\\\\Counter-Strike: Global Offensive\"`                                    |\n| modPath     | `string` | Apps mod path     | `\"G:\\\\path\\\\to\\\\SteamLibrary\\\\Counter-Strike: Global Offensive\\\\steamapps\\\\workshop\\\\content\\\\321\"` |\n| language    | `string` | Apps locale       | `\"english\"`                                                                                         |\n\n## ❌ Error Codes\n\n```javascript\nsteamLib.getApps()\n    .then(console.log)\n    .catch((err) =\u003e {\n        // string\n        console.log(err.code);\n    });\n```\n\n#### EUNKNOWN\n\n\u003e Unknown error that doesn't fall into any specific category\n\n#### EREGISTRY\n\n\u003e An error related to registry operations, such as failure to read from to the Windows registry.\n\n#### ELIBRARY\n\n\u003e An error related to Steam library operations, such as issues with finding or parsing the Steam library folders.\n\n#### EMANIFEST\n\n\u003e An error related to manifest files, such as missing or malformed Steam manifest files.\n\n## 🔗 Related\n\n- [vdf](https://github.com/node-steam/vdf) - Module to convert Valve's KeyValue format to JSON and back.\n- [node-winreg](https://github.com/fresc81/node-winreg) - node module that provides access to the Windows Registry\n  through the REG commandline tool.\n\n## 🤝 Contribution\n\nContributions via Pull Requests or [Issues](https://github.com/kabeep/node-steam-library/issues) are welcome.\n\n## 📄 License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkabeep%2Fnode-steam-library","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkabeep%2Fnode-steam-library","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkabeep%2Fnode-steam-library/lists"}