Skip to content

OHD-Tools/OHD-RCON

Repository files navigation

Operation: Harsh Doorstop RCON Interface

npm GitHub Sponsors GitHub issues GitHub npm bundle size (scoped) Codacy grade GitHub GitHub commit activity

GitHub package.json version GitHub release (latest SemVer)

Installation

NPM

npm install @ohd-tools/ohd-rcon

YARN

yarn add @ohd-tools/ohd-rcon

Documentation

Documentation can be found HERE

Docs

Usage

// Example Usage that bans all players with a given word or phrase in their name.
import { OHD } from '@ohd-tools/ohd-rcon';

const myServer = new OHD('127.0.0.1', 8000, 'mypassword');

myServer.on('PLAYER_JOINED', (player) => {
  if (!player.isBot && player.name.includes('Naughty Word')) {
    player.ban(0, 'Bad Words in Name');
  }
});

myServer.on('READY', async () => {
  await myServer.variables.HD.Game.DisableKitRestrictionsOverride.write('1');
  await myServer.variables.HD.Game.MinRespawnDelayOverride.write('0.00');
  const restrictions =
    await myServer.variables.HD.Game.DisableKitRestrictionsOverride.read();
  const respawnDelayInfo =
    await myServer.variables.HD.Game.MinRespawnDelayOverride.readDetailed();
});

Development

To run tests locally, place a copy of steamcmd.exe in the steamcmd folder. This is used to download OHD and boot a local server for testing purposes. You MUST port forward 7777, 7778, 7779, 27005 (Default)