Skip to main content

Ban System

A built-in, identifier- and token-based ban system. When enabled, it creates the msk_bansystem database table on resource start, checks every connecting player against the stored bans, and drops banned players with the ban reason and expiry. Bans match on all player identifiers (steam, license, discord, …) as well as the player's hardware tokens, so a ban cannot be evaded by changing a single identifier.

All functions are server-side only.

Config​

Config.BanSystem = {
    enable = true, -- Set to true if you want to use this Feature

    discordLog = false, -- Set true to enable DiscordLogs // Add Webhook Link in modules/Ban/server.lua
    botColor = "6205745",
    botName = "MSK Scripts",
    botAvatar = "https://i.imgur.com/PizJGsh.png",

    commands = {
        enable = true,
        groups = {'superadmin', 'admin', 'god'}, -- ACE groups allowed to use the commands
        ban = 'banPlayer',
        unban = 'unbanPlayer'
    }
}
Discord Webhook

The Discord webhook link is not in the config. Set discordLog = true and insert your webhook URL at the top of modules/Ban/server.lua:

-- Insert you Discord Webhook here
local webhookLink = "https://discord.com/api/webhooks/"

Both bans and unbans are logged via MSK.AddWebhook.

MSK.BanPlayer​

This will ban a player. The ban (identifiers, tokens, time, reason) is stored in msk_bansystem and the target is dropped immediately.

Parameters
playerId - number - The ServerId of the player who issues the ban - Optional (pass 0 or nil when calling from the server/console)
targetId - number - The ServerId of the player who gets banned
time - string - The time until the player gets unbanned
reason - string - The reason why the player gets banned

Description — time format:

  • 1M = 1 Minute
  • 1H = 1 Hour
  • 1D = 1 Day
  • 1W = 1 Week
  • P = Permanent
MSK.BanPlayer(playerId, targetId, time, reason)

-- Player gets banned for 2 days for cheating
MSK.BanPlayer(playerId, targetId, '2D', 'cheating')

-- Player gets permanently banned
MSK.BanPlayer(playerId, targetId, 'P', 'cheating')

-- If you execute this from the server/console
MSK.BanPlayer(0, targetId, '2D', 'cheating')

-- As an Export:
exports.msk_core:BanPlayer(playerId, targetId, time, reason)

MSK.UnbanPlayer​

This will unban a player by deleting the ban entry from msk_bansystem.

Parameters
playerId - number - The ServerId of the player who issues the unban - Optional (pass 0 or nil when calling from the server/console)
banId - number - The BanId (the id column in the msk_bansystem table)

MSK.UnbanPlayer(playerId, banId)

-- Example: unban BanId 5 from the server/console
MSK.UnbanPlayer(0, 5)

-- As an Export:
exports.msk_core:UnbanPlayer(playerId, banId)

MSK.IsPlayerBanned​

Checks whether the given player matches a stored ban (by identifier or token).

Parameters
playerId - number - The ServerId of the player

Returns
isBanned - boolean or table - false if not banned, otherwise the ban entry (id, ids, reason, time, from, tokens)
isExpired - boolean - true if the matched ban has already expired

local isBanned, isExpired = MSK.IsPlayerBanned(playerId)

if isBanned and not isExpired then
    -- Player is banned
    print(isBanned.id, isBanned.ids, isBanned.reason, isBanned.time, isBanned.from)
elseif isBanned and isExpired then
    -- Player was banned but the Ban is expired
    print(isBanned.id, isBanned.reason, isBanned.time)
else
    -- Player is not banned
end

-- As an Export:
local isBanned, isExpired = exports.msk_core:IsPlayerBanned(playerId)

Commands​

The commands are only registered when Config.BanSystem.enable and Config.BanSystem.commands.enable are true. They are restricted to the ACE groups defined in Config.BanSystem.commands.groups and can also be run from the server console (allowConsole = true).

/banPlayer​

Parameters
playerId - number - The ServerId of the player who gets banned
time - string - The time until the player gets unbanned (1M, 1H, 1D, 1W, P)
reason - string - The reason why the player gets banned - Optional, default: 'Unknown reason'

/banPlayer playerId time reason

-- Example 1: Player 1 banned for 2 days for cheating
/banPlayer 1 2D "Cheating"

-- Example 2: Player 1 permanently banned
/banPlayer 1 P "Cheating"

/unbanPlayer​

Parameters
banId - number - The BanId

/unbanPlayer banId

-- Example: BanId 5 gets unbanned
/unbanPlayer 5