PixelMOTD

Dec 28, 2020
PixelMOTD
  • [​IMG]

    Welcome to the WIKI page for PixelMOTD.


    Configuration: Files Preview(top)


    [​IMG]

    IMPORTANT:
    Wiki page is only for players using PixelMotd v8.8.6-Alpha3+

    Settings.yml:
    Code (YAML):
    settings:
      update-check
    : true
      hexColors
    : true
      checkAlphaUpdates
    : true
      warn-external-modules
    : true
      toggle-dev-api
    : true
      notify-for-external-modules
    : true
      customExternalModulesFolder
    :
        toggle
    : true
        customFolder
    : ExternalModules
      defaultUnknownUserName
    : UnknownPlayer
    events
    :
      exampleEvent
    :
        eventName
    : Example Event
        eventDate
    : 12/21/20 23:59:00
        TimeZone
    : ECT
        format-Type
    : FIRST
        endMessage
    : '&cThe event finished.'
    timings
    :
      second
    : second
      seconds
    : seconds
      minute
    : minute
      minutes
    : minutes
      hour
    : hour
      hours
    : hours
      day
    : day
      days
    : days
      week
    : week
      weeks
    : weeks
    edit.yml:
    Code (YAML):
    messages:
      reload
    : '&aThe plugin was reloaded correctly in <ms>ms.'
      no-perms
    : '&cYou need permission <permission> for this command.'
      whitelist-enabled
    : '&aWhitelist Status now is &b&lENABLED&a.'
      whitelist-disabled
    : '&aWhitelist Status now is &c&lDISABLED&a.'
      status-enabled
    : '&aThe whitelist status of the %type% &b%value% &anow is &b&lENABLED&a.'
      status-disabled
    : '&aThe whitelist status of the %type% &b%value% &anow is &c&lDISABLED&a.'
      whitelist-player-add
    : '&a%type% &e%player% &awas &badded &ato the whitelist.'
      whitelist-player-remove
    : '&a%type% &e%player% &awas &cremoved &afrom the whitelist.'
      already-whitelisted
    : '&a%type% &e%player% &ais already in the whitelist!'
    whitelist
    :
      toggle
    : false
      author
    : Console
      customConsoleName
    :
        toggle
    : true
        name
    : Console
      permissionBypass
    : pixelmotd.whitelist.bypass
      check-mode
    : LoginEvent
      kick-message
    :
     - ' '
      - '&cYou were removed from the %type%!'
      - '&cWhitelist Status Enabled by %whitelist_author%'
      - ' '
      players-name
    :
     - md_5
      players-uuid
    :
     - 0-0-0-0
    blacklist
    :
      toggle
    : false
      kick-message
    :
     - ' '
      - '&cYou were removed from the %type%!'
      - '&cYou''re in the black list of the server!'
      - '&eYour nick
    : &f%nick%'
      - ' '
      players-name
    :
     - md_5
      players-uuid
    :
     - 0-0-0-0
      - MyNameIsBlocked
      - ImAHacker
     
    modules.yml:
    Code (YAML):
    modules:
      block-users
    :
        enabled
    : false
        ignoreCase
    : true
        blockedUsers
    :
       - 0-0-0-0
        - MyNameIsBlocked
        - ImAHacker
        kickMessage
    :
       - '&b------------- &aPixelMOTD &b-------------'
        - '&fYou has been kicked from the server'
        - '&fYour name is in the blackList'
        - '&b%blocked_name%'
        - '&b------------- &aPixelMOTD &b-------------'
      block-words-in-name
    :
        enabled
    : false
        ignoreCase
    : false
        blockedWords
    :
       - hacker
        - '123456789'
        - racist
        - Stupid
        kickMessage
    :
       - '&b------------- &aPixelMOTD &b-------------'
        - '&fYou has been kicked from the server'
        - '&fYour name has a blocked word.'
        - '&b%blocked_word%'
        - '&b------------- &aPixelMOTD &b-------------'
      server-whitelist
    :
        toggle
    : false
        kickMessage
    :
       - '&b------------ &aPixelMotd &b------------'
        - '&aThis %type% is currently in whitelist.'
        - '&c%type%: &f%value%'
        - '&cWhitelist by
    : &f%whitelist_author%'
        - '&cReason
    : &f%whitelist_reason%'
        - '&b------------ &aPixelMotd &b------------'
        (worlds-servers)
    :
          (world-server)Name
    :
            whitelist-status
    : false
            whitelist-author
    : RetiredUniverse44
            whitelist-reason
    : This %type% is whitelisted!
     
    normal-motd.yml:
    Code (YAML):
    normal:
      exampleMotd1
    :
        line1
    : '&b&lPixelMOTD v%plugin_version%'
        line2
    : '&f&oThis motd only appear for 1.8 - 1.15'
        otherSettings
    :
          customHover
    :
            toggle
    : true
            hover
    :
           - '     &9&lPIXEL MOTD'
            - '&7SpigotMC Plugin v%plugin_version%'
            - ''
            - '&b&lInformation:'
            - '  &7Version
    : &f%plugin_version%'
            - '  &7Spigot ID
    : &f37177'
            - '  &7Discord
    : &fMrUniverse#2556'
            - '  &7Online
    : &f%online%&7/&f%max%'
            - '  &frigox.club/discord/dev'
            - ''
          customIcon
    :
            toggle
    : true
            customFile
    : false
          customProtocol
    :
            toggle
    : true
            changeProtocolVersion
    : false
            protocol
    : PixelMotd System
          customHexMotd
    :
            toggle
    : true
            line1
    : '&b&lPixelMOTD v%plugin_version%'
            line2
    : '&f&oThis motd only appear for 1.16+'
          customMaxPlayers
    :
            toggle
    : true
            mode
    : HALF-ADD
            values
    :
           - 2021
            - 2022
     
    whitelist-motd.yml:
    Code (YAML):
    whitelist:
      exampleMotd1
    :
        line1
    : '&8» &aPixelMOTD v%plugin_version% &7| &aSpigotMC'
        line2
    : '&f&oThis server is in whitelist. (1.8-1.15 Motd)'
        otherSettings
    :
          customHover
    :
            toggle
    : true
            hover
    :
           - '     &c&lPIXEL MOTD'
            - '&7SpigotMC Plugin v%plugin_version%'
            - ''
            - '&c&lInformation:'
            - '  &7Whitelist by
    : &f%whitelist_author%'
            - '  &7Spigot ID
    : &f37177'
            - '  &7Discord
    : &fMrUniverse#2556'
            - '  &7Online
    : &f%online%'
            - '  &frigox.club/discord/dev'
            - ''
          customIcon
    :
            toggle
    : true
            customFile
    : false
          customProtocol
    :
            toggle
    : true
            changeProtocolVersion
    : false
            protocol
    : PixelMotd Security
          customHexMotd
    :
            toggle
    : true
            line1
    : '&8» &cPixelMOTD v%plugin_version% &7| &cSpigotMC'
            line2
    : '&f&oWhitelist Mode (1.16+ Motd)'
          customMaxPlayers
    :
            toggle
    : true
            mode
    : HALF
            values
    :
           - 2021
            - 2022
     
    timer-motd.yml:
    Code (YAML):
    timers:
      exampleMotd1
    :
        enabled
    : false
        line1
    : '&6&l%event_timeLeft%'
        line2
    : '&f&oThis is a timer motd'
        otherSettings
    :
          customHover
    :
            toggle
    : true
            hover
    :
           - '     &9&lPIXEL MOTD'
            - '&7This is a timer motd'
            - '&7When you enable 1 motd'
            - '&7And you have 1 event with'
            - '&7the same name it will be'
            - '&7Sync. And when an event'
            - '&7End, it will execute commands'
            - '&7By the console automatically!'
            - '&frigox.club/discord/dev'
            - ''
          customIcon
    :
            toggle
    : true
            customFile
    : false
          customProtocol
    :
            toggle
    : true
            changeProtocolVersion
    : false
            protocol
    : PixelMotd System
          customHexMotd
    :
            toggle
    : true
            line1
    : '&6&l%event_timeLeft%'
            line2
    : '&f&oThis motd only appear for 1.16+'
          customMaxPlayers
    :
            toggle
    : true
            mode
    : HALF-ADD
            values
    :
           - 2021
            - 2022
        timerSettings
    :
          commandsToExecute
    :
         - /pmotd whitelist off
          - /alert Maintenance off automatically!
     

    PixelMOTD: Server Icon(top)


    You can put infinitly Server-ICON
    New Folder ServerIcon
    [​IMG]
    And here you can put server-icons:
    [​IMG]
    In the folder Normal you can put .png icons 64x64 and Icons on this folder only works for Normal mode and the same system for Whitelist Folder

    Configuration: BungeeCord & Spigot - customFile(top)

    In PixelMOTD v8.2+ you have a new option in the configuration of your motd
    Code (YAML):


          <MOTD NAME>
    :
            customServerIcon
    :
              toggle
    : true
              customFile
    : true # < This new option
    When you enable this option and you reload the plugin or the server, this option create a new folder inside the Server Icon folder with the format.
    "<MotdMode>-<MotdName>"
    Example:
    [​IMG]
    <MotdMode> = Whitelist and Normal.
    <MotdName> = Your motd name.
    if you have enabled this option and you put an image 64x64 (Important) for this motd the plugin only select images from this folder.

    Example Demostration:



    Configuration: BungeeCord & Spigot - Change Protocol Version(top)


    (This option is in spigot in the v7.5+)

    if this option is enabled, all players can see the ProtocolMessage, if this option is disabled only players in a unsupported version of the bungee can see the message.
    (This option is enabled by default in Whitelist Mode)

    [​IMG]


    Examples:
    Example #1
    Code:
    Code (YAML):
    protocol: '&aHello%server_icon%&7%online%&8/&7%max%'
    [​IMG]

    Example #2
    Code (YAML):
    protocol: '&aNow in Spigot%server_icon%'
    [​IMG]


    PixelMOTD: Variables(top)


    %online_[servername]% [ONLY BUNGEECORD] | Original Online Players
    %online_[worldname]% [ONLY SPIGOT] | Show size of players in a world
    %online% | Original Online Players
    %max% | Original Max Players
    %status_[worldname] [ONLY SPIGOT] | Show Whitelist Status of a world.
    %status_[servername] [ONLY BUNGEECORD] | Show Whitelist Status of a server.
    %status% | Show Whitelist Status.
    %whitelist_author% | This variable show who toggled the whitelist
    %plugin_author% | Credits Variable
    %plugin_version% | Plugin Version

    <centerText> | This is only for motd Lines. This variable center all The text.

    %server_icon% | Only Protocol Message. Put a big space to show the text after the server-icon ;)


    PixelMOTD: Modes(top)

    PixelMOTD have 5 types (for now):
    |- EQUAL
    |- ADD
    |- CUSTOM-VALUES
    |- HALF
    |- HALF-ADD


    EQUAL: The size of Online Players is the same size of MaxPlayers in the Bungee/Spigot Motd.

    ADD: The size of MaxPlayers is +1 of OnlinePlayers

    Example:
    OnlinePlayers: 11
    With this mode the size of MaxPlayers is 12


    Custom Values: The size of MaxPlayers is editable by you.

    The size is a random integer of the configuration.

    Example:
    Code (YAML):

        motd
    :
          <MOTD>
    :
            players
    :
              toggle
    : true
              max-size
    :
             - 123
              - 124
              - 125
    In the motd the Max-Players is a random integer of max-size.
    can be 123,124 or 125.

    With Half Mode if you have 50 players in the server, Max players = 25

    The Max Players = Online Players / 2

    With Half Add Mode if you have 50 players in the server, Max players = 75

    The Max Players = (Online Players / 2) + Online Players

    PixelMOTD: Events(top)

    From 8.7+ you can create infinities events.
    template:
    Code (YAML):
    events:
      exampleEvent
    :
        eventName
    : Example Event
        eventDate
    : 8/29/20 17:00:00
        TimeZone
    : GMT-5
        endMessage
    : '&cThe event finished.'
        format-Type
    : FIRST


    Events: Types(top)


    with format-Type you can change the result of the time left.

    EXAMPLE:
    [​IMG]
    CONFIG HOVER:
    Code (YAML):

              - '     &9&lPIXEL MOTD'
              - '&7SpigotMC Plugin v%plugin_version%'
              - ''
              - '&b&l%event_firstType_name%:'
              - '  &7%event_firstType_TimeLeft%'
              - ''
              - '&b&l%event_secondType_name%:'
              - '  &7%event_secondType_TimeLeft%'
              - ''
              - '&b&l%event_ThirdSecond_name%:'
              - '  &7%event_ThirdSecond_TimeLeft%'
              - ''
              - '&b&lNetwork Information:'
              - '  &7Online
    : &f%online%'
              - '  &7Website
    : &fPixelPC.net'
              - ''

     
    CONFIG TIME EXAMPLE:
    Code (YAML):
    events:
      firstType
    :
        eventName
    : First format Type
        eventDate
    : 8/29/20 17:00:00
        TimeZone
    : GMT-5
        endMessage
    : '&cThe event finished.'
        format-Type
    : FIRST
      secondType
    :
        eventName
    : Second format Type
        eventDate
    : 8/29/20 17:00:00
        TimeZone
    : GMT-5
        endMessage
    : '&cThe event finished.'
        format-Type
    : SECOND
      ThirdSecond
    :
        eventName
    : Third format Type
        eventDate
    : 8/29/20 17:00:00
        TimeZone
    : GMT-5
        endMessage
    : '&cThe event finished.'
        format-Type
    : THIRD

    Events: Variables(top)


    | %event_<event>_name%

    Get the name of a Event

    | %event_<event>_TimeZone%

    Get the TimeZone of a Event

    | %event_<event>_TimeLeft%


    Get the Time Left of a Event

    Whitelist: Check-Mode(top)

    This is a new option of 8.3 version.
    In this option you can only put 2 options:
    LoginEvent and PostLoginEvent
    this option select an event for Whitelist-CheckPlayer.
    In the PostLoginEvent you have the permission for Whitelist-Bypass pixelmotd.whitelist.bypass.
    Default: LoginEvent
    Recommended: LoginEvent, PreLoginEvent is not tested

    Default Modules: block-users(top)


    When you enable this module all names in the module are blocked in the server.
    Example:
    Code (YAML):

    modules
    :
      block-users
    :
        enabled
    : false
        ignoreCase
    : true
        blockedUsers
    :
       - MyNameIsBlocked
        - ImAHacker
        kickMessage
    :
       - '&b------------- &aPixelMOTD &b-------------'
        - '&fYou has been kicked from the server'
        - '&fYour name is in the blackList'
        - '&b%blocked_name%'
        - '&b------------- &aPixelMOTD &b-------------'
     
    if a player with the name MyNameIsBlocked or ImAHacker tries join to the server, the plugin kick the player with the eventModule-kickMessage

    Default Modules: block-words-in-name(top)


    Example:
    Code (YAML):

    modules
    :
      block-words-in-name
    :
        enabled
    : false
        ignoreCase
    : false
        blockedWords
    :
       - hacker
        - '123456789'
        - Stupid
        kickMessage
    :
       - '&b------------- &aPixelMOTD &b-------------'
        - '&fYou has been kicked from the server'
        - '&fYour name has a blocked word.'
        - '&b%blocked_word%'
        - '&b------------- &aPixelMOTD &b-------------'
     
    if the player has hacker or 123456789 or Stupid in the player's name,Example: ImTheBestHacker, the player is kicked from the server with the eventModule-kickMessage.

    Default Modules: Option - IgnoreCase(top)


    Personally i don't recommend enable the option IgnoreCase this option isn't 100% efficient.

    When this option is enabled if the player name is ImAPro and in the configuration the word or the name imapro is blocked, the plugin ignore Uppercase and LowerCase and kick the player.

    External Modules: Information(top)

    From PixelMOTD v8.8.6-FinalRelease
    Everybody can create External Modules for PixelMOTD with PixelMOTD DevAPI.
    You can limit DevAPI in the settings.yml to prevent the bad usage of the DevAPI.
  • Loading...
  • Loading...