Configuration

MyMenu Logo

Setting it up Configuration Donate

Commands Permissions


Default Config.yml


Menus:   # This is a section where every saved menu may be modified to open or give an item when a player joins.
  welcome:   # An already existing menu
    OpenOnJoin: false   # Setting this to true will make the menu open for a player as soon as they join the game.
    GiveItemOnJoin: false   # Setting this to true will give the player the bound item for the menu as soon as they join the game.


Editing the config.yml File:

  • Menus: This section will have a list of the saved menus.
  • On any of the menus which appear, there will be two options: OpenOnJoin, and GiveItemOnJoin.
  • OpenOnJoin: Determines whether the menu should open a player when they first join the game. (Only one menu should have this set to true at a time.)
  • GiveItemOnJoin: Determines whether the player should receive the item that is bound to the menu when they join the game. (If they already have to item it will not give it to them. Will not work unless the menu is bound to an item)


Default menus.yml File:


menus:
  welcome:   # A saved menu, named 'welcome'
    inventoryName: '&4&lWelcome to MyMenu!'   # The name of the chest-inventory for the menu.
    author:   # Who created the menu. Left blank, but can be completely removed if desired.
    authorUUID:   # The author's UUID. Left blank, but can be completely removed if desired.
    rows: 3   # How many rows the menu is.
    inventory:   # This section defines the menu's items
      slots:   # A this section is the slots for the inventory
        s16:   # This is slot 16 (Will be in slot 17 in game). Must start with an 's'.
          item:   # The item settings for slot 17
            material: DIAMOND_PICKAXE   # A diamond pickaxe. MUST BE CAPITALIZED!
            displayName: '&c&lJust a pickaxe'   # The display name. Must be in quotes. Can be completely removed if desired.
            amount: 1   # The amount of the item. Must be between 0 and 64.
            itemLore:   # The item lore. Each entry must be in quotes. Must be in list form as is below. Can be completely removed if desired.
            - '&rThis item does nothing'   # Line 1 of the item lore. The &r makes it not appear purple: It is automatically added when created ingame.
            - '&rbut sit here.'
        s0:   # The first slot of the menu. Slot 1 in game. The slots in the config do not have to be listed in order, as you can see here.
          item:
            material: SIGN
            displayName: '&b&lMyMenu'
            amount: 1
            itemLore:
            - '&rCreate custom interactive menus'
            - '&rfor easier server management'
            - '&rand a better player experience.'
        s18:
          item:
            material: PAPER
            displayName: '&e&lPossible step 1'
            amount: 1
        s20:
          item:
            material: PAPER
            displayName: '&e&lPossible step 2'
            amount: 2
        s4:
          item:
            material: SIGN
            displayName: '&4&lMyMenu Author'
            amount: 1
            itemLore:
            - '&rMyMenu is brought to you'
            - '&rby &bChaddTheMan&f.'
        s22:
          item:
            material: PAPER
            displayName: '&e&lPossible step 3'
            amount: 3
        s24:
          item:
            material: PAPER
            displayName: '&e&lPossible step 4'
            amount: 4
        s8:
          item:
            material: SIGN
            displayName: '&6&lFor More Information'
            amount: 1
            itemLore:
            - '&rMake sure to visit the plugin page'
            - '&rand get a good understanding'
            - '&rof all the features so that you can'
            - '&ruse it as effective as possible.'
        s10:
          item:
            material: SIGN
            displayName: '&b&lWelcome to MyMenu!'
            amount: 1
            itemLore:
            - '&r&fWelcome to MyMenu!'
            - '&r&fFor help use &b/mmhelp'
            - '&r&fThis menu contains examples'
            - '&r&fof possible items for a menu.'
        s26:
          item:
            material: PAPER
            displayName: '&e&lPossible step 5'
            amount: 5
        s12:   # This is slot 13 in game. What is unique about this item compared to the ones listed above is it has a command!
          commands: 
          - 'time set day'   # this is the command that is ran by the player when clicked on. This will close the menu when the item is clicked.
          item:
            material: WATCH
            displayName: '&e&lTime: Day'
            amount: 1
            itemLore:
            - '&rClicking this item will run'
            - '&rthe following command:'
            - '&r&b/time set day'
        s14:  # This is slot 15 in game. What is unique about this item compared to the ones listed above is it has a command!
          commands: 
          - 'difficulty 0'   # This is the command that is ran by the player when clicked on. This will close the menu when the item is clicked.
          item:
            material: DIAMOND_SWORD
            displayName: '&a&lDifficulty: Peaceful'
            amount: 1
            itemLore:
            - '&rClicking this item will'
            - '&rwill run the command:'
            - '&r&b/difficulty 0'


Editing the menus.yml File:

  • Editing this is not advised but may be done under extreme caution.
  • When editing a menu in menus.yml follow these guidelines:
    • Make sure to enclose the following in single quotes: '
      • inventoryName
      • command [Per item setting]
      • displayName [Per item setting]
      • Every line of itemLore [Per item setting]
    • Make sure that each slot begins with an s (Example: Slot 16 would be s16 in the config)
    • Make sure that rows is either 6 or less, but greater than 0.
    • Make sure that material is in all caps. (Example DIAMOND_SWORD) [Per item setting]
    • Make sure that there is an amount for each item is either 64 or less, but greater than 0. [Per item setting]
    • Make sure that itemLore is in a list form. (Example above) [Per item setting]
    • The follow things are not needed in config and can be removed if desired:
      • inventoryName
      • author
      • authorUUID
      • commands [Per item setting]
      • displayName [Per item setting]
      • itemLore [Per item setting]
    • Make sure to take extreme caution with length of names, lore, etc, as well as rows.

Comments

Posts Quoted:
Reply
Clear All Quotes