Using Presets

Install @erlcjs/presets and use the moderation helpers.

@erlcjs/presets exports plain functions that return event callbacks. Pass them directly to client.on(...).

#Install

npm install @erlcjs/presets @erlcjs/core

#Imports

import {
    welcomePlayer,
    banKickRejoin,
    banVehicles,
    VehiclePunishments,
    banLiveries,
    LiveryPunishments,
    banCommand,
    CommandPunishments,
    RDM,
} from '@erlcjs/presets';

#Welcome players

client.on(ERLCEvents.playerJoin, welcomePlayer());
client.on(ERLCEvents.playerJoin, welcomePlayer('Welcome! Please read the rules.'));

#Ban kick-rejoiners

// Default: 30 minutes
client.on(ERLCEvents.playerJoin, banKickRejoin());

// One hour
client.on(ERLCEvents.playerJoin, banKickRejoin(3600));

#Restrict vehicles

client.on(
    ERLCEvents.vehicleAdd,
    banVehicles(
        ['Chevlon Commuter Van 2006'],
        VehiclePunishments.warnThenKick(15),
    ),
);

Add an allowlist of UserIds or permissions as the third argument:

banVehicles(
    ['Chevlon Commuter Van 2006'],
    VehiclePunishments.warnThenKick(15),
    [PlayerPermission.Mod, PlayerPermission.Administrator],
);

#Restrict liveries

client.on(
    ERLCEvents.vehicleAdd,
    banLiveries(['Staff'], LiveryPunishments.warnThenKick(10)),
);

Target one vehicle model:

banLiveries([{ livery: 'Staff', vehicle: Vehicles.CHEVLON_COMMUTER_VAN_2006 }], action);

#Punish commands

client.on(
    ERLCEvents.command,
    banCommand(
        [':admin', ':mod'],
        CommandPunishments.removePermissions(),
        true,
        [PlayerPermission.Owner],
    ),
);

client.on(
    ERLCEvents.command,
    banCommand([':bring all', ':load all'], CommandPunishments.kick(), false),
);

#Detect RDM

// 4+ kills in 30 seconds (defaults)
client.on(ERLCEvents.kill, RDM((log) => log.killer?.kick('RDM')));

// 5+ kills in 60 seconds, administrators exempt
client.on(
    ERLCEvents.kill,
    RDM(
        (log) => log.killer?.ban('RDM'),
        [PlayerPermission.Administrator],
        5,
        60,
    ),
);

#Notes

  • All helpers return callbacks designed for client.on(...).
  • allowlist accepts UserIds and PlayerPermission values.
  • Presets catch and report failed command promises through the client's error event.