Code Monkey home page Code Monkey logo

node-csgo-gsi's Introduction

node-csgo-gsi

npm npm

Counter-Strike: Global Offensive Game State Integration for node.js.

Usage

Install gamestate_integration_node.cfg into your CS:GO cfg directory.

Example: C:\Program Files (x86)\Steam\steamapps\common\Counter-Strike Global Offensive\csgo\cfg\gamestate_integration_node.cfg

This file will automatically be executed on client start. Look into the console to check if it has executed successfully. As per the documentation, the file name should start with gamestate_integration_ and ends with .cfg.

gamestate_integration_yourservicenamehere.cfg

The console should have an output like this the moment you open CS:GO

Loading Game State Integration: gamestate_integration_node.cfg

Installation

npm install node-csgo-gsi --save

or

yarn add node-csgo-gsi

const CSGOGSI = require("node-csgo-gsi");
let gsi = new CSGOGSI({ options });
gsi.on("EVENT_NAME", function("optional data") {
    // EVENT_NAME is the individual event name below. Look into the example/index.js for more information
});

Example

A sample script is in the example folder.

Options

  • port - Set the server port (default: 3000)
  • authToken - An array of authentication token to accept from client. You can have multiple tokens (default: [] - no authentication needed)
    • Example: Team 1 can have "token1". Team 2 can have "token2". Team1's sub team can have "token1sub" etc.

Events

all

  • Returns the full posted data (use this if you do not want to use the given events provided below)

Game

gameMap (returns String)

  • Returns current map.

gamePhase (returns String)

  • Returns current game state.
    • live
    • warmup

gameRounds (returns Integer)

  • Returns the current round number.
    • eg: 10

gameCTscore (returns Object)

  • Returns the current Counter Terrorist team's score.
      "score": int,
      "consecutive_round_losses": int,
      "timeouts_remaining": int,
      "matches_won_this_series": int

gameTscore (returns Object)

  • Returns the current Terrorist team's score.
      "score": int,
      "consecutive_round_losses": int,
      "timeouts_remaining": int,
      "matches_won_this_series": int

Round

roundPhase (returns String)

  • Returns the current round state.
    • live
    • freezetime
    • over

roundWinTeam (returns String)

  • Returns the latest round's winner.
    • CT
    • T

roundWins (returns Object)

  • Returns a key-value object of round number and reason Example
{
      "1": "ct_win_elimination",
      "2": "ct_win_time",
      "3": "ct_win_elimination",
      "4": "ct_win_time",
      "5": "t_win_bomb"
}

C4

bombState (returns String)

  • Returns C4 state.
    • planted
    • exploded
    • defused

bombTimeStart (returns Float)

  • Returns when C4 is planted.

bombTimeLeft (returns Float)

  • Returns planted C4 time left.

WARNING ⚠️

C4 timer (bombTimeLeft event) is not accurate. CS:GO does not return a real time update when the bomb is planted. It's just an estimation on the library's side. Thus, do just look for the bombState event instead of relying on the timer.

Todo

  • None for now. Open an issue!

Credits

License

The MIT License (MIT)

Copyright (c) 2021 Shaun

node-csgo-gsi's People

Contributors

atiernan avatar shaunidiot avatar shaunlwm avatar xinayder avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

node-csgo-gsi's Issues

Hi

Can u tell me eaxtly whats doing this script ? i want make pug service like faceit it will help me ?

Doesnt connect with csgo

I've set up the whole code that you've provided, everything works, but it doesn't connect with csgo itself. Do you have any suggestions or links that may sort my issue out?

'self' is not defined

node-csgo-gsi/index.js line 120
self.isBombPlanted = False

ReferenceError: self is not defined

Player State

Is there a way to check player health in this package?

Auth

Hello,
can you please add a function which allows checking the auth token which is in the cfg file?

Thank you very much
Regards
Dieter

An in-range update of body-parser is breaking the build 🚨

Version 1.18.3 of body-parser was just published.

Branch Build failing 🚨
Dependency body-parser
Current Version 1.18.2
Type dependency

This version is covered by your current version range and after updating it in your project the build failed.

body-parser is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Status Details
  • ❌ ci/circleci Your tests failed on CircleCI Details

Release Notes 1.18.3
Commits

The new version differs by 32 commits.

There are 32 commits in total.

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

Data gathering from CS:GO is slow

CS:GO data as health,... is gathered slowly, which results in HUD not being "live" but more like being updated every 1-5 seconds.

This is my cfg file.

"node-csgo-gsi" { "uri" "http://127.0.0.1:3000" "timeout" "5.0" "buffer" "0.1" "throttle" "0.1" "heartbeat" "30.0" "auth" { "token" "Q79v5tcxVQ8u" } "data" { "provider" "1" "map" "1" "round" "1" "player_id" "1" "allplayers_id" "1" // Same as 'player_id' but for all players. 'allplayers' versions are only valid for HLTV and observers "player_state" "1" "allplayers_state" "1" "allplayers_match_stats" "1" "allplayers_weapons" "1" "allplayers_position" "1" // output the player world positions, only valid for GOTV or spectators. "phase_countdowns" "1" // countdowns of each second remaining for game phases, eg round time left, time until bomb explode, freezetime. Only valid for GOTV or spectators. "allgrenades" "1" // output information about all grenades and inferno flames in the world, only valid for GOTV or spectators. } }

I've implemented my own "alldata" in the library's code to send all data

process(data) {

   this.emit("alldata", data);

I then send this via soccket to website, but it is not caused by the socke itself, but rather with CS:GO. (Even when I console.log the data, the updating is slow.)

Can't update in real time

Hello, it seems to me that something is preventing this library from updating in real time. There is approximately a 1 second delay. Adjusting GSIConfig config values does not change the frequency of receiving data.

Do you have any insights about this?

Server not ending the response

The server does not call end on the http.ServerResponse object, this means that even though the 200 status is sent the GSI will wait the timeout period before sending another update (therefore ignoring the throttle or buffer settings)

With the config below I am getting a 5 second delay between game state updates whereas I would expect an update every 100ms

"uri" "http://127.0.0.1:3000"
"timeout" "5.0"
"buffer"  "0.1"
"throttle" "0.1"
"heartbeat" "30.0"

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.