Custom rules

Custom rules let you handle things that the built-in detections do not know about. A rule has three parts:

1. an event that happens on your server,
2. optional conditions that decide whether the rule matches,
3. one or more actions that run in order when it does.

For example: when a vehicle model you do not allow is about to be created, block it and post a message to your staff channel.

Rules live on the Rules page. You need the Custom Rules permission, and because rules can ban players and fire server events, give it to very few people. Rules run on your server, so they work even while the dashboard is closed.

Create a rule#

1. Click Create Rule.
2. Give it a name (up to 80 characters) and leave Enabled on.
3. Under When this event happens, pick an event.
4. Under Only if these conditions match, add conditions. Leave it empty to match every occurrence.
5. Under Then..., add actions and drag them into the order you want.
6. Click Save rule. The rule is sent to your server immediately.

A live preview shows the condition as an expression while you build it. Each rule shows how often it was triggered and when last, and can be switched on and off, edited, duplicated or deleted.

Events#

An event that can be blocked can be cancelled by a rule before the game applies it.

Conditions#

A condition compares a field of the event with a value.

Fields#

Every event has three base fields:

Event specific fields are written data.<name>:

Pick Custom field... to type any other field, for example data.myField. Any simple value of the event can be read, so a field that a newer FiveM version adds works too. A field may be up to four levels deep, like data.a.b.

Operators#

Join conditions with AND or OR. AND is evaluated before OR. A rule can have up to 20 conditions.

Actions#

A rule can have up to 10 actions, run in order.

Reasons are limited to 200 characters, a Discord message to 1500 and a payload to 2000.

Placeholders#

In reasons, Discord messages and trigger payloads you can use these placeholders, which are replaced when the rule fires:

{source}  {name}  {event}  {rule}  {timestamp}  {data.x}

For example, a ban reason of Spawned blocked model {data.model} becomes Spawned blocked model -1281684762.

What to expect at runtime#

• Whitelisted admins are not punished. When txAdmin Whitelist is on, admins are never banned or kicked by a rule. See Permissions and whitelisting.
• A player is punished at most once every 15 seconds by rules. Further ban or kick actions in that window are skipped as player was punished moments ago.
• Webhooks are rate limited. A rule posts to Discord at most 5 times per 10 seconds, so an event that fires constantly cannot flood your channel. Mentions are always disabled.
• Rules are checked strictly. A rule with any invalid part is dropped as a whole instead of running with a condition missing, because a missing condition could make a ban rule match far more than you meant.
• Dev Mode applies. While Dev Mode is on, kick and ban actions are only logged. Block actions on events other than playerConnecting still cancel the event.
• The console tells you. A matched rule prints a line like "Block restricted vehicles" matched entityCreating from Player [12] -> block, discord, at most every 3 seconds per rule and player.

Limits per server: 100 rules, 20 conditions and 10 actions per rule.

Example: block a vehicle model#

1. Event: entityCreating.
2. Conditions: data.entityType equals 2 AND data.model equals the model hash from the Asset Explorer.
3. Actions: Block Event, then Discord Log with the message {name} [{source}] tried to spawn a blocked vehicle ({data.model}).

Test it with Dev Mode first. The console shows when it matches and what it would do.