Sueta

TemporaryWhiteList

2.4.1

Nicknames based temporary whitelist

·Plugin

Supported storage types:

  • yaml
  • mysql

Commands:

  • twl add <nick> <time/permanent>
    - Аdds a player to the whitelist for a specified time, or, if the player is already in it, adds time.
    - permission: TemporaryWhitelist.Administrate.Add

  • twl remove <nick>
    - Removes all data about player.
    - permission: TemporaryWhitelist.Administrate.Remove

  • twl set <nick> <time/permanent>
    - Sets player whitelisted for time or permanently
    - permission: TemporaryWhitelist.Administrate.Set

  • twl check
    - Shows info about player that used command subscription. This command available for players by default.
    - permission: TemporaryWhitelist.CheckSelf

  • twl check <nick>
    - Shows info about other player subscription.
    - permission: TemporaryWhitelist.Administrate.CheckOther

  • twl enable/disable
    - Enables or disables whitelist.
    - permission: TemporaryWhitelist.Administrate.EnableDisable

  • twl reload
    - Reloads configuration localization and data files.
    - permission: TemporaryWhitelist.Administrate.Reload

  • twl list
    - Shows all players that are present in data storage who can join.
    - permission: TemporaryWhitelist.Administrate.List

  • twl import <minecraft, self-sql, self-yaml, easy-whitelist> [storage specific args]
    - Imports players from selected storage
    - permission: TemporaryWhitelist.Administrate.Import

Time format examples:

  • 100:s,100:m,100:h,100:d,1:y
  • 100:s
  • 100:s,20:s

Placeholders:

  • %twl_plugin_status% - enabled/disabled
  • %twl_player_status% - remaining time/never end/ended.
  • %twl_start_time% - date time when player was added to whitelist
  • %twl_left_time% - remaining time before player will become not whitelisted
  • %twl_end_time% - date time when player will become not whitelisted
  • %twl_permanent% - true/false
Config
#Time between checks if online player become not whitelisted in ticks
SubscriptionEndCheckTicks: 100
#Time to pass between actual-data requests per player. in seconds
#Negative values disables any updates (recommended when data in DataProvider can't be changed by anything other than this plugin)
#0 value enforce plugin to always get actual data (not recommended)
RefreshAfter: 60

#ignore case in nicknames
IgnoreCase: false

#yaml mysql
DataProvider: yaml

#File name to store data about players when DataProvider: yaml
DataFile: "data.yml"

#Data to connect to database when DataProvider: mysql
Mysql:
  Ip: 111.222.333.444
  User: "root"
  Password: "pass"
  Database: "WhiteListDB"
  Table: "WhiteListTable"
  #optional
  Port: 3306
  UseSsl: false
  UseUnicode: true
  AutoReconnect: true
  FailOverReadOnly: false
  MaxReconnects: 2

#File in `translations` folder to use
Translation: "en.yml"

#Players per page when used /twl list command
ListPageSize: 4

#Time formats used in placeholders
DurationFormat: "&bdd 'days' &cHH 'hours' &emm 'minutes' &ass 'seconds'"
DateTimeFormat: "[dd MM yyyy] hh:mm:ss"
Messages config
Kick:
  Connecting:
    - "&b------------------------"
    - "&bYou are not whitelisted!"
    - "&b------------------------"
  WhilePlaying:
    - "&b----------------------------"
    - "&bYou are not whitelisted now!"
    - "&b----------------------------"
NoPermission: "&cNo permission!"
WhiteListStatuses:
  Enabled: "&c&lenabled"
  Disabled: "&a&ldisabled"
PlayerStatuses:
  Undefined: "Info not found"
  NeverEnd: "never end"
  Ended: "ended"

CommandResults:
  Add:
    Usage:
      - Content: "&cIncorrect arguments count"

      - Content:
        - Content: "&c   Use: "
        - Content: "&b&n/twl add <nick> permanent"
          Hover:
            Action: SHOW_TEXT
            Value: "Click to auto complete"
          Click:
            Action: SUGGEST_COMMAND
            Value: "/twl add "

      - Content:
        - Content: "&c   or:  "
        - Content: "&b&n/twl add <nick> <time>"
          Hover:
            Action: SHOW_TEXT
            Value: "Click to auto complete"
          Click:
            Action: SUGGEST_COMMAND
            Value: "/twl add "

    AlreadyPermanent:
      - Content: "&7Player {player} already whitelisted permanent. Nothing changed."

    IncorrectTime:
      - Content: "&cInvalid time. Use <amount>:<time unit>,<amount>:<time unit>... where time units: s,m,h,d,y"
    Success:
      - Content: "&a{player} successfully added to white list for {time}."
    Error:
      - Content: "&cError while adding {player} to whitelist for {time}. Watch console."

  Set:
    Usage:
      - Content: "&cIncorrect arguments count"

      - Content:
        - Content: "&c   Use: "
        - Content: "&b&n/twl set <nick> permanent"
          Hover:
            Action: SHOW_TEXT
            Value: "Click to auto complete"
          Click:
            Action: SUGGEST_COMMAND
            Value: "/twl set "

      - Content:
        - Content: "&c   or:  "
        - Content: "&b&n/twl set <nick> <time>"
          Hover:
            Action: SHOW_TEXT
            Value: "Click to auto complete"
          Click:
            Action: SUGGEST_COMMAND
            Value: "/twl set "
    NothingChanged:
      - Content: "&7Nothing changed about {player}."
    Success:
      - Content: "&a{player} now whitelisted for {time}."
    Error:
      - Content: "&cError while setting {player} whitelisted time to {time}. Watch console."
    IncorrectTime:
      - Content: "&cInvalid time. Use <amount>:<time unit>,<amount>:<time unit>... where time units: s,m,h,d,y"

  Remove:
    Usage:
      - Content: "&cIncorrect arguments count"
      - Content:
        - Content: "&cUse: "
        - Content: "&b&n/twl remove <nick>"
          Hover:
            Action: SHOW_TEXT
            Value: "Click to auto complete"
          Click:
            Action: SUGGEST_COMMAND
            Value: "/twl remove "
    NothingChanged:
      - Content: "&7Nothing changed about {player}."
    Success:
      - Content: "&a{player} success removed from white list."
    Error:
      - Content: "&cError while removing {player} from whitelist. Watch console."

  Check:
    Permanent:
      'True': "Yes"
      'False': "No"
    Usage:
      - Content: "&cIncorrect arguments count"

      - Content:
        - Content: "&c   Use: "
        - Content: "&b&n/twl check"
          Hover:
            Action: SHOW_TEXT
            Value: "Click to use"
          Click:
            Action: RUN_COMMAND
            Value: "/twl check"

      - Content:
        - Content: "&c   or:  "
        - Content: "&b&n/twl check <nick>"
          Hover:
            Action: SHOW_TEXT
            Value: "Click to auto complete"
          Click:
            Action: SUGGEST_COMMAND
            Value: "/twl check "
    Format:
      - Content: "&l------  &b{player}&f&l  ------"
      - Content: " • Permanent: &b{permanent}"
      - Content: " • Time left: &b{time_left}"
      - Content: " • Started: &b{started}"
      - Content: " • Will end: &b{will_end}"
    ForPlayerOnly:
      - Content: "&cFor players only"
    InfoNotFound:
      - Content: "&cInfo about player not found"

  List:
    Usage:
      - Content: "&cIncorrect arguments count"

      - Content:
        - Content: "&c   Use: "
        - Content: "&b&n/twl list"
          Hover:
            Action: SHOW_TEXT
            Value: "Click to use"
          Click:
            Action: RUN_COMMAND
            Value: "/twl list"

      - Content:
        - Content: "&c   or:  "
        - Content: "&b&n/twl list <page>"
          Hover:
            Action: SHOW_TEXT
            Value: "Click to auto complete"
          Click:
            Action: SUGGEST_COMMAND
            Value: "/twl list "
    IncorrectPage:
      - Content: "&cIncorrect page"
    ListIsEmpty:
      - Content: "&cList is empty"
    Header:
      - Content: "&l--------  &bList&f&l  --------"
    PlayerFormat:
      - Content: " {number}) &b{player}"
        Click:
          Action: RUN_COMMAND
          Value: "/twl check {player}"
        Hover:
          Action: SHOW_TEXT
          Value: "&bClick to watch info"
    PagesSwitch:
      - Content:
        - Content: "    <---    "
          Click:
            Action: RUN_COMMAND
            Value: "/twl list {previous_page}"
          Hover:
            Action: SHOW_TEXT
            Value: "&bPrevious page"
        - Content: "   {page}/{total_pages}   "
          Click:
            Action: SUGGEST_COMMAND
            Value: "/twl list {page}"
          Hover:
            Action: SHOW_TEXT
            Value: "&bEnter page"
        - Content: "    --->"
          Click:
            Action: RUN_COMMAND
            Value: "/twl list {next_page}"
          Hover:
            Action: SHOW_TEXT
            Value: "&bNext page"
  Import:
    Usage:
      - Content: "&cIncorrect arguments count"

      - Content:
        - Content: "&c   Use: "
        - Content: "&b&n/twl import <type> [type specific arguments]"
          Hover:
            Action: SHOW_TEXT
            Value: "Click to auto complete"
          Click:
            Action: SUGGEST_COMMAND
            Value: "/twl import"
    ImportFromSelf:
      - Content: "&cYou can't import from currently used data provider"
    IncorrectTime:
      - Content: "&cInvalid time. Use <amount>:<time unit>,<amount>:<time unit>... where time units: s,m,h,d,y"
    IncorrectPermanent:
      - Content: "&cInvalid permanent. Use true or false"
    Success:
      - Content: "&aData successfully imported in &b{time_elapsed}"

      - Content: " • Found: &b{found_count}"
        Hover:
          Action: SHOW_TEXT
          Value: "{found}"
      - Content: " • Without error: &b{without_error_count}"
        Hover:
          Action: SHOW_TEXT
          Value: "{without_error}"
      - Content: " • With error: &b{with_error_count}"
        Hover:
          Action: SHOW_TEXT
          Value: "{with_error}"
    Error:
      - Content: "&cError while importing"
    SuccessfullyStarted:
      - Content: "&aImporting successfully started. Wait for results"

    MinecraftDefault:
      Usage:
        - Content: "&cIncorrect arguments count"

        - Content:
          - Content: "&c   Use: "
          - Content: "&b&n/twl import minecraft <default time> <default permanent>"
            Hover:
              Action: SHOW_TEXT
              Value: "Click to auto complete"
            Click:
              Action: SUGGEST_COMMAND
              Value: "/twl import minecraft 0:s true"
    SelfSql:
      Usage:
        - Content: "&cIncorrect arguments count"

        - Content:
          - Content: "&c   Use: "
          - Content: "&b&n/twl import self-sql"
            Hover:
              Action: SHOW_TEXT
              Value: "Click to use"
            Click:
              Action: RUN_COMMAND
              Value: "/twl import self-sql"
    SelfYaml:
      Usage:
        - Content: "&cIncorrect arguments count"

        - Content:
          - Content: "&c   Use: "
          - Content: "&b&n/twl import self-yaml"
            Hover:
              Action: SHOW_TEXT
              Value: "Click to use"
            Click:
              Action: RUN_COMMAND
              Value: "/twl import self-yaml"
    EasyWhiteList:
      Usage:
        - Content: "&cIncorrect arguments count"

        - Content:
          - Content: "&c   Use: "
          - Content: "&b&n/twl import easy-whitelist <default time> <default permanent>"
            Hover:
              Action: SHOW_TEXT
              Value: "Click to auto complete"
            Click:
              Action: SUGGEST_COMMAND
              Value: "/twl import easy-whitelist 0:s true"
      PluginNotFound:
        - Content: "&cError while getting EasyWhiteList plugin. Make sure that it is installed or try another version"

  Enable:
    Success:
      - Content: "&aWhitelist successfully enabled"
    NothingChanged:
      - Content: "&7Whitelist already enabled"
    Error:
      - Content: "&cError while enabling whitelist"

  Disable:
    Success:
      - Content: "&aWhitelist successfully disabled"
    NothingChanged:
      - Content: "&7Whitelist already disabled"
    Error:
      - Content: "&cError while disabling whitelist"

  Reload:
    Success:
      - Content: "&aWhitelist successfully reloaded"
    Error:
      - Content: "&cError while reloading whitelist"

  Twl:
    Usage:
      - Content: "&cPlease use correct subcommand:"
      - Content: " • add / set / remove / import"
      - Content: " • list / check"
      - Content: " • enable / disable / reload"

Similar projects

Plugin →