csgo-sharecode

JS module to decode / encode CS:GO and CS2 share codes used to share game replays/crosshairs between players.

Installation

npm install csgo-sharecode

Usage

Match

Decoding

Decodes a match share code into a MatchInformation object.

import { decodeMatchShareCode, MatchInformation } from 'csgo-sharecode';

const shareCode = 'CSGO-GADqf-jjyJ8-cSP2r-smZRo-TO2xK';
const matchInformation: MatchInformation = decodeMatchShareCode(shareCode);
console.log(matchInformation);
// output:
//
// {
//    matchId: 3230642215713767580n,
//    reservationId: 3230647599455273103n,
//    tvPort: 55788
// }

Encoding

Encodes a MatchInformation object into a match share code. The example below use values coming from a real CDataGCCStrike15_v2_MatchInfo (lookup for CDataGCCStrike15_v2_MatchInfo) message.
You should get them from the Steam Game Coordinator or from a .info file.

import { encodeMatch, MatchInformation } from 'csgo-sharecode';

const matchInformation: MatchInformation = {
  matchId: BigInt('3230642215713767580'),
  reservationId: BigInt('3230647599455273103'),
  tvPort: 599906796,
};

const shareCode = encodeMatch(matchInformation);
console.log(shareCode);
// output:
//
// "CSGO-GADqf-jjyJ8-cSP2r-smZRo-TO2xK"

Crosshair

The crosshair share code format has changed over time, the version property of the Crosshair object indicates which version the code is.

Version	Type	Release date	CS2 version
1	CrosshairV1	CS:GO era	< 1.41.8.2
2	Not supported	Never released	-
3	CrosshairV3	23/09/2026	1.41.8.2
4	CrosshairV4	24/09/2026	1.41.8.3

• CrosshairV3: Sizes (gap, length, thickness...) are integers expressed in pixels at the screen height the crosshair was created for, the screenHeight property is used to scale the crosshair to the current screen height.
• CrosshairV4: Same as v3 with outlineMode (none, full or half outline) instead of outlineEnabled and the Static Square style.

Decoding

Decodes a crosshair share code into a Crosshair object.

import { decodeCrosshairShareCode, Crosshair } from 'csgo-sharecode';

const shareCode = 'CSGO-sP6xU-TSyN9-sZcO5-2D48M-UppkP';
const crosshair: Crosshair = decodeCrosshairShareCode(shareCode);
console.log(crosshair);
// output:
//
// {
//   version: 4,
//   style: 2,
//   followRecoil: true,
//   centerDotEnabled: true,
//   tStyleEnabled: false,
//   red: 255,
//   green: 0,
//   blue: 0,
//   alpha: 255,
//   gap: 0,
//   length: 5,
//   dynamicSpreadLimit: 255,
//   splitDistance: 3,
//   innerSplitAlpha: 1,
//   outerSplitAlpha: 0.3,
//   splitSizeRatio: 0,
//   thickness: 1,
//   screenHeight: 768,
//   outlineMode: 0
// }

Encoding

Encodes a Crosshair object into a crosshair share code, the code version matches the version property.

import { encodeCrosshair, CrosshairV4 } from 'csgo-sharecode';

const crosshair: CrosshairV4 = {
  version: 4,
  style: 2,
  followRecoil: true,
  centerDotEnabled: true,
  tStyleEnabled: false,
  red: 255,
  green: 0,
  blue: 0,
  alpha: 255,
  gap: 0,
  length: 5,
  dynamicSpreadLimit: 255,
  splitDistance: 3,
  innerSplitAlpha: 1,
  outerSplitAlpha: 0.3,
  splitSizeRatio: 0,
  thickness: 1,
  screenHeight: 768,
  outlineMode: 0,
};

const shareCode = encodeCrosshair(crosshair);
console.log(shareCode);
// output:
//
// "CSGO-sP6xU-TSyN9-sZcO5-2D48M-UppkP"

Generating ConVars

Utility function to generate the ConVars for a given crosshair. ConVar names depend on the crosshair version.

import { crosshairToConVars } from 'csgo-sharecode';

const crosshair: CrosshairV4 = {
  version: 4,
  style: 2,
  followRecoil: true,
  centerDotEnabled: true,
  tStyleEnabled: false,
  red: 255,
  green: 0,
  blue: 0,
  alpha: 255,
  gap: 0,
  length: 5,
  dynamicSpreadLimit: 255,
  splitDistance: 3,
  innerSplitAlpha: 1,
  outerSplitAlpha: 0.3,
  splitSizeRatio: 0,
  thickness: 1,
  screenHeight: 768,
  outlineMode: 0,
};
const conVars = crosshairToConVars(crosshair);
console.log(conVars);
// Output:
//
// cl_crosshair_drawoutline "0"
// cl_crosshair_dynamic_maxdist_splitratio "0"
// cl_crosshair_dynamic_splitalpha_innermod "1"
// cl_crosshair_dynamic_splitalpha_outermod "0.3"
// cl_crosshair_dynamic_splitdist "3"
// cl_crosshair_dynamic_spread_limit "255"
// cl_crosshair_gap "0"
// cl_crosshair_length "5"
// cl_crosshair_recoil "1"
// cl_crosshair_screen_height "768"
// cl_crosshair_t "0"
// cl_crosshair_thickness "1"
// cl_crosshaircolor_a "255"
// cl_crosshaircolor_b "0"
// cl_crosshaircolor_g "0"
// cl_crosshaircolor_r "255"
// cl_crosshairdot "1"
// cl_crosshairstyle "2"

License

MIT