Feature guide: Header & Footer

Content

• About
• Enabling
• Configuration
  • Global settings
  • Per-world / per-server
  • Per-group / per-player
• Disabling in worlds / servers

About

Minecraft feature introduced in 1.8 showing text above and below playerlist. It cannot be displayed on 1.7 clients in any way.

Enabling

To enable this feature, open config.yml and set

header-footer:
  enabled: true

Configuration

Global settings

The example above is using this configuration:

header-footer:
  header:
  - "This is the first line of header"
  - "2nd line of header"
  footer:
  - "This is the first line of footer"
  - "2nd line of footer"

It is the default header/footer for everyone, unless overridden in some way.

Per-world / per-server

header-footer:
  per-world:
    <your world>:
      header:
        - "Header in specified world"
      footer:
        - "Footer in specified world"
  per-server:
    <your server>:
      header:
        - "Header in specified server"
      footer:
        - "Footer in specified server"

For multiple worlds/servers to share the same settings, separate them with a;.
For worlds/server starting with a specified text, use * after shared part.
Example:

per-world:
  world1;world2:
    header:
      - "Shared header in worlds world1 and world2"
  lobby-*:
    header:
      - "Header in all worlds starting with lobby-"

Note: To make per-world work on BungeeCord, install the TAB-Bridge plugin on your backend servers.

Per-group / per-player

groups.yml

MyGroup:
  header:
    - "This is a header for MyGroup group"
  footer:
    - "This is a footer for MyGroup group"
per-world:
  MyWorld:
    TestGroup:
      header:
        - "Header for group TestGroup in world MyWorld"

Same for users, which can be configured in users.yml.

Disabling in worlds / servers

header-footer:
  disable-in-worlds:
    - disabledworld
  disable-in-servers:
    - disabledserver

To disable the feature in all worlds except listed ones, add WHITELIST keyword to the list, which will make it a list of enabled worlds / servers instead. Example:

header-footer:
  disable-in-worlds:
    - WHITELIST
    - enabledworld

Note: Disabling in servers is BungeeCord only. To make disabling in worlds work on BungeeCord, install TAB-Bridge plugin on backend servers.