User Guide

Prerequisites

• A Spigot or Paper Minecraft server (API version 1.13 or later)
• Operator (op) permissions on the server

First Steps

After installing the plugin and restarting your server, nether portal creation is prevented by default for all non-allowed players. Portal usage prevention is disabled by default and must be enabled via configuration.

Use /nac help in-game or from the console to see all available commands.

Common Scenarios

Allowing a Player to Access the Nether

/nac allow <playerName>

This adds the player to the nether access whitelist. They will be able to create and use nether portals (depending on your configuration).

Denying a Player Nether Access

/nac deny <playerName>

This removes the player from the nether access whitelist.

Viewing the Whitelist

/nac list

This displays all players currently allowed to access the nether.

Preventing Portal Usage

By default, only portal creation is blocked. To also block portal usage:

/nac config set preventPortalUsage true

Customising Denial Messages

/nac config set denyUsageMessage 'You are not allowed to enter the nether.'
/nac config set denyCreationMessage 'You cannot create nether portals.'

The message must be enclosed in single quotes, even when it is one word. Apostrophes inside the message are kept: everything between the first and the last single quote is used.

When the Whitelist Is Saved

Changes made with /nac allow and /nac deny take effect at once, but the whitelist is only written to plugins/NetherAccessController/allowedPlayers.json when the plugin is disabled, normally when the server stops. If the server crashes or is killed, every change made since it last started is lost. Stop the server cleanly (/stop) to keep them.

Recovering an Unreadable Whitelist

The whitelist is stored in plugins/NetherAccessController/allowedPlayers.json. If that file cannot be read at startup — because it is empty, or was truncated by a crash part-way through a save — the plugin reports it in the server log and renames it to allowedPlayers.json.unreadable, then starts with an empty whitelist so that portal restrictions stay in force.

A file set aside earlier is never overwritten by a later one. If allowedPlayers.json.unreadable is already there, the next destination is numbered — allowedPlayers.json.unreadable.2, then .3, and so on. The server log names the path used on each occasion.

No player has nether access until the whitelist is rebuilt. Rebuild it with /nac allow <playerName>, or stop the server, repair the renamed file by hand and restore it to its original name before starting again.

Permissions