LobbyEssentialsRevamped » Config Help

May 14, 2017
LobbyEssentialsRevamped » Config Help
  • LobbyEssentialsRevamped Config Help
    This wiki page will help you understand the config.yml file for LobbyEssentialsRevamped, this is updated to the latest config.yml version so if you want support for an older version of LobbyEssentialsRevamped, please start a conversation with @WulfGamesYT ;)

    Unless you are told you can set a certain value to be disabled completely, please fill in the value anyway, for example you can't leave CompassSettings.DisplayName blank!

    Also, please note that colour codes are supported throughout the majority of this configuration file, use &<id>, for example: &c = red.

    Compass Settings
    Code (Text):
    CompassSettings:
      #The name of the item given to players on join
      DisplayName: '&aSelect Game &7(Right Click)'
      #The lore of the item given to players on join (Set as [] to disable)
      Lore:
      - '&7Right Click the compass to'
      - '&7select a game to play.'
      #The material id of the item given to players on join
      MaterialID: 345
      #The slot in the inventory the item goes to on join
      InventorySlot: 1
      #Whether or not this particular feature is enabled
      Enabled: true
    GUI Settings
    Code (Text):
    GUISettings:
      #The title that appears on the games menu inventory when open
      Title: Select Game To Play
      #The amount of item slots in the inventory, can either be 9, 18, 27, 36, 45 or 54
      Size: 54
    Basic Language Settings
    Code (Text):
    LanguageSettings:
      #The command players can use to open the games menu gui (Set as '' to disable)
      GamesMenuCommandLabel: 'gamesmenu'
      #The text displayed as a hint for players to click this item (Set as '' to disable)
      ClickTag: '&a> Click to play.'
      #The list of messages sent to the player when they login, only visible to that specific player (Set as [] to disable)
      JoinMessage:
      - '&8&m------------------------------------------------'
      - '&7Welcome to our server, thanks for joining &a%name%&7!'
      - '&7This server uses &eLobbyEssentialsRevamped&7.'
      - '&8&m------------------------------------------------'
      #The message shown to everyone in the server when the player joins
      GlobalJoinNotice: '&a[+] &6%name% &7has joined the game.'
      #The message shown to everyone in the server when the player quits
      GlobalQuitNotice: '&c[-] &6%name% &7has left the game.'
      #The title of the tab menu when players press tab (or another key) on their keyboards (Set as '' to disable)
      TabMenuTitle: '\n&e&lWelcome %name%, to our server!&r\n&7Hope you are having fun!\n'
      #The footer of the tab menu when players press tab (or another key) on their keyboards (Set as '' to disable)
      TabMenuFooter: '\n&aVisit our website for more information at:\n&b&lwww.example.com&r\n'
    I have left out MiscSettings as that part is quite self explanitory, if you need help however, don't hesitate to contact me privately!

    Server Settings (Bungee Server Example)

    Code (Text):
    Servers:
      #Give this a standard name, this isn't actually shown in-game, make them unique every server you have here
      TestServer:
        #The name of the gui item displayed
        GUIDisplayName: '&a&lTest Server'
        #The lore of the gui item displayed which might be useful to explain what is on that server, e.g. minigames
        GUILore:
        - '&7This is just a test server, this will'
        - '&7send you to the ''TestServer'' server.'
        - ''
        - '&7There are &e%players% &7players currently online here.'
        #The material id of the gui item displayed
        GUIMaterialID: 257
        #The data short of the gui item displayed, e.g. for wool, you would use 14 (the colour red) (Set as 0 for default)
        GUIMaterialDataShort: 0
        #The slot in the inventory this item is to be placed
        GUISlot: 10
        #Whether or not this item is actually clickable by people
        Clickable: true
        #What happens when players click this item, either EnterServer or PerformCommand
        OnClick: 'EnterServer'
        #The parameters for the command given when clicked, specify the server name for EnterServer or specify a command e.g. warp test if PerformCommand is enabled above
        OnClickParam: 'TestServer'
        #Whether or not to close the inventory when this item is clicked on
        OnClickCloseInventory: true
        #Display a message to the player when they click this item (Set as '' to disable)
        MessageWhenClicked: '&7You are now entering the &c%server% &7server.'
        #Whether or not to display the item in the inventory, useful for upcoming gamemodes that you don't want to show but just setup
        Hidden: false
    Server Settings (Local Server Example)
    Code (Text):
    Servers:
      #Give this a standard name, this isn't actually shown in-game, make them unique every warp/area you have here
      TestWarp:
        #The name of the gui item displayed
        GUIDisplayName: '&a&lTest Warp'
        #The lore of the gui item displayed which might be useful to explain what is in that warp/area, e.g. staff board
        GUILore:
        - '&7This is just a test warp, this will'
        - '&7send you to the ''TestWarp'' warp.'
        #The material id of the gui item displayed
        GUIMaterialID: 257
        #The data short of the gui item displayed, e.g. for wool, you would use 14 (the colour red) (Set as 0 for default)
        GUIMaterialDataShort: 0
        #The slot in the inventory this item is to be placed
        GUISlot: 15
        #Whether or not this item is actually clickable by people
        Clickable: true
        #What happens when players click this item, either EnterServer or PerformCommand
        OnClick: 'PerformCommand'
        #The parameters for the command given when clicked, specify the server name for EnterServer or specify a command e.g. warp test if PerformCommand is enabled above
        OnClickParam: 'warp staffboard'
        #Whether or not to close the inventory when this item is clicked on
        OnClickCloseInventory: true
        #Display a message to the player when they click this item (Set as '' to disable)
        MessageWhenClicked: ''
        #Whether or not to display the item in the inventory, useful for upcoming warps/areas that you don't want to show but just setup
        Hidden: false
    More coming soon to this wiki page...
  • Loading...
  • Loading...