Skip to content

Latest commit

 

History

History
203 lines (167 loc) · 9.96 KB

README.MD

File metadata and controls

203 lines (167 loc) · 9.96 KB
Raw

CS2 Server Control with a Nodejs-powered web-API (LINUX only)

this API is used to start/stop/update a CS2 linux dedicated server and control it via rcon. The backend accepts RESTful api calls authenticated either via steamID or a configurable user with http authentication for stateless API calls. A full featured example webinterface is provided to get a quick start on the application.

Disclaimer

The use of this software is at your own risk. It exposes control of your server and shell functions to the internet. Although I did everything to secure the API, any bugs may lead to security breaches on your server. I strongly adivise to use secure connections to prevent possible man-in-the-middle attacks.

This is the first release for CS2. It has the following changes to previous functionality

  • The Steam-Api calls for the map details now need an API-Token. See configuration section below for details.
  • Changed Log-reception to http logs, since UDP is not supported anymore in new server. Unnecessary library source-log-receiver removed.
  • Maplist loading has changed to the worse, see Maps TL;DR for details how the API deals with it.
  • Changed API calls (non braking).
    • mapchange can now be done with map-filename (without extension), workshop-id or map-title as argument.
  • added API endpoints for pausing and resuming the match (/control/pause & /control/unpause). Status is tracked in serverInfo.pause (false/true).

Prerequisites

  • steam CLI
  • CS2 dedicated server
  • NodeJS 16.X or higher
  • screen

Install

Download the nodejs-csgo-api-vX.X.zip and unpack. OR download the script files to and install the dependencies for nodejs

Then in the application folder do

npm install

If "screen" is not installed:

sudo apt install screen

(For systems using apt as packet manager.)

Configuration

API:

  • Edit the settings in config.js - at least the first 5. They are explained in the file.
  • The API uses steam authentication which returns a Steam ID as URL (https://steamcommunity.com/openid/id/{steamid}). The last part is the SteamID64, which can be calculated from the other SteamID formats - various online tools are available. In the configuration, an array needs to be filled with the comma separated IDs of your intended admins as strings (e.g. ['{steamid-1}', '{steamid-2}']).
  • To display map preview images, a steamAPI key is needed. See https://steamcommunity.com/dev/apikey how to get one. It must be copied to the respective config option. To learn more on how the map-handling works see Maps TL;DR

Server update script

If you want to use the update function, you need to provide a script to use with the steamcmd. Default is /<your_server_root>/update_cs2.txt You can change the filename in the config.

CS2 Dedicated Server

You need to set the rcon Password in the server config, the rest is configured via command line when sarting via the API. following arguments are added to the CL:

-console -usercon -ip 0.0.0.0 +sv_logfile 1 -serverlogging +logaddress_add_http "http://${this._localIp}:${this.logPort}/log"

If a running server is detected, the logging settings will be set via rcon.

If you need to change these and know what you are doing, you can edit them in "modules/configClass.js" You can add optional command line arguments in config.js

Starting

Start the script with

node serverControl.js

In your browser open http://<yourIP>:8090/gameserver.htm to see the example webinterface

If the server is already running in a screen, the API will detect a running server and connect to it.

To start the API on boot and have it running in the background, I recommend PM2

Usage

NOTE: For API calls with basic http authentication see below.

Use the following GET Messages to control the server. If you have certificates configured, you can also use https:// (These examples assume usage of jquery):

Note: Due to authentication with Steam, you will have to use $.ajax() with the following options.

$.ajax({
  crossDomain: true,
  xhrFields: {
    withCredentials: true
  }
});

For better readability, $.get() is used in the following examples

Login / Logout

$.get('http://<your-servers-address>:<your-port>/csgoapi/login')
$.get('http://<your-servers-address>:<your-port>/csgoapi/logout')
$.get('http://<your-servers-address>:<your-port>/csgoapi/loginStatus')

For Authentication the API redirects to the Steam login page by calling '/csgoapi/login' After authentication there, it will return to '/csgoapi/loginStatus' by default, returning { "login": true/false }. If you use the API in a web interface, you can set 'redirectPage' in the config to your startPage (e.g. http://your-webserver/index.html) This way, you can call up the login page and then be returned to your web application after you got the session cookie in your browser.

If you want to have a manual logout in your client, call '/csgoapi/logout', which will redirect to '/csgoapi/loginStatus' to confirm the success.

Server Control

$.get('http://<your-servers-address>:<your-port>/csgoapi/v1.0/control/<anAction>')

The /control message will return a JSON-String. 'action' can have the following values:

  • status -> fetch the servers running status: { "running": true/false }
  • update -> update the server (may take quite some time): { "success": true/false }
  • start -> optional additional argument "startmap" (?startmap=mapname): { "success": true/false } If run without startmap, server will be started with de_dust2.
  • stop -> stop the server with RCON 'quit': { "success": true/false }
  • kill -> use 'kill' command to shutdown the server, if RCON connection is not working: { "success": true/false }
  • changemap -> additional argument "map" (action=changemap&map=mapfilename/workshopid/title):
  • reloadmaplist -> reload the available maps on the server (action=reloadmaplist): { "success": true/false }

If you do not use websockets, the answer will be sent after completion of the operation. If you use websockets, answer will be sent right away. Progress and/or completion messages are sent via the websocket. See below for format. Exception is server start, since RCON-authentication is a vital step for the api, 'start' will always return "success" only after authentication finished.

RCON

$.get('http://<your-servers-address>:<your-port>/csgoapi/v1.0/rcon', 'message=command')

'command' is the command as you would enter it in the servers console. Answer is the response as string.

Server Info

$.get('http://<your-servers-address>:<your-port>/csgoapi/v1.0/info/serverInfo')

Gets information on the server as JSON-String. See serverInfo.js for available data.

$.get('http://<your-servers-address>:<your-port>/csgoapi/v1.0/info/runstatus')
$.get('http://<your-servers-address>:<your-port>/csgoapi/v1.0/info/rconauthstatus')

Query if the server is running or also authenticated for rcon requests. Answer is deleayed if a status change is in progress.

Map filtering

Filters are used to limit the maps that are transmitted to clients with the serverInfo. Filtering here consists of filter strings and a filter type. The strings are matched as parts against the maps filenames. 'cs_' would match all hostage rescue maps, 'dust' would match all maps that have dust in their names (de_dust2, de_dust, etc.). The filter type controls if the matched maps are shown or hidden. 'inlcude' will include all matched maps in the mapsAvail and mapsDetails arrays of serverInfo, 'exclude' will hide them. For Example, if you want to play only bomb-defuse maps, you could set the filter type to 'include' and filter to 'de_'. The filter type can only be set globally and not per filter string.

Current filter settings can be queried with

$.get('http://<your-servers-address>:<your-port>/csgoapi/v1.0/filter')

Return value is JSON: { "type": {string}, "filters": {array of strings} }

Filter control works like this:

$.get('http://<your-servers-address>:<your-port>/csgoapi/v1.0/filter/reset')
$.post('http://<your-servers-address>:<your-port>/csgoapi/v1.0/filter/<anAction>')

actions can be:

  • reset (get) -> Resets the filter to tpye 'exclude' and no filter strings.
  • add?filter= (post) -> Adds the given string to the filters.
  • remove?filter= (post) -> Removes the given string, if it exists.
  • type (post) -> Sets the filter type ('include' or 'exclude');

If successful, the call will return the new filter-info, else a JSON error string. E.g.: { "error": "No filter was removed." }

Information Updates via WebSocket

A websocket is available on a configurable port to receive further information. Currently avialable are ServerInfo as any value changes, start/stop/fail of commands, update-progress and completion of mapchange (on start of new map).

ServerInfo message looks as follows:

{ "type": "serverInfo", "payload": {ServerInfoObject}

For now, Serverinfo is always sent completely

Start/stop of a command:

{ "type": "commandstatus", "payload": { "operation": <string>, "state": <"start"/"stop"/"fail"> } }

Operation can be one of the following: start, stop, update, mapchange

UpdateProgress looks as follows:

{ "type": "updateProgress", "payload": { "step": <string>, "progress": <int> } }

Api calls with http authentication

For stateless API-Calls via command line or other automatic tools the http basic authentication can be activated in the config with:

"httpAuth": true,
"httpUser": { "username": "", "password": "" },

For now, only one user can be specified.

If you enable this option, you should use https to avoid sending of paswords in the clear.

The interface is:

http://<your-servers-address>:<your-port>/csgoapi/http/v1.0/...

Support

If you have any questions, contact me.

If you find any bugs or have feature requests, don't hesitate to open an issue.