Skip to content

Connect your own scripts

Only needed when your server bans through a tool FiveSpoof does not pick up by itself.

On this page

Report bans from your script
Let a player in from your tools
Get an event for every case

Report bans from your script

Call reportBan when your script makes a ban, and reportUnban when it lifts one:

exports.fivespoof:reportBan({
    player = source,
    id = banId,
    reason = "aimbot",
    issuer = "anticheat",
    source = "myanticheat"
})

exports.fivespoof:reportUnban(banId, "myanticheat")

issuer: "anticheat" when your anticheat banned by itself, "admin" when your staff did.
source: The name your account shows next to these bans. Letters, digits and underscores.
Offline player: Pass identifiers, a list such as the license and Discord identifier, instead of player.

Let a player in from your tools

unban(code): Lets in a player FiveSpoof banned, by the code they saw, such as FS-4A91. Your own ban, if there is one, stays.
reportUnban(banId, source): Tells FiveSpoof that you lifted your own ban. Every ban FiveSpoof made because of it ends too.

Get an event for every case

When FiveSpoof bans or removes a player, or lets one in as suspicious, your resources can listen for it on the server:

AddEventHandler("fivespoof:case", function(case)
    print(case.result, case.code, case.account, case.name, case.player)
end)

result: "refused" at join, "removed" from the server, or "flagged" for a suspicious player.
player: The server ID while the player is connected.
Staff in the game: With add_ace group.admin fivespoof.staff allow, each case is also a line in your staff's chat.

The event never says why a player was caught, and players cannot send it.