📝config.yml

📄 Introduction

The config.yml file is the core of the xWhitelist plugin configuration. Here, you can define and manage teams, their members, and priorities. This file allows you to customize the team settings to fit your server’s needs, such as the team’s name, the members it includes, and the priority with which they should be treated within the plugin.

💡 Breakdown of the config.yml file

# If is enabled the whitelist (true/false), it can be changed in-game with command /xwhitelist enable and /xwhitelist disable.
enabled: false

• enabled: Defines whether the regular whitelist is enabled, this means whether a player who is not on the whitelist can enter your server. (Options, true, false)

mysql:
  enable: false # Use the database connection instead offline mode (true / false)
  host: localhost # Example: 111.111.111.111 (WITHOUT PORT)
  port: 3306
  database: whitelist_database # Database name
  user: root # Database username
  password: password # Database password.

• mysql: In this section you can configure the MySQL feature of the plugin. If the MySQL mode is enabled and the credentials of the database.

  • enabled: You define if MySQL mode is enabled, to enable this option you must enter your database credentials below for it to work, MySQL mode has a different whitelist than offline mode because it is stored in the database. (Options, true, false)

  • host: You define the IP of the host of your database, you can get it on the credentials page of it. (You need to enter the host without port, the port will be on the port section, usually the port will be 3306) (e.g. 122.131.131.132)

  • port: Specifies the port used to connect to your database host. (Usually '3306')

  • database: You define the name of your database. (e.g. whitelist_database)

  • user: You define the username of your database.

  • password: You define the password of your database.