EGlist - Velocity & BungeeCord

• Installation
• Compatible Plugins
• Configuration files
• Main configuration file
• GUI configuration file
• Available translations
• Make your own translation file
• Commands
• Buy Me a Coffee

Installation

This documentation is for v2 version, unfortunately v1 is no longer maintained.

Download the latest release from SpigotMC or from our CI Server, also you can download an unstable build if you want to contribute to this project! By testing an unstable build and reporting any bug you can help us a lot.

If you are interested to contribute by testing unstable builds, download the latest unstable build from our CI Server.

Prerequisites

• Java 11 or greater is required to run EnhancedGlis for BungeeCord and Velocity.
• Always reload configuration using /egl reload command, never reload the plugin using a plugin manager if not necessary.
• EnhancedGlist is capable of handle vanish plugins to hide players from the lists, like the /glist command, but you may require to install the Spigot version of EnhancedGlist (egl-bridge) to properly handle it, anyway, some plugins brings compatibility with proxies like BungeeCord or Velocity without the needing of install egl-bridge in your spigot servers, for more info click here for installation steps and prerequisites of the Spigot version.
• To enable GUIs you must add Procotolize plugin to your proxy server, check the GUI System section for more information.

BungeeCord

1. First of all, we need to remove the built-in BungeeCord /glist command to remove conflicts with the /glist command registered by EnhancedGlist:
   • Edit modules.yml file located at the root of your BungeeCord folder and remove line jenkins://cmd_list from file. After removing this line, file should look something to:
     

     version: 2
     modules:
     - jenkins://cmd_alert
     - jenkins://cmd_find
     - jenkins://cmd_send
     - jenkins://cmd_server
     - jenkins://reconnect_yaml

   • Go to /modules folder located at the root of your BungeeCord folder and remove cmd_list.jar file if exists.
2. Download latest stable or unstable build from our CI Server or from SpigotMC.
3. Put downloaded file (EnhancedGlist-BungeeCord-X.X.X.jar) inside /plugins folder.
4. Load plugin using a plugin manager, or start/restart your BungeeCord server.
5. Go to /plugins/EnhancedGlist folder and edit configuration files to configure EnhancedGlist.
6. If you have made changes, use /egl reload command to reload plugin.
   • Note: plugin manager is not required to reload EnhancedGlist because EnhancedGlist already does a full reload by using /egl reload command. We recommend you to use /egl reload to do a safe reload.
7. Congragulations! EnhancedGlist is installed on your BungeeCord server.
8. Install the Spigot version of EnhancedGlist to unlock additional features, see this page for more information: https://docs.wirlie.net/books/eglist-spigot-bridge/page/installation

Velocity

1. Download latest stable or unstable build from our CI Server or from SpigotMC.
2. Put downloaded file (EnhancedGlist-Velocity-X.X.X.jar) inside /plugins folder.
3. Load plugin using a plugin manager, or start/restart your Velocity server.
4. Go to /plugins/enhanced-glist-velocity folder and edit configuration files to configure EnhancedGlist.
5. If you have made changes, use /egl reload command to reload plugin.
   • Note: plugin manager is not required to reload EnhancedGlist because EnhancedGlist already does a full reload by using /egl reload command. We recommend you to use /egl reload to do a safe reload.
6. Congragulations! EnhancedGlist is installed on your Velocity server.
7. Install the Spigot version of EnhancedGlist to unlock additional features, see this page for more information: https://docs.wirlie.net/books/eglist-spigot-bridge/page/installation

GUI System

EnhancedGlist uses Protocolize as an additional dependency for making visual menus using the classic Chest inventories from game. To enable this feature you must add Protocolize to your BungeeCord or Velocity server, to download the latest version of Protocolize go to: https://www.spigotmc.org/resources/protocolize-protocollib-for-bungeecord-waterfall-velocity.63778/.

If you have Protocolize installed and you want to disable GUI System from EnhancedGlist, edit config.conf file located inside of the data folder of EnhancedGlist and set use-gui-menu property to false, then use /egl reload command to apply changes.

Compatible Plugins

This documentation is for v2 version, unfortunately v1 is no longer maintained.

List of all compatible plugins which EnhancedGlist will hook to unlock additional features, all plugins are optional and are not required by EnhancedGlist to work.

Your plugin is not listed here? Don't worry! Feel free to make a suggestion and we will check if your suggested plugin can be added to EnhancedGlist.

Configuration files

Main configuration file

This documentation is for v2 version, unfortunately v1 is no longer maintained.

Main configuration file contains most of the features of EnhancedGlist and you can edit this by editing config.conf file located inside of the data folder of EnhancedGlist.

Default configuration file should look something similar to this:

do-not-edit-this {
  # Do not edit this
  config-version="BUILD_COMMIT_HASH"
}

commands {
  glist {
    # Label to use for /glist command
    label="glist"
    # Permission required to execute /glist command
    permission="egl.commands.glist"
    # Optional, define aliases for /glist command
    aliases=["globalist"]
    # If enabled, a GUI will be displayed when a player executes this command
    # If disabled, data will be displayed in chat
    # To use this feature you must add Protocolize to your proxy:
    # https://www.spigotmc.org/resources/protocolize-protocollib-for-bungeecord-waterfall-velocity.63778/
    use-gui-menu=true
  }

  slist {
    # Label to use for /slist command
    label="slist"
    # Permission required to execute /slist command
    permission="egl.commands.slist"
    # Optional, define aliases for /slist command
    aliases=["serverlist"]
    # If enabled, a GUI will be displayed when a player executes this command
    # If disabled, data will be displayed in chat
    # To use this feature you must add Protocolize to your proxy:
    # https://www.spigotmc.org/resources/protocolize-protocollib-for-bungeecord-waterfall-velocity.63778/
    use-gui-menu=true
  }

  egl {
    # Label to use for /egl command
    label="egl"
    # Permission required to execute /egl command
    # Warning!!! This is a privileged command, only give this permission to administrators.
    permission="egl.commands.egl"
    # Optional, define aliases for /egl command
    aliases=["serverlist"]
  }
}

general {
  # Prefix for chat messages
  prefix="<bold><aqua>EGlist ></aqua></bold><reset>"
  # Supported languages: en (english), es (spanish)
  language="en"
  # Players per row (/slist)
  players-per-row=2
  # Players to display per page (/slist)
  players-per-page=16
  # Cache configuration
  cache {
    # Cache players that are connected in a certain server (/slist)
    server-players {
      # Set true to enable this cache
      enable=true
      # Number of seconds to keep the cache, after this period cache will be refreshed
      time=20
    }
  }
  # If empty servers should be hidden (when server has no players connected)
  hide-empty-servers=true
  # Number of servers to display on each page (/glist)
  servers-per-page=8
  # The number of players required to display a server (/glist), set 0 to always display empty servers.
  min-players-required-to-display-server=0
  # If server names should be displayed as uppercase (/glist and /slist)
  display-server-name-uppercase=false
}

behavior {
  # Related to vanish
  vanish {
    # If vanish should be handled by plugin
    enable=true
    # If vanished players should be hidden, useful if you want /glist to be used by players.
    hide-vanished-users=true
    # Permission to allow a player to see vanished players in /glist
    hide-bypass-permission="egl.bypass.vanish.hide"
  }

  # Related to AFK state
  afk {
    # If AFK state should be handled by plugin
    enable=true
  }
}

# Updater configuration
updates {
  # If plugin should check for new updates
  check-for-updates=true
  # Period to check for updates in seconds
  check-interval=300
  # Notifications
  notify {
    # Notify when a player joins to proxy
    on-join {
      # Enable this notification
      enable=true
      # Milliseconds to delay update message sent in chat (if an update is available)
      delay=2500
      # Only players with this permission can see the update message (if an update is available)
      permission="ebcl.update.notify"
    }

    # Console notification
    console {
      # Enable this notification
      enable=true
      # Notification interval in seconds
      notification-interval=1800
    }
  }
}

# Servers to ignore, all servers in this list will be hidden from /glist
# Also ignored servers will not be taken in account for server groups.
ignore-servers {
  # Ignore servers by exact name
  by-name=[
    "login1",
    "login2",
    "login3"
  ]
  # Ignore servers that match RegEx pattern
  # You can use this tool to test a RegEx expression: https://regexr.com/
  by-pattern=[
    "login.*"
  ]
}

# Group servers, useful if you have multiple instances of a same server
group-servers {
  # Example: lobby1, lobby2, lobby3 and lobby4 servers will be grouped as one server named "lobby"
  lobby=[
    "lobby1",
    "lobby2",
    "lobby3",
    "lobby4"
  ]
  # Example: all servers that start with "bedwars-lobby" and "bedwars-game" will be grouped as one server named "bedwars"
  bedwars {
    # RegEx pattern.
    # You can use this tool to test a RegEx expression: https://regexr.com/
    patterns=[
      "bedwars-game.*",
      "bedwars-lobby.*"
    ]
  }
}

Configuration properties

group-servers {
  lobby=[
    "lobby1",
    "lobby2",
    "lobby3",
    "lobby4"
  ]
}

group-servers {
  lobby=[
    patterns=[
      "lobby.*"
    ]
  ]
}

group-servers {
  lobby=[
    "lobby1",
    "lobby2",
    "lobby3",
    "lobby4"
  ]
  bedwars {
    patterns=[
      "bedwars-game.*",
      "bedwars-lobby.*"
    ]
  }
}

GUI configuration file

This documentation is for v2 version, unfortunately v1 is no longer maintained.

This configuration provides you all configurations related to GUI used by /glist and /slist command. For /glist command you must edit gui-glist-menu.conf file and for /slist command you must edit gui-slist-menu.conf file.

Take note that some configurations are common between both configurations. Also, due to technical limitations, console is not capable of view inventories, so in such case, console will always render chat messages for /glist and /slist commands.

Follow Installation steps to enable GUI feature, otherwise these configurations will not have any effect.

Common configuration between /glist and /slist

pattern="1 2 3 4 5 6 7 8 9"

background {
  pattern="1 B 1 2 S 2 1 N 1"
  definitions {
    i1 {
      material="LIME_STAINED_GLASS_PANE"
      display-name=" "
    }
    ...
  }
}

background {
  pattern="1 B 1 2 S 2 1 N 1"
  definitions {
    mB="previous-page-item
    mN="next-page-item"
    ...
  }
}

  background {
    pattern="1 B 1 2 S 2 1 N 1"
    definitions {
      i1 {
        material="LIME_STAINED_GLASS_PANE"
        display-name=" "
      }
      i2 {
        material="YELLOW_STAINED_GLASS_PANE"
        display-name=" "
      }
      iS {
        material="PLAYER_HEAD"
        display-name="<aqua>Ver todos los servidores"
        player-head {
          skin-hash="eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvZGZjM2MyNDNmYzA4OTRhYTQwMjhkMzJiMTlhODMwYTJmY2FkYzI5MzI3MGI0Y2IzMmMxYmFlNDJjNzhjMDhiZSJ9fX0="
        }
        on-click {
          run-command = "glist"
        }
      }
      mB="previous-page-item"
      mN="next-page-item"
      iE {
        material="YELLOW_STAINED_GLASS_PANE"
        amount=1
        display-name="<red>¡Ítem de ejemplo!"
        lore=[
          "<gray>lore línea 1",
          "<aqua>lore línea 2",
          "<green>lore línea 3"
        ]
        on-click {
          send-chat="<yellow>¡Hola <player>!"
          run-command="glist"
          close-menu=true
        }
        player-head {
          skull-owner="Wirlie"
          skin-hash="ewogICJ0aW1lc3RhbXAiIDogMTY1OTA0NzQ3MDM5OSwKICAicHJvZmlsZUlkIiA6ICI4N2RlZmVhMTQwMWQ0MzYxODFhNmNhOWI3ZGQ2ODg0MyIsCiAgInByb2ZpbGVOYW1lIiA6ICJTcGh5bnhpdHMiLAogICJzaWduYXR1cmVSZXF1aXJlZCIgOiB0cnVlLAogICJ0ZXh0dXJlcyIgOiB7CiAgICAiU0tJTiIgOiB7CiAgICAgICJ1cmwiIDogImh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvYjg0MThjZGExM2Y1OTAxMmM4MTVkNmRiYTNlZDgzODUyZGExNzU5YzdiOTVjYTczYTFlNmM0YmNiMzI2MTg1MyIKICAgIH0KICB9Cn0="
        }
      }
    }
  }

/glist configuration (gui-glist-menu.conf)

data-format {
  custom-items {
    lobby-servers {
      by-regex="lobby.*"
      material="PLAYER_HEAD"
      amount=-1
      display-name="<yellow>Lobby Server"
      lore=[
        "<white><player-count></white> <aqua>online players</aqua>",
        " ",
        "<yellow>Click to view player list."
      ]
      player-head {
        skin-hash="eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvZDY3ZGYzNWI3YTgwMjdkZGM4M2M5MTlkNzNmMGEzOTk4YWQ1NGViMGQ5NzNlZjcxNmFlNTA1YzY3NTU4MTBmNyJ9fX0="
      }
  }
}

/slist configuration (gui-slist-menu.conf)

Available translations

This documentation is for v2 version, unfortunately v1 is no longer maintained.

Currently available languages:

To change language of EnhancedGlist see: Main configuration file

To contribute with an additional translation, contact me via Discord: Wirlie#0001

Make your own translation file

This documentation is for v2 version, unfortunately v1 is no longer maintained.

To make your own translation edit language configuration from main configuration and set it to anything else except already existing languages codes.

For example, you can make your own portuguese translation by setting the language configuration to pt, then reload EnhancedGlist by using /egl reload command . This will generate a new file called pt.conf containing all translations from English language. Edit this new file with your own translations and use /egl reload to apply changes.

Commands

This documentation is for v2 version, unfortunately v1 is no longer maintained.

List of default commands, note that you can configure all commands from the main configuration.

Buy Me a Coffee

Hello! 👋 My main focus is to make software with high quality and innovation 💡. I love my work and I hope that you enjoy my work 🤗.

Your collaboration is very appreciated, if you want to help my work you can do it becoming a sponsor of my projects.

I am satisfied if you enjoy my work, but if you want to help me to improve my tools for making better software 💻, then you should definitively become a sponsor 🙂.

To become a sponsor, visit: https://github.com/sponsors/Wirlie