/plugin-gateguard

NFive plugin to control client server access with a whitelist or blacklist

Primary LanguageC#GNU Lesser General Public License v3.0LGPL-3.0

GateGuard NFive Plugin

License Build Status Release Version

This plugin allows you to control who can connect to your NFive FiveM GTAV server with either a whitelist or blacklist.

Rules can be permanently added in the YAML configuration file as well as dynamically managed in the database.

Installation

Install the plugin into your server from the NFive Hub: nfpm install NFive/plugin-gateguard

Configuration

# Mode can be "whitelist" or "blacklist"
mode: whitelist

# Message to show users who are blocked
message: You are not whitelisted

# Require players to to have a Steam ID
steam:
  required: true
  message: You must be running Steam to play on this server

# Permanent general access rules
rules:
  # IP addresses
  ips:
  - 127.0.0.1

  # FiveM license keys
  licenses:
  - abcdef1234567890abcdef1234567890abcdef12

  # Steam IDs in ID64 format
  # Use https://steamid.io to convert formats
  steam:
  - 12345678901234567

database:
  # How often to completely reload blocks from the database
  # This shouldn't need to be changed
  reload_interval: 00:30:00