Package Exports

squadclient
squadclient/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (squadclient) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Squad Client

The module enables you to easily perform certain actions by connecting to the game console through your Squad game server using RCON.

Installation

  npm install squadclient

  yarn add squadclient

  pnpm add squadclient

Features

Custom-designed RCON infrastructure.
Obtaining player, team, server, and squad information quickly and easily.
Using promises for asynchronous operations.

Methods

getTeams() - Get team names.
getServerInfo() - Get some info about server.
getLayers() - Get current and next layers.
getSquads() - Get squads and details.
getPlayers() - Get players.

Usage / Examples

import { SquadClient } from 'squadclient';
// For CommonJS -> const { SquadClient } = require('squadclient');

const client = new SquadClient({ host: 'serverIp', port: rconPort, password: 'rconPassword' });

(async () => {
    const info = await client.getServerInfo();

    console.log(info);
})();

License

This project is licensed under the MIT License.

Authors

zédyN (Github - Discord)

Support

For support, DM me on Discord or create a ticket in discord.gg/luppux