Skip to main content

Configuration

FR Guard works perfectly without changing anything after installation. But if you want to tweak something, here are the most useful options explained in plain language.

All options go in your server.cfg using set <option> "<value>".

Main options​

fiverank_token (required)​

Your API Key. Without this FR Guard won't work.

set fiverank_token "frk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

fiverank_language — Language​

Language of the connection cards players see and staff notifications.

set fiverank_language "en"

Valid values: es, en, pt, fr, de. (Default: es.)

fiverank_fail_open — If FiveRank goes down​

What to do if the FiveRank API doesn't respond in time.

set fiverank_fail_open "1"
  • "1" (recommended) — Your server keeps running normally and lets players in. Protection is only lost while the outage lasts.
  • "0" — If the API goes down, nobody gets in. Only use this if you prefer "better close the server than let a cheater in by mistake".

fiverank_debug — Detailed logs​

set fiverank_debug "0"
  • "0" (normal) — only important logs.
  • "1" — detailed logs for every check. Only use this when troubleshooting.

Advanced behavior (optional)​

If you want to tweak finer details, open config.lua inside resources/fiverank_guard/.

Allow players without Discord open?​

FR Guard identifies players by their Discord account. If someone connects without Discord open, they can't be identified.

Config.Behavior.failOpenNoDiscord = false  -- recommended
  • false (recommended) — If they don't have Discord open, they can't join. It's the only way to prevent a cheater from simply closing Discord to bypass the system.
  • true — Let them in anyway. Not recommended.

Refresh bans every X minutes​

If you ban someone from the FiveRank web panel and that player is already connected to your server, FR Guard will automatically kick them on the next "sweep".

Config.Behavior.banSweepMinutes = 3
  • 3 (recommended) — good balance.
  • 1 — faster but more load.
  • 0 — disabled (bans only apply when they reconnect).

requireFiveRankAccount — Require a FiveRank account​

Only allow players whose Discord is linked to a fiverank.gg account.

Config.Behavior.requireFiveRankAccount = false  -- default
  • false (default) — Any player with a clean reputation can join.
  • true — Only players with a FiveRank account can join. Others see the reason and a registration link.

requireWhitelist — Native whitelist (v1.9+)​

Require players to have an approved whitelist request before they can join. This is the most restrictive option: only players you or your staff have explicitly accepted via the FiveRank Whitelist module can enter.

Config.Behavior.requireWhitelist = false  -- default
  • false (default) — Whitelist is not used as an entry gate. Players enter if they pass the reputation check and have no ban.
  • true — A player can only join if they have an approved whitelist request OR have been manually pre-approved by staff from the panel, AND have no active veto.
Recommended combination for serious RP servers
Config.Behavior.requireFiveRankAccount = true
Config.Behavior.requireWhitelist       = true
Config.Behavior.failOpenNoDiscord      = false

With these three options, your server is a fortress: only verified, whitelisted players with a clean reputation can enter.

Rotating your token​

If you think your token has been leaked:

  1. Go to Panel → Servers → [Your server] → FR Guard.
  2. Click Revoke on the current key.
  3. Generate a new one.
  4. Update set fiverank_token in your server.cfg.
  5. Restart the resource: restart fiverank_guard.
Never share your token
  • Don't upload your server.cfg with the token to GitHub, Pastebin or public Discord.
  • Each token only works for one server. Don't reuse tokens across servers.