API tools faq
paste
Mr_dsa1

DeluxeMenus basics_menu.yml v1.14.1-Release

Mr_dsa1
Jan 19th, 2026
243
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
YAML 13.44 KB | Source Code | 0 0
raw download clone embed print report
  1. #  A DeluxeMenus basic configuration guide for beginners
  2. #=========================================================
  3. #
  4. # This note will help you understand the basic functions and configuring of DeluxeMenus: commands, requirements, items and others, and from then on you can start to work with more advanced stuff. You can delete this note or any note below at any time. But if you are still here anyway, then let's move down below
  5. #
  6.  
  7. # Open Command
  8. #
  9. # This setting is the command that will be used to open this menu. Supports normal String or a String List
  10. # NOTE: Use "open_command: []" to create a menu with no commands needed
  11. #
  12. # open_command: <command>
  13. # open_command:
  14. #   - <command1>
  15. #   - <command2>
  16. #
  17. open_command: basicsmenu
  18.  
  19. # Size
  20. #
  21. # This allows you to set the size of the menu inventory. Range from 9-54.
  22. # If this option is not present in the menu configuration, it will default to 54.
  23. #
  24. size: 9
  25.  
  26. # Menu title
  27. #
  28. # This is the title of the menu. You can change it with your custom name
  29. # Color codes and placeholders are supported
  30. #
  31. menu_title: 'Basics Menu'
  32.  
  33. # Open requirement
  34. #
  35. # This setting section allows you to define requirements the menu viewer must meet
  36. # to be allowed to open this menu in game.
  37. #
  38. # Any menu you want to restrict access to based on permission
  39. # should have a basic "has permission" requirement
  40. #
  41. # This setting and requirements can be explained more in depth by checking out
  42. # the requirements_menu.yml file in your menus folder.
  43. # For full reference, check https://wiki.helpch.at/clips-plugins/deluxemenus/options-and-configurations/requirements
  44. #
  45. open_requirement:
  46.   requirements:
  47.     permission:
  48.       type: has permission
  49.       permission: deluxemenus.admin
  50.       deny_commands:
  51.        - '[message] &cYou don''t have permission to do that!'
  52.  
  53. # Item section. This is where you can start add items into menu, and add functions into each items that you did.
  54. # For depth explanation on the functions, you can check on the note given from config.yml
  55. # For full reference, check https://wiki.helpch.at/clips-plugins/deluxemenus/options-and-configurations/item
  56. #
  57. items:
  58.  # Here you need to set the name ID of the item. This name however, does not display on the menu. Every item must have a unique name ID.
  59.   # In this example, we will call this item name ID: "teststone"
  60.   'teststone':
  61.    #We will start to create a STONE item,
  62.     material: STONE
  63.     # with a Block data set to 1, so that you can change stone type from STONE to GRANITE. More information about the block data can be checked through each items from Minecraft Wikipedia
  64.     data: 1
  65.     # Slots that you want to put the item. Starts from 0
  66.     slot: 0
  67.     # Here we will name this item. You can change this at anytime. PlaceholderAPI & Color codes supported
  68.     display_name: "&aThis is a special stone"
  69.     # This is the lore setting. Reference of this same with display_name.
  70.     # You can create multiple lines of lore like this
  71.     lore:
  72.      - "&aTest1"
  73.       - "&cTest2"
  74.       - "&eTest3"
  75.  
  76.  
  77. # ==============================================================
  78. #
  79. # Random tips, tricks, and useful info below
  80. #
  81. # ==============================================================
  82. #
  83. # PER ITEM PERMISSION AND PRIORITY INFO:
  84. #
  85. # Per item permissions and priorities are optional.
  86. # High priority = 1, Lowest priority = 2147483647.
  87. # This allows you to show different items for a specific menu slot depending on the highest priority
  88. # item permission a player has. This makes your menus very dynamic :)
  89. #
  90. # You CAN NOT specify a permission without a priority!
  91. # You CAN specify a priority without a permission.
  92. # You should always create a low priority item without a permission which will act as the no permission
  93. # item if a player does not have permission for any of the items that require permission, otherwise
  94. # no item will be set in the slot if a player does not have permission for any of the permission items.
  95. #
  96. # ==============================================================
  97. #
  98. # You specify the command which opens the menu. Make sure this command
  99. # does not conflict with any existing commands on your server!
  100. # A GUI menu without an open command specified will not be loaded!
  101. #
  102. # Menus configuration layout:
  103. # menu_title: '<title of menu goes here>'
  104. # command: <command to open this menu goes here>
  105. # inventory_type: '<add this option if you want to create a menu of a different InventoryType aside from chest>'
  106. # open_requirement:
  107. #   requirements:
  108. #     <unique name for this requirement>:
  109. #    type: <type for this requirement>
  110. #    <unique options per requirement type would go here>
  111. #    deny_commands:
  112. #    - '[message] you do not meet requirements to open this menu'
  113. #   size: <size of this menu, increments of 9, max size is 54>
  114. #   update_interval: <time in seconds this gui should update for a player if an item is set to update placeholders>
  115. #   items:
  116. #     <item identifier>:
  117. #       material: <name or id>
  118. #       material: head-<name of player>
  119. #       material: basehead-<value> from https://minecraft-heads.com/custom-heads
  120. #       material: hdb-<HeadDatabase id> (requires plugin HeadDatabase)
  121. #       data: <integer, used for data values for wool etc>
  122. #       amount: <amount of this item to show>
  123. #       slot: <slot number to put this item, slots start at 0 and end at 53 for a size 54 inventory>
  124. #       priority: <this is used if you have multiple items set for the same slot>
  125. #       view_requirement: <see view requirement info below. The lowest priority item a player meets all view requirements for will be shown>
  126. #       update: <true/false if this item should update placeholders on the interval set for the gui menu this item is in>
  127. #       hide_attributes: <true/false if this item should display item attributes>
  128. #       hide_enchantments: <true/false if this item should display item enchantment / level> (useful for 'enchantment glow' items)
  129. #       hide_effects: <true/false if this item should display item effect attributes>
  130. #       hide_unbreakable: <true/false if this item should display item unbreakable attributes>
  131. #       banner_meta: (this is used if you want to display a custom banner with specific patterns)
  132. #       - <dyecolor>;<PatternType> (more information on where to find DyeColor and PatternType names below)
  133. #       - 'RED;BASE'
  134. #       - 'WHITE;CREEPER'
  135. #       display_name: <display name to show for this item>
  136. #       lore:
  137. #       - 'This is the lore of the item'
  138. #       - 'placeholders can be used in the display_name or lore.'
  139. #       enchantments: valid enchantment names can be found here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/enchantments/Enchantment.html
  140. #       - '<ENCHANTMENT>;<LEVEL>'
  141. #       - 'SILK_TOUCH;1'
  142. #       left_click_commands:
  143. #       right_click_commands:
  144. #       shift_left_click_commands:
  145. #       shift_right_click_commands:
  146. #       middle_click_commands:
  147. #       click_commands:
  148. #       left_click_requirement: <Learn how to use this option in the requirements_menu.yml>
  149. #       right_click_requirement: <Learn how to use this option in the requirements_menu.yml>
  150. #       shift_left_click_requirement: <Learn how to use this option in the requirements_menu.yml>
  151. #       shift_right_click_requirement: <Learn how to use this option in the requirements_menu.yml>
  152. #       middle_click_requirement: <Learn how to use this option in the requirements_menu.yml>
  153. #       click_requirement: <Learn how to use this option in the requirements_menu.yml>
  154. #
  155. #
  156. # You can specify if a GUI menu should be loaded from another file:
  157. #
  158. # gui_menus:
  159. #   <menu-name>:
  160. #     file: 'menu-file.yml'
  161. #
  162. # This allows you to keep your config clean and not have tons of GUI menus cluttering it.
  163. # The file format the GUI menu is loaded from must end in .yml
  164. # GUI menus loaded from other configuration files must follow a specific format as well...
  165. # To get started loading GUI menus from different files, simply create a GUI menu in this config and specify the file it will load from.
  166. # After that is done, use /dm reload and DeluxeMenus will create a folder and file specific to the GUI menu you specified.
  167. # If the file specified is created by DeluxeMenus (because it did not exist), a default GUI menu layout will be saved to that file.
  168. # From here you can edit it to your liking and use /dm reload to update your GUI menu!
  169. #
  170. # This loading from external config files is only available for gui menus and will not work for click menus yet....
  171. #
  172. # banner_meta must be listed with a specific format:
  173. # banner_meta:
  174. # - <DyeColor>;<PatternType>
  175. #
  176. # Valid DyeColor names can be found here: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/DyeColor.html
  177. # Valid PatternTypes can be found here: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/banner/PatternType.html
  178. # ==============================================================
  179. #
  180. # Requirement information
  181. #
  182. # Requirements can be set as the following:
  183. #
  184. # open_requirement: This requirement is checked when a menu is opened
  185. # view_requirement: This requirement determines if an item should be set in a menu slot
  186. # left_click_requirement: This requirement is checked when an item is left clicked
  187. # right_click_requirement: This requirement is checked when an item is right clicked
  188. #
  189. # Requirement types:
  190. #   javascript - Evaluates a javascript expression that must return true or false
  191. #     configuration options:
  192. #       expression
  193. #
  194. #   has item - Checks if a player has a specific item
  195. #     configuration options:
  196. #       material
  197. #       amount
  198. #       data
  199. #       name
  200. #       lore
  201. #
  202. #   has money - Checks if a player has enough money (Vault required)
  203. #     configuration options:
  204. #       amount
  205. #
  206. #   has permission - Checks if a player has a specific permission
  207. #     configuration options:
  208. #       permission
  209. #
  210. #   string contains - Checks if a string contains another string
  211. #     configuration options:
  212. #       input
  213. #       output
  214. #
  215. #   string equals - Checks if a string equals another string
  216. #     configuration options:
  217. #       input
  218. #       output
  219. #
  220. #   string equals ignorecase - Checks if a string equals another string ignoring case
  221. #     configuration options:
  222. #       input
  223. #       output
  224. #
  225. #   > - Checks if a number is greater than another number
  226. #     configuration options:
  227. #       input
  228. #       output
  229. #
  230. #   >= - Checks if a number is greater than or equal to another number
  231. #     configuration options:
  232. #       input
  233. #       output
  234. #
  235. #   == - Checks if a number is equal to another number
  236. #     configuration options:
  237. #       input
  238. #       output
  239. #
  240. #   <= - Checks if a number is less than or equal to another number
  241. #     configuration options:
  242. #       input
  243. #       output
  244. #
  245. #   < - Checks if a number is less than another number
  246. #     configuration options:
  247. #       input
  248. #       output
  249. #
  250. #   regex matches - Checks if a placeholder parsed string matches a regex pattern
  251. #     configuration options:
  252. #       input
  253. #       regex
  254. #
  255. #
  256. #
  257. # So why would we want to use requirements?
  258. # By default, DeluxeMenus does not require a player meet any conditions to open your menu.
  259. # If you want to require a menu need a certain permission node for it to be accessed, or a certain amount of money
  260. # for a menu to be opened, You do that with an 'open_requirement'.
  261. # Below is an example of how you would deny opening a menu if the viewer does not have permission:
  262. #
  263. # menu_title: 'Menu that requires permission to open'
  264. # open_command: testmenu
  265. # size: 9
  266. # open_requirement:
  267. #   requirements:
  268. #     this_requirement_name:
  269. #       type: has permission
  270. #       permission: 'testmenu.open'
  271. #       deny_commands:
  272. #       - '[message] you do not have permission to open testmenu'
  273. #
  274. # ==============================================================
  275. #
  276. # Every item in the items list must have a unique <item identifier>
  277. #
  278. # If you choose to update placeholders for a specific item, you must specify update_interval: <time>
  279. # in the menu options for the specific menu.
  280. #
  281. # Every click_command must start with a specific identifier to know what to do for the execution.
  282. # Valid click_command identifiers:
  283. #
  284. # [console] - Execute a command from the console
  285. # Usage: - '[console] <command with no slash>'
  286. #
  287. # [player] - Execute a command for the menu viewer
  288. # Usage: - '[player] <command with no slash>'
  289. #
  290. # [commandevent] - Fire a PlayerCommandPreprocessEvent for commands that do not use the bukkit command system
  291. # Usage: - '[commandevent] <command with no slash>'
  292. #
  293. # [message] - Send a message to the menu viewer
  294. # Usage: - [message] <message to send to the player
  295. #
  296. # [openguimenu] - Open a GUI menu (can only be used in GUI menu click_commands)
  297. # Usage: - '[openguimenu] <guiMenuName>'
  298. #
  299. # [connect] - Connect to the specified bungee server
  300. # Usage: - '[connect] <serverName>'
  301. #
  302. # [close] - Close the viewers open menu
  303. # Usage: - '[close]
  304. #
  305. # [refresh] - Refresh items in the current menu view
  306. # Usage: - '[refresh]
  307. #
  308. # [broadcastsound] - Broadcast a sound to the server
  309. # Usage: - '[broadcastsound]
  310. #
  311. # [sound] - Play a sound for a the specific player
  312. # Usage: - '[sound]
  313. #
  314. # [json] - Send a json message to the menu viewer
  315. # Usage: - '[json] {"text":"message"}'
  316. #
  317. #
  318. #
  319. # You can delay any of the click command being performed by ending the command with
  320. # <delay=(time in TICKS)>
  321. # example:
  322. #     - '[close]'
  323. #     - '[message] it has been 5 seconds since the menu closed!<delay=100>'
  324. #     - '[message] it has been 10 seconds since the menu closed!<delay=200>'
  325. #
  326. sweet: true
  327.  
Add Comment
Please, Sign In to add comment
Public Pastes
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!