📖Getting Started

1️⃣ Installation

To get started with xWhitelist, you first need to install the plugin on your Minecraft server. Follow these steps for proper installation:

Requirements: You will need Spigot or Paper, as the plugin is not compatible with CraftBukkit.
Optional Dependencies: PlaceholderAPI is an optional dependency that you can use to enhance the functionality of placeholders within xWhitelist.

Once the plugin is downloaded, simply place it in your server's plugins folder and restart or reload the server. You can check more details about installation in our installation section.

2️⃣ Create and Manage Whitelist

Now that you have xWhitelist installed, let’s learn how to manage the whitelist on your server.

✨ Enable the Whitelist

To enable the Whitelist, use the following command:

/xwhitelist enable

🛠️ Managing the Whitelist

Add a player to the Whitelist To add a player to the whitelist, use the command:
```
/xwhitelist add <player>
```
Example: /xwhitelist add xDrygo will add the player xDrygo to the whitelist.
Remove a player to the Whitelist To remove a player from the whitelist, execute:
```
/xwhitelist remove <player>
```
Example: /xwhitelist remove xDrygo will remove the player xDrygo to the whitelist.
Get the list of players on the Whitelist To get information about the list of players, execute:
```
/xwhitelist list
```
Example: /xwhitelist list will display the list of players from the whitelist.

🚧 Using the Maintenance Whitelist

Enable or Disable the Maintenance Whitelist The commands that manage the status of the maintenance whitelist are:
```
/xwhitelist maintenance enable - /xwhitelist maintenance disable
```
Example: /xwhitelist maintenance enable will enable the maintenance whitelist, execute:
Add a Player to the Maintenance Whitelist To add a player to the maintenance whitelist, use the command:
```
/xwhitelist maintenance add <player>
```
Example: /xwhitelist maintenance add xDrygo will add the player xDrygo to the maintenance whitelist
Clean all the Players from the Maintenance Whitelist To remove all the players from the maintenance whitelist, use:
```
/xwhitelist maintenance cleanup
```
Example: /xwhitelist maintenance cleanup will remove all the players from the maintenance whitelist.

3️⃣ More Resources

For more information on other commands, permissions, and configurations, check out the following sections:

Plugin
Configuration Files

Now you're ready to start managing the whitelist on your server with xWhitelist. If you need more help, feel free to continue exploring our wiki. 🚀

PreviousSetup xWhitelist NextCommands

Last updated 3 months ago