@truecarry/deadlock
Advanced tools
Exposes a simple API for interacting with the Deadlock game coordinator
This module provides a very flexible interface for interacting with the CS2 Game Coordinator. It's designed to work with a node-steam-user SteamUser instance.
This is based off of node-tf2.
You will need steam-user v4.2.0 or later and Node.js v14 or later to use globaloffensive v3.
You will need steam-user v4.2.0 or later and Node.js v8 or later to use globaloffensive v2.
First, install it from npm:
$ npm install globaloffensive
Require the module and call its constructor with your SteamUser instance:
const SteamUser = require('steam-user');
const GlobalOffensive = require('globaloffensive');
let user = new SteamUser();
let csgo = new GlobalOffensive(user);
To initialize your GC connection, just launch CS:GO via SteamUser normally:
client.gamesPlayed([730]);
node-globaloffensive will emit a connectedToGC event when the game coordinator connection has been successfully
established. You shouldn't try to do anything before you receive that event.
There are some enums that are used by various methods and events. You can find them in enums.js.
There are a few useful read-only properties available to you.
true if we're currently connected to the GC, false otherwise. You should only call methods when we have an active GC session.
A big object containing account data and some statistics including players in-game. Undefined until accountData is emitted.
An array containing the items in your inventory. Undefined until connectedToGC is emitted.
As of v2.2.0, some special properties are populated on items in this array (and also item objects in itemAcquired and
related events), where applicable:
position - This item's position in your inventory. If the item is new and unacknowledged, this is 0custom_name - This item's custom name, applied via name tagpaint_index - The item's paint indexpaint_seed - The item's paint seedpaint_wear - The item's paint wear, as a float (often ignorantly referred to as "float value")kill_eater_value - Tracked stat value for StatTrak weaponskill_eater_score_type - What type of stat is tracked for StatTrak weapons. Currently only 0 (Kills) is available.quest_idtradable_after - A Date object representing when this item will become tradable. May be a date in the past, as this is not removed when the date is reached.stickers - An array of objects:
slot - The sticker slot number, 0-5sticker_idwear - The sticker's wear (how scratched it is), as a float. null if not scratched at all.scale - Float, null if not applicablerotation - Float, null if not applicabletint_idoffset_x - Float, null if not applicableoffset_y - Float, null if not applicablecasket_id - If this item is contained in a casket (storage unit), this is a string containing that casket's item IDcasket_contained_item_count - If this item is a casket (storage unit), this is a count of how many items it containsNote that if any of the above attributes are not applicable, then they will not exist in the item object.
It appears that under some circumstances, the GC might load items from storage units into your inventory without
calling getCasketContents, so if you are using this property to see what items
are in your inventory, you will need to check casket_id to filter out items stored in storage units.
When instantiating your node-globaloffensive instance, you need to pass your active Steam.SteamClient instance as the sole parameter, as shown here:
var csgo = new GlobalOffensive(steamClient);
shareCodeOrDetails - Either a share code as a string, or an object containing properties matchId, outcomeId, tokenv2.2.0 or later is required to use this method
Requests stats for a historical game. Listen for the matchList event to get your response.
Request a list of current live tournament games.
This is the list you see in the client under Watch -> Live.
Listen for the matchList event to get your response.
Request a list of recent games (max. 8). This is the list you see in the client under Watch -> Your Matches.
Listen for the matchList event to get your response.
Request live game info for a specific user. Listen for the matchList event to get your response.
owner - The numeric SteamID or market listing ID of the owning Steam account or market listing, as a string; or an entire inspect link.assetid - If owner is not an entire inspect link, this is the numeric asset ID of this item, as a stringd - If owner is not an entire inspect link, this is the "D" number from the inspect link (the last number following the "D" character)callback - Optional. Called if all parameters are valid when Steam responds to us.
item - An object containing the item's data
accountid - Seems to always be nullitemid - The item's asset ID, as a stringdefindex - The item's definition indexpaintindex - The item's paint indexrarity - The item's numeric rarityquality - The item's numeric qualitypaintwear - The item's paint wear percentage, as a float between 0 and 1 (frequently and incorrectly called "float value")paintseed - The item's paint seedkilleaterscoretype - What kind of statistic the StatTrak version of this item tracks (may be null if not StatTrak)killeatervalue - The item's tracked statistic value (kills)customname - The item's custom name via a name tag, or null if nonestickers - An array of objects describing the stickers applied to this item
slot - What slot this sticker is applied tosticker_id - The ID of this type of stickerwear - Either null (not scratched) or a float between 0 and 1 describing how much this sticker has been scratchedscale - This property is only not null on the early dreamhack 2013 stickers. It is no longer used.rotation - This property is only not null on the early dreamhack 2013 stickers. It is no longer used.tint_idoffset_x - Float, null if not applicableoffset_y - Float, null if not applicableinventory - An integer which has no use to youorigin - The numeric origin of this itemquestid - You can ignore thisdropreasonmusicindexentindexv1.1.0 or later is required to use this method
Sends the same request to the GC that the official client sends when you inspect an item. If all parameters are correct
and the GC is in a good mood, returns the item's data. Using this for an item your account owns is useless as all
the data is already available in inventory.
The response will arrive in the callback and in the inspectItemInfo event.
As of v2.1.0, the request will time out if no response is received in 10 seconds. If this happens,
inspectItemTimedOut will be emitted.
steamid - The numeric SteamID of the Steam account to pull profile data for. Needs to be playing CSGO and be on the friend list of the requesting account.callback - Optional. Called if all parameters are valid when Steam responds to us.
profile - An object containing the profiledata
account_id - Steam account idongoingmatchglobal_stats - Seems to always be nullpenalty_secondspenalty_reasonvac_bannedranking
account_idrank_id - Rank (0-18), starting at 0 for unrankedwins - Number of winsrank_change - Seems to always be nullrank_type_id - Rank type (6: Matchmaking, 7: Wingman, 10: Danger Zone)commendation
cmd_friendly - The number of "friendly" commendations the account has receivedcmd_teaching - The number of "teaching" commendations the account has receivedcmd_leader - The number of "leader" commendations the account has receivedmedals - Achievement medals, their ranks and coins
medal_teammedal_combatmedal_weaponmedal_globalmedal_armsdisplay_items_defidx - Array of coinsfeatured_display_item_defidxmy_current_eventmy_current_event_teamsmy_current_teammy_current_event_stagessurvey_voteactivityplayer_level - Private rank levelplayer_cur_xp - Current XP, starting at 327680000 (level % = (player_cur_xp - 327680000) / 5000)player_xp_bonus_flags - Seems to always be nullrankings - Array of ranking infos
account_idrank_id - Rank (0-18), starting at 0 for unrankedwins - Number of winsrank_change - Seems to always be nullrank_type_id - Rank type (6: Matchmaking, 7: Wingman, 10: Danger Zone)v1.2.0 or later is required to use this method
Sends the same request to the GC that viewing the CSGO player profile from the in-game friendlist sends. Returns the same information that you would get in-game. This returns the same protobuf that is used when you request your own profile data, so most of it stays empty.
nameTagId - The ID of the name tag you want to consume to do thisitemId - The ID of the item you want to renamename - A string containing the item's new namev2.1.0 or later is required to use this method
Renames a particular item in your inventory, using a given name tag. You can rename storage units for free by passing
0 as the nameTagId.
items - An array of item IDs to craftrecipe - An integer indicating which crafting recipe to usev2.3.0 or later is required to use this method
Craft items together into a new item using a specific recipe. items should be an array of item IDs to craft.
You will receive a craftingComplete event in response. If crafting succeeded, you will also get
itemRemoved events for each item you spent, and itemAcquired events for each item
you received.
Recipes are defined in items_game.txt. Available recipes as of late 2022 are:
itemId - The ID of the item you want to delete1.3.0 or later is required to use this method
Deletes a particular item from your inventory. This is a destructive operation, which cannot be undone.
casketId - The ID of the casket (storage unit) you want to put an item intoitemId - The ID of the item you want to put into the casketv2.1.0 or later is required to use this method
Put an item in your inventory into a casket (storage unit) you own. Assuming the request succeeds,
itemRemoved will be emitted for the item that was put into the casket, and
itemCustomizationNotification will be emitted with notification type
CasketAdded for the casket.
casketId - The ID of the casket (storage unit) you want to remove an item fromitemId - The ID of the item you want to remove from the casketv2.1.0 or later is required to use this method
Remove an item from a casket (storage unit) you own and put it into your inventory. Assuming the request succeeds,
itemAcquired will be emitted for the item that was removed from the casket, and
itemCustomizationNotification will be emitted with notification type
CasketRemoved for the casket.
casketId - The ID of the casket (storage unit) you want to get the contents ofcallback - A function to be called once the contents are loaded
err - An Error object on failure, or null on successitems - An array of item objects, the same structure as objects in inventoryv2.1.0 or later is required to use this method
Loads the contents of a storage unit. Note that calling this will have the GC load the contents of the storage unit
using the same mechanism as your actual inventory, so items in the storage unit will appear in the inventory
property, and itemAcquired will be emitted for each item. Each item in your inventory that is contained
inside of a storage unit has a property casket_id, the value of which is a string containing the ID of the storage unit
that contains that item.
It appears that under some circumstances, the GC might load these items into your inventory without calling this method,
so if you are using inventory to see what items are in your inventory, you will need to check casket_id
to filter out items stored in storage units.
Emitted when a GC connection is established. You shouldn't use any methods before you receive this. Note that this may be received (after it's first emitted) without any disconnectedFromGC event being emitted. In this case, the GC simply restarted.
reason - A value from the GCConnectionStatus enumEmitted when we're disconnected from the GC for any reason. node-globaloffensive will automatically try to reconnect and will emit connectedToGC when reconnected.
Example usage:
const GlobalOffensive = require('globaloffensive');
let csgo = new GlobalOffensive(steamUser);
csgo.on('disconnectedFromGC', (reason) => {
if (reason == GlobalOffensive.GCConnectionStatus.GC_GOING_DOWN) {
console.log('GC going down');
}
});
err - An Error objectEmitted when we encounter a fatal error attempting to connect to the GC. If this event is not handled, the app will crash.
status - A value from the GCConnectionStatus enumdata - The raw data that was receivedEmitted when we receive the status of our connection to the GC. Exactly when this is emitted is currently unknown. This may be removed in the future.
matches - An array of matchesdata - The raw data that was receivedEmitted when we receive a match list, especially after a requestLiveGames() call. This may be emitted at other times. Presently, the exact behavior is unknown.
item - An object containing the item's data
accountid - Seems to always be nullitemid - The item's asset ID, as a stringdefindex - The item's definition indexpaintindex - The item's paint indexrarity - The item's numeric rarityquality - The item's numeric qualitypaintwear - The item's paint wear percentage, as a float between 0 and 1 (frequently and incorrectly called "float value")paintseed - The item's paint seedkilleaterscoretype - What kind of statistic the StatTrak version of this item tracks (may be null if not StatTrak)killeatervalue - The item's tracked statistic value (kills)customname - The item's custom name via a name tag, or null if nonestickers - An array of objects describing the stickers applied to this item
slot - What slot this sticker is applied tosticker_id - The ID of this type of stickerwear - Either null (not scratched) or a float between 0 and 1 describing how much this sticker has been scratchedscale - Always null?rotation - Always null?tint_idoffset_x - Float, null if not applicableoffset_y - Float, null if not applicableinventory - An integer which has no use to youorigin - The numeric origin of this itemquestid - You can ignore thisdropreasonmusicindexentindexv1.1.0 or later is required to use this method
Emitted in response to an inspectItem() call.
assetid - The asset ID of the item we attempted to inspectv2.1.0 or later is required to use this method
Emitted if inspectItem() is called but we don't receive a timely reply to the request.
item - The item that you receivedEmitted when you receive a new item.
oldItem - The item's previous stateitem - The item's new stateEmitted when an item in your inventory changes in some way.
item - The item that you lostEmitted when an item is removed from your inventory.
itemIds - An array of item IDs (as strings) to which something happenednotificationType - A value from the ItemCustomizationNotification enumv2.1.0 or later is required to use this event
Emitted when the GC informs us that an item is customized somehow. Example:
const GlobalOffensive = require('globaloffensive');
let csgo = new GlobalOffensive(steamUser);
csgo.on('itemCustomizationNotification', (itemIds, notificationType) => {
if (notificationType == GlobalOffensive.ItemCustomizationNotification.CasketInvFull) {
console.log('Storage unit ' + itemIds[0] + ' is full');
}
});
recipe - The ID of the recipe that was used to perform this craft, or -1 on failureitemsGained - An array of IDs of items that were gained as a result of this craftv2.3.0 or later is required to use this event
Emitted when a craft initiated by the craft method finishes.
profile - An object containing the profile data
account_id - Steam account idongoingmatchglobal_stats - Seems to always be nullpenalty_secondspenalty_reasonvac_bannedranking
account_idrank_id - Rank (0-18), starting at 0 for unrankedwins - Number of winsrank_change - Seems to always be nullrank_type_id - Rank type (6: Matchmaking, 7: Wingman, 10: Danger Zone)commendation
cmd_friendly - The number of "friendly" commendations the account has receivedcmd_teaching - The number of "teaching" commendations the account has receivedcmd_leader - The number of "leader" commendations the account has receivedmedals - Achievement medals, their ranks and coins
medal_teammedal_combatmedal_weaponmedal_globalmedal_armsdisplay_items_defidx - Array of coinsfeatured_display_item_defidxmy_current_eventmy_current_event_teamsmy_current_teammy_current_event_stagessurvey_voteactivityplayer_level - Private rank levelplayer_cur_xp - Current XP, starting at 327680000 (level % = (player_cur_xp - 327680000) / 5000)player_xp_bonus_flags - Seems to always be nullrankings - Array of ranking infos
account_idrank_id - Rank (0-18), starting at 0 for unrankedwins - Number of winsrank_change - Seems to always be nullrank_type_id - Rank type (6: Matchmaking, 7: Wingman, 10: Danger Zone)Emitted in response to an requestPlayersProfile() call.
FAQs
Exposes a simple API for interacting with the Deadlock game coordinator
The npm package @truecarry/deadlock receives a total of 3 weekly downloads. As such, @truecarry/deadlock popularity was classified as not popular.
We found that @truecarry/deadlock demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.