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.

Docs

Follow our documention for more information.

Usage / Examples

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

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

(async () => {
    await client.connect();

    const info = await client.getServerInfo();

    console.log(info);

    client.on('squadCreate', (squad) => {
        console.log('A squad has been created!', `Squad Name: ${squad.squadName} | Team Name: ${squad.teamName}`);
    });
})();

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