⚙️ Configuration

Everything the editor writes ends up in modules/motd.yml. Behind a proxy the same tree lives in the proxy's own config.yml, one level deeper, under motds, so motd.server-icon here is motds.motd.server-icon there.

What each option does in the editor is on the MOTD and Player Count pages, and every one of them accepts placeholders.

This is the whole file with every option in use at once:

enabled: true
motd:
    motds:
        '0':
            - '                 &d&lPHOENIX LOBBY MOTD'
            - '          &8Learn more at &7&nwww.phoenixplugins.com'
        '1':
            - '                 &d&lPHOENIX LOBBY MOTD'
            - '            &8Come check out our &7&ncool plugins&8!'
    server-icon: 'winter'
    player-count:
        text: 'JOIN'
        hover:
            - ' &7HELLO'
        online-players: '10'
        max-players: '344'
        extra-players: 100
        hide-players: false
        hide-players-hover: false
    maintenance:
        enabled: true
        motd:
            - '                &c&lUNDER MAINTENANCE'
            - '              &8We will be back in &7{timer}'

#Options

Option	What it does	Example
enabled	Whether the module touches the ping at all. false hands the message, the icon and the count back to server.properties, and only the maintenance motd is still applied.	enabled: true
motd.motds	The message variants. Each numbered key holds one variant of two lines, and one variant is picked at random on every ping. The numbers are only ids, so they have to be unique and quoted.	see Message Variants below
motd.server-icon	Name of a 64x64 png inside the servericons folder, written without the .png. Empty keeps the server's own server-icon.png.	server-icon: 'winter'
motd.player-count.text	Free text drawn where the online/max numbers usually are. Empty keeps the numbers. Filling it in also puts the red incompatible-version marker on your entry.	text: 'JOIN'
motd.player-count.hover	Lines shown when the count is hovered, in place of the player sample. Empty keeps the real sample.	hover: [' &7HELLO']
motd.player-count.online-players	Overrides the first number. Written as a string so placeholders fit; anything that does not come out as a number is ignored and the real count is used.	online-players: '10'
motd.player-count.max-players	Overrides the second number, which is otherwise the slot count from server.properties.	max-players: '344'
motd.player-count.extra-players	Reports the maximum as however many players are online plus this number, so the server never looks full. Ignored while max-players is set.	extra-players: 100
motd.player-count.hide-players	Drops the count from the ping entirely, so nothing is drawn where the numbers usually are.	hide-players: false
motd.player-count.hide-players-hover	Removes the hover list without touching the numbers.	hide-players-hover: false
motd.maintenance.enabled	Whether a running maintenance replaces the message variants with its own message.	enabled: true
motd.maintenance.motd	The lines shown while a maintenance is running. {timer} is how much time is left. The server icon and the player count around it still apply.	see Maintenance Message below

#Message Variants

Two variants, picked between at random on every ping. Dropping one of the two lines is fine, and so is a single variant, which then shows every time.

motd:
    motds:
        '0':
            - '&d&lYOUR SERVER'
            - '&7A new message of the day.'
        '1':
            - '&d&lYOUR SERVER &7- &b{player name}'
            - '&7Welcome back!'

#Custom Icon

Shows servericons/winter.png next to the message. A larger image is scaled down to 64x64 for you.

motd:
    server-icon: 'winter'

#Never Looking Full

Keeps the bar from ever filling up, since the maximum is always however many players are online plus 100.

motd:
    player-count:
        max-players: ''
        extra-players: 100

#Text Instead Of The Numbers

Replaces 12/100 with a word. Remember that the client only draws text there for a version it cannot join, so the entry is marked as incompatible while this is set.

motd:
    player-count:
        text: 'JOIN'

#Notice In The Hover

The hover is the one place in the list where more than two lines fit, which makes it the spot for a rules note or a vote link.

motd:
    player-count:
        hover:
            - '&d&lEVENT THIS WEEKEND'
            - '&7Saturday at 18:00'
            - ''
            - '&8Vote at &7&nwww.example.com/vote'

#Keeping Names Private

Leaves the count honest while keeping the list of who is online out of the ping.

motd:
    player-count:
        hide-players: false
        hide-players-hover: true

#Maintenance Message

While a maintenance is running these lines replace the message variants, and everything else in the section keeps applying, so the icon and the count stay whatever you set them to.

motd:
    server-icon: 'maintenance'
    player-count:
        text: 'CLOSED'
    maintenance:
        enabled: true
        motd:
            - '                &c&lUNDER MAINTENANCE'
            - '              &8We will be back in &7{timer}'

Turning it off with enabled: false leaves the normal variants showing through a maintenance. What starts and ends one is on the Maintenance page.