PixelMOTD - Historical

Applied By XxrogerxX: Sep 12, 2020 at 11:20 PM

PixelMOTD
[​IMG]

Welcome to the WIKI page for PixelMOTD.


Configuration: BungeeCord Preview(top)


[​IMG]

Global BungeeCord preview:
Code (YAML):

config
:
  check-update
: true
  Hex-System
: true
  motd
:
    normal
:
      first
:
        line1
: '&8» &7PixelMOTD v%plugin_version% | &bSpigotMC'
        line2
: '&aFirst Motd'
        hover
:
          toggle
: false
          hoverText
:
         - '     &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%'
          - '  &fpixelpc.net/discord/dev'
          - ''
        customServerIcon
:
          toggle
: true
          customFile
: false
        customProtocol
:
          toggle
: false
          protocol
: PixelMOTD 1
          changeProtocolVersion
: false
        players
:
          toggle
: true
          max-size
:
         - 2020
          - 2021
          - 2022
          mode
: CUSTOM-VALUES
      second
:
        line1
: '&8» &7PixelMOTD v%plugin_version% | &bSpigotMC'
        line2
: '&aSecond Motd'
        hover
:
          toggle
: true
          hoverText
:
         - '     &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%'
          - '  &fpixelpc.net/discord/dev'
          - ''
        customServerIcon
:
          toggle
: true
          customFile
: false
        customProtocol
:
          toggle
: false
          protocol
: PixelMOTD 1
          changeProtocolVersion
: false
        players
:
          toggle
: true
          max-size
:
         - 2020
          - 2021
          - 2022
    whitelist
:
      first
:
        line1
: '&8» &7PixelMOTD v%plugin_version% | &eSpigotMC'
        line2
: '&7This server is in whitelist.'
        hover
:
          toggle
: true
          hoverText
:
         - '     &9&lPIXEL MOTD'
          - '&7SpigotMC Plugin v%plugin_version%'
          - ''
          - '&b&lInformation:'
          - '  &7Whitelist by
: &f%whitelist_author%'
          - '  &7Spigot ID
: &f37177'
          - '  &7Discord
: &fMrUniverse#2556'
          - '  &7Online
: &f%online%'
          - '  &fpixelpc.net/discord/dev'
          - ''
        customServerIcon
:
          toggle
: true
        customProtocol
:
          toggle
: true
          protocol
: PixelMOTD 2
          changeProtocolVersion
: true
        players
:
          toggle
: true
          max-size
:
         - 2020
          - 2021
          - 2022
          mode
: CUSTOM-VALUES

events
:
  exampleEvent
:
    eventName
: Example Event
    eventDate
: 8/29/20 17:00:00
    TimeZone
: GMT-5
    endMessage
: '&cThe event finished.'
    format-Type
: FIRST
timings
:
  second
: second
  seconds
: seconds
  minute
: minute
  minutes
: minutes
  hour
: hour
  hours
: hours
  day
: day
  days
: days
  week
: week
  weeks
: weeks

 

Configuration: Spigot Preview(top)


Global Spigot Preview:
Code (YAML):

config
:
  check-update
: true
  Hex-System
: true
  motd
:
    normal
:
      first
:
        line1
: '&8» &aMOTD 1'
        line2
: '&bThis is the first motd'
        hover
:
          toggle
: true
          hoverText
:
         - '     &9&lPIXEL MOTD'
          - ''
          - '&b&lInformation:'
          - '  &7This is the first motd'
          - ''
        customProtocol
:
          toggle
: true
          protocol
: PixelMOTD
          changeProtocolVersion
: false
        customServerIcon
:
          toggle
: true
          customFile
: false
        players
:
          toggle
: true
          max-size
:
         - 2020
          - 2021
          - 2022
          mode
: CUSTOM-VALUES
      second
:
        line1
: '&8» &aMOTD 2'
        line2
: '&bThis is the second motd'
        hover
:
          toggle
: true
          hoverText
:
         - '     &9&lPIXEL MOTD'
          - ''
          - '&b&lInformation:'
          - '  &7This is the second motd'
          - ''
        customProtocol
:
          toggle
: true
          protocol
: PixelMOTD
          changeProtocolVersion
: false
        customServerIcon
:
          toggle
: true
          customFile
: false
        players
:
          toggle
: true
          max-size
:
         - 2020
          - 2021
          - 2022
          mode
: CUSTOM-VALUES
    whitelist
:
      first
:
        line1
: '&8» &7PixelMOTD v%plugin_version% | &eSpigotMC'
        line2
: '&7This server is in whitelist.'
        hover
:
          toggle
: true
          hoverText
:
         - '     &9&lPIXEL MOTD'
          - '&7SpigotMC Plugin v%plugin_version%'
          - ''
          - '&b&lInformation:'
          - '  &7Whitelist by
: &f%whitelist_author%'
          - '  &7Spigot ID
: &f37177'
          - '  &7Discord
: &fMrUniverse#2556'
          - '  &7Online
: &f%online%&7/&f%max%'
          - '  &fpixelpc.net/discord/dev'
          - ''
        customProtocol
:
          toggle
: true
          protocol
: '&aServer in &bWhitelist'
          changeProtocolVersion
: true
        customServerIcon
:
          toggle
: true
          customFile
: false
        players
:
          toggle
: true
          max-size
:
         - 2020
          - 2021
          - 2022
          mode
: CUSTOM-VALUES
      second
:
        line1
: '&8» &7PixelMOTD v%plugin_version% | &eWhitelist'
        line2
: '&7Try in another moment.'
        hover
:
          toggle
: true
          hoverText
:
         - '     &9&lPIXEL MOTD'
          - '&7SpigotMC Plugin v%plugin_version%'
          - ''
          - '&b&lInformation:'
          - '  &7Whitelist by
: &f%whitelist_author%'
          - '  &7Spigot ID
: &f37177'
          - '  &7Discord
: &fMrUniverse#2556'
          - '  &7Online
: &f%online%&7/&f%max%'
          - '  &fpixelpc.net/discord/dev'
          - ''
        customProtocol
:
          toggle
: true
          protocol
: '&aServer in &bWhitelist'
          changeProtocolVersion
: true
        customServerIcon
:
          toggle
: true
          customFile
: false
        players
:
          toggle
: true
          max-size
:
         - 2020
          - 2021
          - 2022
          mode
: CUSTOM-VALUES

events
:
  exampleEvent
:
    eventName
: Example Event
    eventDate
: 8/29/20 17:00:00
    TimeZone
: GMT-5
    endMessage
: '&cThe event finished.'
    format-Type
: FIRST
timings
:
  second
: second
  seconds
: seconds
  minute
: minute
  minutes
: minutes
  hour
: hour
  hours
: hours
  day
: day
  days
: days
  week
: week
  weeks
: weeks

 

Configuration: BungeeCord & Spigot - 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):
config:
  check-update
: true
  motd
:
    normal
:
      <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]


Configuration: BungeeCord & Spigot - 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
%whitelist_author% | This variable show who toggled the whitelist
%plugin_author% | Credits Variable
%plugin_version% | Plugin Version

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

Configuration: BungeeCord & Spigot - Players Mode(top)

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

Configuration: BungeeCord & Spigot - Equal Mode(top)

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

Configuration: BungeeCord & Spigot - Add Mode(top)

ADD: The size of OnlinePlayers is -1 of MaxPlayers

Example:

OnlinePlayers: 11

With this mode the size of MaxPlayers is 12

Configuration: BungeeCord & Spigot - Custom Values(top)

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

The size is a random integer of the configuration.

Example:
Code (YAML):
config:
  check-update
: true
  motd
:
    first
:
      normal
:
        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.

Configuration: BungeeCord & Spigot - Half Mode(top)


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

The Max Players = Online Players / 2

Configuration: BungeeCord & Spigot - Half Add Mode(top)


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

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

Configuration: 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

Configuration: Events - formatType (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

Configuration: 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: BungeeCord - 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

Modules: Module - 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

Modules: Module - 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.

Modules: 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.