CreateYourOwnMenus
Hiding scripts is no longer possible from Minecraft 1.16 due to changes in item lore formatting
As the name suggests, this plugin allows you to create your own menus. The menus are based on inventories, with each slot holding a clickable menu item. When a player clicks on a menu item, it performs all of the commands listed in the item's lore (the text underneath its name) in a similar manner to command blocks. You can design the menu in-game by selecting any item, naming it in an anvil, modifying its lore using a command, and using commands to create and open a menu for editing to place it anywhere in the inventory that you wish. You can modify your menus any time you want.
Thanks to TheMobCave for providing the video tutorial. Please like and subscribe!
The video tutorial was of CreateYourOwnMenus v0.2, so the latest version has even more features! One major change is that the /menu script command now has sub-commands. E.g. /menu script add [text] instead of /menu script [text]. As well as: insert, delete, replace, clear, show and hide.
Screenshots
See the gallery for screenshots.
User Reviews
"This looks amazing and would make my role playing server a lot easier for players so they don't have to remember a lot of commands." - Ccamm
"This looks amazing! I'm sure that we'll be able to use this in my new server project." - parrothead1337
"This plugin allow so much things :o" - TheNemesisA5
Features
- Use commands to manage all of your menus
- Use any in-game item as a menu item
- Edit menus in-game using inventories
- Open menus using commands, command blocks or other menus
- Activate any menu item simply by clicking it in an open menu
- Alternatively, activate menu items by holding in hand and right-clicking (can be used to open menus and more)
- Modify the lore of any item using commands /menu script clear and /menu script [comment/command] commands
- Add, remove, modify and share menus using their .yml files in the "plugins/CreateYourOwnMenus/menus" folder
- Optionally run the command as the player instead of console by using the /sudo command E.g. /sudo @p kill
- Show/hide menu script commands using the /menu script show and /menu script hide commands
- Delay execute of commands in a script using the /delay [ticks] menu script command
- Use {curly braces} to add dynamic arguments to commands (prompts the clicking player)
- If you have Vault installed you can use /requirecurrency to check if a player has a given amount of currency
- Translate into other languages using LanguageAPI
What it does not do
- This is not intended to include a full-fledged scripting language. It simply executes commands in series and is interrupted on failure. For more complex actions, conditions and program flow you should be using a plugin like Skript to run scripts on menu item clicks.
- It cannot run commands as a player with "elevated permissions". There is currently no safe way to do this within the Bukkit API without introducing errors, compatibility issues and/or require updates every build of Minecraft, CraftBukkit or even Bukkit. You can work around this by granting the permissions, performing the actions and then revoking them again, or by calling out to another plugin that supports this. I do not intend to add this feature until there is a safe way to achieve it.
Plugin Suggestions
This is a list of plugins that work well with CreateYourOwnMenus.
- Use the MicroJump plugin for BungeeCord /server command support for BungeeCord users
- Use the Skript plugin to open menus on player joining, or various other events, and create advanced scripts that you can run when clicking a menu item
- Use the Vault plugin to provide currency support using the /requirecurrency menu script command
Commands and Permissions
A full list of commands and permissions is available on the Commands and Permissions page.
Detailed command help is available in-game by typing /menu
Sharing
Find and share pre-created menus on our forums!
Scripting
A basic scripting guide is available on the Basic Command Scripting thread.
Other tutorials and guides are available on the forum
Security Considerations
The menu scripts always run as console. By default, this is not a problem as only operators have the ability to create menu items and modify menus, however if you give other players permissions to do this, be aware that it will also give them the ability to effectively run any command they wish as console.
Development
Sources are available on GitHub: https://github.com/XHawk87/CreateYourOwnMenus
Ideas
- Add internationalisation support
- Add a "cyom.menu.edit.[menu id]" permission to allow editing of a specific menu only
- Add "cyom.script.allow.all" permission to allow adding any command to a menu script, except those specifically denied (Default op)
- Add "cyom.script.allow.[command name]" permission to allow adding specific commands to menu scripts (child of cyom.script.allow.all)
- Add /menu script import [file] and /menu script export [file] for quickly importing or exporting the lore of a menu item to a simple text file
- Add "cyom.slot.lock.#" to lock specific inventory slots in a player's inventory and treat it as a menu
- Modify /menu grab command to place items into the same slots in a player's inventory where applicable, displacing other items, and otherwise finding any free slot
- Trigger a menu item when it is used to attack or break blocks with
- Add /use special command to allow the item to be used as a normal item (this cannot be used after a delay or prompt)
- Organise menus into folders, and accessed in the form "folder.menu"
- Store menu items in a format that is easier to edit manually, marking lines as hidden without the section symbols all over it
- Provide a faux creative mode for non-op creative players so that server owners can grant creative abilities to non-op players without introducing security risks
- Command support for tab-autocompletion
- Add escape character for {input prompts} so you can still use datatags
Bugs
- Items in locked slots are still dropped on death instead of remaining in their slots
- Items with the /consume command will only be removed if the stack size is 1
Deprecated Features
- To reduce the number of special menu item commands, the /GiveChest, /TakeChest and /CountChest commands will be removed and less complex and easier to understand Skript alternatives will be provided in their place
Help
This plugin uses Java 7
If you get the followed error on starting up the server with this plugin installed "Unsupported major.minor version 51.0". This means you are using an out of date version of Java. If you don't know how to upgrade, please contact your server hosting provider and ask them for help in upgrading to Java 7, or contact Oracle customer support. Mac OS X users require JDK 7 instead of JRE 7.
Very wide text boxes on menu items
Due to a Minecraft client formatting error, the invisible characters on the first line can cause the lore text box width to be increased despite taking up no space when there is visible text on the same line. This can be mitigated when hidden by keeping the first line empty using /menu script insert 0 &a. When commands are shown, it may become difficult to read them.
Non-op Creative Players spawning menu items without permission
Warning: A new security loop-hole has been discovered in the Minecraft server. It is possible for players with certain modified clients to create items for themselves that contain any lore that they want so long as they are in Creative Mode. This does not require operator status or permissions, only Creative Mode. If you have Non-operator creative players on your server be advised that if they use a modified client, it is possible for them to create any menu item that they want without needing permissions.
You can alleviate this somewhat by adding commands to the "blacklist-commands:" section in the config.yml. This will stop anyone but operators from using menu items with those commands on them. E.g.
blacklist-commands: - op - stop - kick - grantperms etc etc
Another option is to keep those players in Survival mode, but use other plugins to give them creative-like powers such as infinite resources, fast breaking and flight.
Ghost items appearing on clicking a menu item
If you are experiencing ghost items in 1.7.2 using this plugin, it is due to the client-side Minecraft bug (https://mojang.atlassian.net/browse/MC-41165). This only affects 1.7.2 and is fixed in 1.7.4. The bug is not dangerous as it is not a real item. Any attempts to move the item out of the inventory, place it, or fill the same slot will result in it disappearing. Since this is a client-side only bug, it is recommended that players be urged to update from 1.7.2 to 1.7.4 as soon as possible. Note: it is possible to play on CB 1.7.2 R0.1 beta using a Minecraft 1.7.4 client.
After restart, my menus all have weird characters wherever there were hidden commands or colours
This is a text-encoding issue caused by the some CraftBukkit servers attempting to read menu files in the wrong text encoding by default. You can fix this by telling Java to use UTF-8 by default for CraftBukkit.
For users of McMyAdmin, MultiCraft and other server launchers, there should be an option to specify text-encoding in your settings and switch to UTF-8. If not, you should have a way to add optional command line arguments, and follow the advice below for a startup script.
If you are using a startup script you will have something along the lines of:
java -Xmx1024m -jar CraftBukkit.jar
You need to add the following option somewhere after java and before -jar. E.g.
java -Xmx1024m -Dfile.encoding=UTF8 -jar CraftBukkit.jar
After updating CraftBukkit (build #3009+), my Skript custom commands aren't working from menu items
Changes in CraftBukkit build #3009 (1.7.2-R0.3-SNAPSHOT) have updated the Bukkit plugin command system that broke Skripts custom command handler. This prevented Skript from receiving commands that had been directly dispatched by other plugins. This issue was fixed in Skript 2.1.1+, so downloading the latest version of Skript should correct the problem.
It says @a or @w instead of the player's name
If a @a or @w target selector is the last character in a command, it is not currently replaced correctly. This will be fixed in the next dev build. In the meantime, attempt to ensure there is a non-whitespace character after the last target selector.
Every time I click an item in my inventory it activates it like it was a menu item
You may have inadvertently locked all of your inventory slots by misuse of the '*' permission node. This will grant you all permissions, including 'cyom.slot.lock.*' which is used for locking inventory slots so that they can be used as menus. The best solution for this is to stop using the '*' node and instead only grant yourself the specific extra permissions that you need. However if you insist on using the '*' node you will need to grant yourself the negative permission '-cyom.slot.lock.*' in order to prevent your slots from getting locked.
Every time I restart my server, all changes I made to my menus are undone
There is a time-related bug with previous builds of CYOM that prevent file saving. To fix this you must update to the latest dev build: http://dev.bukkit.org/bukkit-plugins/createyourownmenus/files/18-create-your-own-menus-v0-5-8-dev/
I can't use {NBT data tags} in my commands
Unfortunately, we already have a use for the {curly braces} as dynamic arguments that predate their use in Minecraft, so you can't use NBT data tags in your menu commands. However, you can get around this in a couple of ways:
Any items that you need to be given to a player with data tags can be pre-created and placed in a menu, then you can use the /menu grab command to give them to the player. Since you can grab multiple items at once, and edit the menu visually, it makes for a rather convenient way of setting up item kits on a server.
You can also use a custom scripting plugin like Skript to set up a custom command to run the commands for you. Using Skript in this way allows a great deal more flexibility for your menu scripts by adding logic, variables, persistence and program flow, and if you need help with them they have a lot of friendly people on their forums who are always happy to help.
Donations
If you'd like to contribute towards the continued development, support and maintenance of this project, please consider joining me on Patreon, and making a one-time or recurring pledge.
Support Channel
If you need help you can leave a comment below and I will get back to you as soon as I can. You can also join my IRC chatroom using the following link, but please read the tutorial first. http://webchat.esper.net/?channels=XHawk87&prompt=1
I am happy to give support, but repeatedly answering the same question that is explained in bold red on the plugin page is highly tedious. Don't be lazy, read first, then ask questions. It's the polite thing to do
is there is a way to change the dynamic arguments messages? I want to translate it to spanish.
@SpookyPirate
Yes, I am integrating vault as an optional dependency. You don't need it to use CreateYourOwnMenus but it will allow you to use the /requirecurrency menu command which checks that you have enough currency before continuing. Vault ties in with a number of other economy plugins, such as iConomy, essentials economy etc, so it seems the best choice.
The consume command is to consume the item after a use, multiple of the same item allows multiple uses.
@XHawk87
YAY! Economy support is coming? I just glanced at the github after seeing your previous post and saw that you added a "consume" command to plugin as well. does this mean that you will be able to make items consume themselves after a use? Or will it be that the command will be ran after the item is consumed such as "command placed on potato, player eats potato, Command is then ran"? Either way gives me tons of useful ideas. : ) I love this plugin so much words cant describe it. : )
@Azur_
You may be interested in the dev source currently on github. It contains Vault support, enabling you to check currency amounts before continuing execution. Of course, the dev sources have not received rigorous testing.
@XHawk87
I'm using CommandHelper to do some programming stuff (specifically, using it to check if the player has enough money), which I was unable to do with CreateYourOwnMenus. It's also nicer to only have 1 blank line where the hidden command is, instead of having a blank line in the lore per command.
I'm guessing it just doesn't pick up the command, thanks for the help anyways.
@Azur_
If CommandHelper isn't working for you, why not use the long-hand versions of those commands instead? It's not like aliasing is strictly necessary when you're writing a script anyway.
CreateYourOwnMenus just calls out to Server.dispatchCommand in the Bukkit API to handle commands. CommandHelper may be bypassing the normal command execution to add the aliases, so its possible that any other plugin that dispatches commands won't be able to find the aliases, only the original commands.
"Error in menu script line (unknown command)"
The command definitely works when I use it myself ingame, and it works from the console. When I preface the command with @p it sends an additional default message for "unknown command"
Do you have any ideas what I could do to fix this?
@Anibaaal
While holding the menu item in your hand, type /menu script hide
Alternatively, you can modify the menu file directly, and place the section symbol (§) before each character (including spaces), and it will have the same effect.
Is there any option to hide the commands from the lore? Great plugin, thank you.
Love this plugin, it tells my players the commands so they don't ask me about it! More time for me, is more time for my new server!
@Safarijungle
I am on a Mac as well and I had the same problem as you where I updated JRE to 7 and it still wasn't working for me. You need to install JDK7 and this should fix your problem. Not just JRE. I don't know why this is but it works. : )
@Safarijungle
Java SE 7 is the correct version. Now you need to ensure that THIS version is being used to run CraftBukkit and not some other installed version. I literally do not know how to do this on a Mac. I am not a Mac user, and I have very little knowledge of the Mac OS. I recommend contacting technical support.
I have downloaded Java again, and I tested to make sure it was installed correctly and it said it was, here's what it said...
Version: Java SE 7 Update 25 Operating System: Mac OS X 10.7.5 Java Architecture: 64-bit
Anything wrong with that?
@deleted_10000664
From the commands list above:
/menu open ([player]) [id] - Open a menu with the given id, optionally for the given player, this makes it usable in menu scripts and command blocks
This means you can do /menu open @p [id] and it will open the menu for the clicking player.
When an item is held in hand and right-clicked, it will activate the script and open the menu.
@XHawk87
Is it possible to bind menus to items?
@Safarijungle
Sorry, I have very little experience with the Mac OS. You should ask an expert on Macs or google how to install Java on a Mac. One thing to watch out for is that you can have multiple versions of Java installed at once, so you have to make sure that the correct version of Java is being used to run CraftBukkit.jar. That's all I know, cannot help any more than that.
I went to java and downloaded Java again, and it still wont work saying the same thing, I run mac.. Just an FYI..?
@Safarijungle
SpookyPirate is correct. That error is caused by trying to run a plugin written in Java 7 in an earlier version of Java. You need to update to the latest version of Java to get it to work.
@willkiller1234
You can run multiple commands in a single menu item, so you could for instance:
/op @p
@p/[whatever command]
/deop @p
or grant and then revoke the specific permission for that command using a permission managing plugin.
@lakilla21
You can use the /menu grab ([player]) [menu id] command to copy all items from a given menu into a player's inventory. If you want to automatically run commands based on events like players joining the server or respawning, you need to use another plugin for this. Such as http://dev.bukkit.org/bukkit-plugins/click-command/. Doing a search in bukkit will provide similar plugins.
I want to get people to spawn in with the item made as a Warp compass. How would I get it in there inventory? Is there a item id? (Not very good with plugins I dont know
@willkiller1234
I was about to ask the same question : ) I thought that they automatically did but thats not the case.