NWLConfiguration - NobelD/NobleWhitelist GitHub Wiki

Whitelist

  • Enabled: true or false

    • If the whitelist is enabled. (this changes with the command)

  • Skip Name Change: true or false

    • This will prioritize uuid's over names, it will also disable some name checks and name updates, this may be ignored if skip-uuid-save is enabled.

  • Checking: DISABLED, OPTIONAL or REQUIRED

    • DISABLED: ignored when checking, all disabled will allow any player to join unless they have a disabled entry.
    • OPTIONAL: treats all optional checking as a single check, if another optional is successfully all will be too.
    • REQUIRED: if the checking is not met the player will not be able to join.

  • Only op as permission: true or false

    • Only op player counts for a permission check, skips the permission string.

  • Use custom permission: true or false

    • Allows to use a custom permission, if enabled the permissions by levels is disabled.

  • Custom permission:

    • The custom permission to check for the player.

  • Permission minimum number: number

    • Defines a permission level where players with the same or greater permission level can be counted for the permission check.
    • This only apply to users with "noblewhitelist.bypass.", players with noblewhitelist.bypass will bypass the level.
    • Set to -1 to disable the permission levels.

  • Auto Register: true or false

    • Any player who joins will be added to the whitelist.
    • In most scenarios this will only work if the whitelist is disabled. (useful to only save player who have joined)

  • Enforce Name If Different Name:

    • THIS DOES NOTHING, IT WAS A WORKAROUND FOR AN UNWANTED ISSUE.
    • BETTER USE "SKIP UUID SAVE" FOR NAME ONLY WHITELIST OR "SKIP NAME CHANGE" TO PRIORITIZE UUID'S.

  • Skip uuid save: true or false

    • The whitelist will not auto save the uuid of the players. (saving is useful to track premium players, you may enable it for name only whitelist)

  • Vanilla whitelist modify type:

    • Available values:
    • DISABLED: disables the vanilla whitelist command and ignores the vanilla whitelist
    • IGNORE: ignores the vanilla whitelist
    • NONE: does nothing

Storage

  • Storage type:

    • The storage type for the whitelist.
    • MYSQL: Remote database, it can be used in multiple server, but it may have some latency.
    • SQLITE: Local database, very fast and easy management when expecting a lot of players.
    • YAML: Easy to read and edit.
    • JSON: Fast storage, it may be a little confusing to read.
    • TOML: Similar as json but more readable.

  • Host:

    • The url or ip where the database is hosted.

  • Port:

    • The port of the host for the database.

  • Database:

    • Name of the database.

  • User:

    • Username from the credentials to access the database.

  • Password:

    • Password from the credentials to access the database.

  • Action if fail: NONE, CLOSE, BLOCK or COMMAND

    • NONE: The plugin will not make nothing (probably it will also print errors)
    • CLOSE: The server will be closed.
    • BLOCK: Will block the players to join the server.
    • COMMAND: Same as none but it will execute an command.

  • Command if fail:

    • The command to be executed if the action is set to command.

Extra Storage Settings:

These options goes on the same level as storage.

  • Connection Timeout:

    • A number in minutes to set the connection timeout of the database.

  • Max Lifetime:

    • A number in minutes to set the max lifetime of the database.

  • Use SSL: ´true or false´

    • If true enables the settings below, encrypts the connection, useful if the database is not in the same host

  • Allow Public Key Retrieval: true or false

  • Server RSA Public Key File:

    • Path to the RSA public key if key retrieval is forbidden.

  • SSL Mode: Required (unchecked SSL connection), VerifyCA (verify CA), VerifyFull (verify CA and matching hostname)

    • Verification requirements for the server.

Messages

All messages uses the MiniMessages Format, some messages can use internal placeholders, such as:

  • <prefix> The plugin prefix, if disable the prefix then will not show anything.
  • <player> The player name.
  • If the message is a empty string "" then will not be showed or sended. (disables the message)

  • Prefix:

    • This will be used as the prefix of all messages of the plugin.

  • Use Prefix: true or false

    • Disable it if you dont want to show the prefix.

  • Not Whitelisted:

    • This message will be showed to the player who tries to join and is not whitelisted.

  • Name Change Console:

    • Console message if a player name is changed since their uuid is present (mostly for premium players)

  • Name Change User:

    • Player message if their name is changed since their uuid is present (mostly for premium players)

Version

  • Notify Update: true or false

    • Disable it if you dont want to be notified when a new update is available.

  • Version:

    • INTERNAL CONFIG VALUE, DO NOT MODIFY, THIS MAY FORCE CHANGES AND CREATE ERRORS.

Default Config

whitelist:
  enabled: false
  skip-name-change: false
  # DISABLED - will not be used when checking.
  # OPTIONAL - will be an option when checking.
  # REQUIRED - will be necessary for the player
  checking:
    name: OPTIONAL
    uuid: OPTIONAL
    perm: DISABLED
  only-op-as-permission: false
  use-custom-permission: false
  custom-permission: "example.permission"
  permission-minimum-number: -1
  auto-register: false
  enforce-uuid-if-different-name: true
skip:
  skip-uuid-save: false
storage:
  # mysql - Remote storage that can be used in multiple server.
  # sqlite - Faster storage for easy management when expecting a lot of players.
  # yaml - Simple editable storage and easy to use.
  # json - Faster storage than yaml, a little confusing to read.
  # toml - Faster as json and easier to read as yaml.
  storage-type: sqlite
  host: ''
  port: 3306
  database: ''
  user: ''
  password: ''
  # These are extra advanced options to manage the database.
  # <!> Only enable and use if you know what are you doing, these settings may
  #connection-timeout: 30
  #max-lifetime: 30
  #use-ssl: false
  #allow-public-key-retrieval: false
  #server-rsa-public-key-file: ""
  #ssl-mode: required
  # Actions:
  # NONE - does nothing
  # CLOSE - closes the server
  # BLOCK - blocks the players join
  # COMMAND - executes a command
  action-if-fail: NONE
  command-if-fail: ""
messages:
  prefix: "<bold><#17B90C>N<#7FD024>Whitelist</bold> <grey>>"
  use-prefix: true
  # <player> = Player name
  # <prefix> = Message prefix (if disabled will not be showed)
  not-whitelisted: "<red>You are not whitelisted on this server."
  name-change-console: "<prefix><yellow><name> has joined with another name (probably a premium player)"
  name-change-player: "<green>Successfully validated uuid, welcome back <name>!"
version:
  notify-update: true
  version: 3
⚠️ **GitHub.com Fallback** ⚠️