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

This module relies on BigInt, your target platform must support it!

Usage

Match

Decoding

Decodes a match share code into a MatchInformation object.

1import { decodeMatchShareCode, MatchInformation } from 'csgo-sharecode';
2
3const shareCode = 'CSGO-GADqf-jjyJ8-cSP2r-smZRo-TO2xK';
4const matchInformation: MatchInformation = decodeMatchShareCode(shareCode);
5console.log(matchInformation);
6// output:
7//
8// {
9//    matchId: 3230642215713767580n,
10//    reservationId: 3230647599455273103n,
11//    tvPort: 55788
12// }

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.

1import { encodeMatch, MatchInformation } from 'csgo-sharecode';
2
3const matchInformation: MatchInformation = {
4  matchId: BigInt('3230642215713767580'),
5  reservationId: BigInt('3230647599455273103'),
6  tvPort: 599906796,
7};
8
9const shareCode = encodeMatch(matchInformation);
10console.log(shareCode);
11// output:
12//
13// "CSGO-GADqf-jjyJ8-cSP2r-smZRo-TO2xK"

Crosshair

Decoding

Decodes a crosshair share code into a Crosshair object.

1import { decodeCrosshairShareCode, Crosshair } from 'csgo-sharecode';
2
3const shareCode = 'CSGO-WsnnD-eHaMw-QNDf9-oxuDh-ydOUD';
4const crosshair: Crosshair = decodeCrosshairShareCode(shareCode);
5console.log(crosshair);
6// output:
7//
8// {
9//   gap: -2.2,
10//   outline: 1,
11//   red: 50,
12//   green: 250,
13//   blue: 50,
14//   alpha: 200,
15//   splitDistance: 3,
16//   followRecoil: true,
17//   fixedCrosshairGap: 3,
18//   color: 1,
19//   outlineEnabled: true,
20//   innerSplitAlpha: 0,
21//   outerSplitAlpha: 1,
22//   splitSizeRatio: 1,
23//   thickness: 0.6,
24//   centerDotEnabled: false,
25//   deployedWeaponGapEnabled: true,
26//   alphaEnabled: true,
27//   tStyleEnabled: false,
28//   style: 2,
29//   length: 10
30// }

Encoding

Encodes a Crosshair object into a crosshair share code.

1import { encodeCrosshair, Crosshair } from 'csgo-sharecode';
2
3const crosshair: Crosshair = {
4  gap: -2.2,
5  outline: 1,
6  red: 50,
7  green: 250,
8  blue: 50,
9  alpha: 200,
10  splitDistance: 3,
11  fixedCrosshairGap: 3,
12  color: 1,
13  innerSplitAlpha: 0,
14  outlineEnabled: true,
15  outerSplitAlpha: 1,
16  splitSizeRatio: 1,
17  thickness: 0.6,
18  centerDotEnabled: false,
19  alphaEnabled: true,
20  tStyleEnabled: false,
21  style: 2,
22  length: 10,
23  deployedWeaponGapEnabled: true,
24  followRecoil: true,
25};
26
27const shareCode = encodeCrosshair(crosshair);
28console.log(shareCode);
29// output:
30//
31// "CSGO-WsnnD-eHaMw-QNDf9-oxuDh-ydOUD"

Generating CSGO ConVars

Utility function to generate CSGO ConVars for a given crosshair.

1import { crosshairToConVars, Crosshair } from 'csgo-sharecode';
2
3const crosshair: Crosshair = {
4  gap: -2.2,
5  outline: 1,
6  red: 50,
7  green: 250,
8  blue: 50,
9  alpha: 200,
10  splitDistance: 3,
11  fixedCrosshairGap: 3,
12  color: 1,
13  innerSplitAlpha: 0,
14  outlineEnabled: true,
15  outerSplitAlpha: 1,
16  splitSizeRatio: 1,
17  thickness: 0.6,
18  centerDotEnabled: false,
19  alphaEnabled: true,
20  tStyleEnabled: false,
21  style: 2,
22  length: 10,
23  deployedWeaponGapEnabled: true,
24  followRecoil: true,
25};
26
27const conVars = crosshairToConVars(crosshair);
28console.log(conVars);
29// Output:
30//
31// cl_crosshair_drawoutline "1"
32// cl_crosshair_dynamic_maxdist_splitratio "1"
33// cl_crosshair_dynamic_splitalpha_innermod "0"
34// cl_crosshair_dynamic_splitalpha_outermod "1"
35// cl_crosshair_dynamic_splitdist "3"
36// cl_crosshair_outlinethickness "1"
37// cl_crosshair_t "0"
38// cl_crosshairalpha "200"
39// cl_crosshaircolor "1"
40// cl_crosshaircolor_b "50"
41// cl_crosshaircolor_g "250"
42// cl_crosshaircolor_r "50"
43// cl_crosshairdot "0"
44// cl_crosshairgap "-2.2"
45// cl_crosshairgap_useweaponvalue "1"
46// cl_crosshairsize "10"
47// cl_crosshairstyle "2"
48// cl_crosshairthickness "0.6"
49// cl_crosshairusealpha "1"
50// cl_fixedcrosshairgap "3"
51// cl_crosshair_recoil "1"

License

GPL v2