This module provides a SteamID object which makes SteamID usage and conversion easy.
Install it from npm:
$ npm install steamid
A SteamID is made up of four parts: its universe, its type, its instance, and its account ID.
- Universe: Currently, there are 5 universes. A universe is a unique instance of Steam. You'll probably only be interacting with the public universe, which is the regular Steam. Only Valve employees can access non-public universes.
- Type: A SteamID's type determines what it identifies. The most common type is individual, for user accounts. There are also other types such as clans (Steam groups), gameservers, and more.
- Instance: The instance ID isn't usually used.
- Account ID: This represents a unique account of a type.
There are enums for each type available under the root SteamID object.
SteamID.Universe = {
"INVALID": 0,
"PUBLIC": 1,
"BETA": 2,
"INTERNAL": 3,
"DEV": 4,
"RC": 5
};SteamID.Type = {
"INVALID": 0,
"INDIVIDUAL": 1,
"MULTISEAT": 2,
"GAMESERVER": 3,
"ANON_GAMESERVER": 4,
"PENDING": 5,
"CONTENT_SERVER": 6,
"CLAN": 7,
"CHAT": 8,
"P2P_SUPER_SEEDER": 9,
"ANON_USER": 10
};SteamID.Instance = {
"ALL": 0,
"DESKTOP": 1,
"CONSOLE": 2,
"WEB": 4
};You can create a SteamID object from a Steam2 rendered ID, a Steam3 rendered ID, a SteamID64, or from the four parts that make up a SteamID.
var SteamID = require('steamid');
var sid = new SteamID('STEAM_0:0:23071901');var SteamID = require('steamid');
var sid = new SteamID('[U:1:46143802]');var SteamID = require('steamid');
var sid = new SteamID('76561198006409530');var SteamID = require('steamid');
var sid = new SteamID();
sid.universe = SteamID.Universe.PUBLIC;
sid.type = SteamID.Type.INDIVIDUAL;
sid.instance = SteamID.Instance.DESKTOP;
sid.accountid = 46143802;Once you have created a SteamID object, you can access its properties (universe, type, instance, and accountid) or you can convert it between rendered types.
Returns true if the object represents a valid SteamID, or false if not.
Returns the Steam2 rendered ID format for individual accounts. Throws an error if the type isn't individual.
If you pass true for newerFormat, the first digit will be 1 instead of 0 for the public universe.
Example:
var SteamID = require('steamid');
var sid = new SteamID('76561198006409530');
console.log(sid.getSteam2RenderedID()); // STEAM_0:0:23071901
console.log(sid.getSteam2RenderedID(true)); // STEAM_1:0:23071901Returns the Steam3 rendered ID format.
Examples:
var SteamID = require('steamid');
var sid = new SteamID('76561198006409530');
console.log(sid.getSteam3RenderedID()); // [U:1:46143802]
var gid = new SteamID('103582791434202956');
console.log(gid.getSteam3RenderedID()); // [g:1:4681548]Returns the 64-bit representation of the SteamID.
Examples:
var SteamID = require('steamid');
var sid = new SteamID('[g:1:4681548]');
console.log(sid.getSteamID64()); // 103582791434202956
var sid2 = new SteamID('STEAM_0:0:23071901');
console.log(sid2.getSteamID64()); // 76561198006409530