Module map

Find your way around nusagate.yml, see what each section controls, and learn how to switch modules on and off safely.

On this page

All NusaGate protection lives in one file, nusagate.yml, in the proxy folder. This page is a map of that file so you know which section to open for each job.

How nusagate.yml is organised

NusaGate creates nusagate.yml on first start and never overwrites it afterwards. The file is grouped into a few top-level sections:

SectionWhat it controls
editionWhich edition this JAR is. Set automatically; you do not need to change it.
performancePacket compression, batching, Bedrock fast paths and the memory leak guard.
anti-botEverything that decides whether a new connection is a real player or a bot.
anti-exploit-securityProtection against broken or malicious game data, plus block lists.
reliability-uxKick messages, languages, console behaviour during attacks and, in PRO, alerts and reconnects.
admin-integrationAdmin commands, network commands, the built-in ViaVersion and, in PRO, the web dashboard.

Every module inside these sections has its own enabled switch and its own settings, including the kick-message players see when that module blocks them. Settings that only exist in PRO are ignored by the Free JAR.

Performance

ModuleWhat it does
packet-compression-batchingSkips compression for small packets, groups packets together, and uses lighter compression during attacks to save CPU.
bedrock-optimizationDetects Geyser and Floodgate players and avoids double compression and extra checks for them.
memory-leak-guardWatches proxy memory and cleans up sessions that were left behind.

The file itself advises tuning these only when you have measured a real bottleneck. Velocity already performs well with the defaults.

Anti-bot

This is the largest section. Free modules include the attack detector, connection and login rate limits, slow-bot, timeout and slow-drip checks, the domain check, light client verification, the protocol attribute guard, bot-name patterns, the chat and login-command flood guard, adaptive escalation and the MOTD protection.

PRO adds Sentinel Limbo verification, the interactive CAPTCHA, the verified-player trust cache, Reconnect Check, Account Guard, Nickname Guard, the attack join queue and the port DoS shield.

Each module is explained in plain language on Anti-bot and anti-exploit.

Anti-exploit and security

ModuleEditionWhat it does
exploit-fixesFreeCloses connections that send invalid or abusive protocol data.
backend-payload-shieldFreeCaps and filters plugin messages before they reach a backend server.
static-blacklistFreeYour permanent list of blocked IP addresses, CIDR ranges and player names.
packet-firewallPROPacket and bandwidth limits per connection and per IP address.
anti-vpnPROVPN, proxy and hosting detection through providers you configure, with optional ASN and ISP blocks and the Country Guard.
proxy-blocklist-feedsPROBlocks addresses from public proxy lists. Off by default.
passthrough-modePROScreens new players before Mojang authentication. Off by default.
bridge-process, native-tcp-check, kernel-country-blockPROLinux-only checks through a separate privileged helper. Skipped automatically elsewhere.
live-blacklistPROLoads a shared blacklist feed from a separate credentials file.

Reliability and messages

ModuleEditionWhat it does
localizationFreeEnglish and Indonesian messages, chosen by the player's game language.
kick-reason-honestyFreeGives every kick the same clear layout and limits kick spam during attacks.
selective-attack-loggingFreeKeeps the console readable during attacks with short start, status and end notices.
discord-webhookPROSends alerts to your own Discord webhook. Off until you add a webhook.
seamless-maintenance-reconnectPROMoves players to a fallback server when a backend restarts or goes down.
dynamic-backend-ipPRORe-checks backend hostnames so DNS changes apply without a restart.

Keep your Discord webhook address private. Anyone who has it can post to your channel.

Administration

ModuleEditionWhat it does
built-in-pluginsFreeInstall and update the bundled ViaVersion. See Built-in ViaVersion.
commandsFreeSwitches the /ng command family on or off and sets its permission.
network-commandsFree/alert, /alertraw, /find, /gkick and /ping, each with its own switch and permission.
dashboardPROA private local web dashboard protected by a generated token.

The PRO dashboard only listens on the proxy machine by default. Keep its token private and use an authenticated tunnel if you need remote access.

Switch a module on or off

  1. Open nusagate.yml and find the module.

  2. Change enabled to true or false. For example, to stop limiting chat and login commands:

    anti-bot:
      chat-check:
        enabled: false
  3. Save the file and run /ng reload (or ng reload in the console). Most changes apply right away.

  4. Run /ng diagnostics to confirm. It lists every default module that you switched off.

Next steps

Nusa product documentation · NusaGateFree & PRO editions

Loading the index…