Commands ⌨️
📄 Introduction
In this section, you’ll find the list of commands available in xWhitelist. These commands allow you to manage the regular whitelist, the maintenance one and get information of the plugin. Below is a table with each command, an example of how to use it, and a brief description of its functionality.
⌨️ Management and information commands
| 💬 Command | 💡 Example | 📄 Description |
|---|---|---|
| /xwhitelist help | /xwhitelist help | Displays a list of all available commands in xWhitelist. Useful if you're unsure about the plugin’s functionalities. |
| /xwhitelist reload | /xwhitelist reload | Reloads the plugin’s configuration and settings. |
| /xwhitelist info | /xwhitelist info | Shows detailed information about the plugin, such as the version and author. |
| /xwhitelist enable | /xwhitelist enable | Enable the Whitelist if it's not enabled on the configuration file. |
| /xwhitelist disable | /xwhitelist disable | Disable the Whitelist if it's enabled on the configuration file. |
| /xwhitelist add <player> | /xwhitelist add xDrygo | Adds a player to the whitelist. |
| /xwhitelist remove <player> | /xwhitelist remove xDrygo | Removes a player from the whitelist. |
| /xwhitelist list | /xwhitelist list | Displays the list of players from the whitelist. |
| /xwhitelist cleanup | /xwhitelist cleanup | Cleans all players from the whitelist. |
| /xwhitelist maintenance enable | //xwhitelist maintenance enable | Enable the Maintenance Whitelist if it's not enabled on the maintenance whitelist configuration file. |
| /xwhitelist maintenance disable | x/xwhitelist maintenance disable | Disable the Maintenance Whitelist if it's enabled on the maintenance whitelist configuration file. |
| /xwhitelist maintenance add <player> | /xwhitelist maintenance add <player> | Adds a player to the Maintenance Whitelist. |
| /xwhitelist maintenance remove <player> | /xwhitelist maintenance remove <player> | Removes a player from the Maintenance Whitelist. |
| /xwhitelist maintenance list | /xwhitelist maintenance list | Displays the list of players from the Maintenance Whitelist. |
| /xwhitelist maintenance cleanup | /xwhitelist maintenance cleanup | Cleans all players from the Maintenance Whitelist. |
📜 Explanation
- General Use: Most of the commands are self-explanatory and are designed to give administrators control over whitelisting within their server.
- Whitelist management: Use the commands
/xwhitelist addand/xwhitelist removeto manage the players from the whitelists and clean all players with the command/xwhitelist cleanup. - Maintenance Whitelist management: The
/xwhitelist maintenance addand/xwhitelist maintenance removeare useful commands for manage the maintenance whitelist, like add players to this whitelist or also remove them. - Enable or Disable whitelists:
Use /xwhitelist <enable/disable> & /xwhitelist maintenance <enable/disable>to manage the status of the whitelist to let the players enter though they are not in the whitelists. - Get the list of players from the whitelists: The
/xwhitelist list & /xwhitelist maintenance listcommands is a great command to get the list of players in the whitelist in-game without open the configuration files of your server.