TextWhitelist Documentation & Guide
Welcome to the official documentation for the TextWhitelist plugin. This guide covers installation, configuration, all available commands, and permissions.
---
Installation
- Download the latest .jar file.
- Place the downloaded .jar file into your server's `plugins` directory.
- Restart your server. The plugin will automatically generate a `TextWhitelist` folder inside your `plugins` directory, containing `config.yml`, `players.txt`, and `admins.txt`.
Configuration Files
The plugin is managed via three files inside the `plugins/TextWhitelist/` folder.
config.yml
Contains the master switch for the plugin.
- `whitelist-enabled: true` - The plugin is active.
- `whitelist-enabled: false` - The plugin does nothing and allows all players to pass through.
players.txt
The main whitelist file. Add one player name per line. This is used when the plugin is in `PLAYERS` mode.
admins.txt
The maintenance whitelist file. Add one admin/staff name per line. This is used when the plugin is in `ADMINS` mode.
Commands & Usage
The base command is
/whitelistxt (alias:
/wltxt). All subcommands require the `textwhitelist.admin` permission.
Status & Help
Shows the current status (enabled/disabled) and active mode.
Displays a list of all available commands.
Plugin Control
Code (Text):
/wltxt enable
/wltxt disable
Toggles the master switch for the plugin. This setting is saved to `config.yml`.
Code (Text):
/wltxt reload
Reloads both `.txt` files from the disk and enforces the new list on online players.
Mode Management
Code (Text):
/wltxt change <players|admins>
Switches the active mode. Example: `/wltxt change admins`
List Management
Code (Text):
/wltxt add <player|admin> <PlayerName>
Adds a player to the specified list. Example: `/wltxt add player Notch`
Code (Text):
/wltxt remove <player|admin> <PlayerName>
Removes a player from the specified list. Kicks the player if they are online and removed from the active list. Example: `/wltxt remove player Notch`
Permissions
- `textwhitelist.admin`: Grants access to all `/wltxt` commands. This permission is given to server operators (OPs) by default.