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
@tommygoesha
Please submit logs of errors using http://pastebin.com or similar, and explain how/when the error appeared.
http://pastebin.com/7KwM2QZG
It happens everytime i restart the server, i just installed it, i have little to no plugins since im trying to find the cause of another plugin breaking. that was the only error i got and it just wipes any menu i create.
@tommygoesha
You can use this in conjunction with any Bukkit plugins. There is no special support added for MicroJump or Bungee, it is just a recommendation because MicroJump turns /server into a bukkit command which things like CreateYourOwnMenus and command blocks can use.
Anyway to support Bungee? i know you use microjump but theres another plugin called BungeeSuitWarp wich its /bwarp [warpname] and itll tp you to the warp in whatever server.. this would make this like the ultimate Menu plugin :D
@michaelhampton
Could u add the ability to bind this to an item like paper?
This can already be done. Just hold paper in your hand and use the /menu script command to turn it into a menu item.
And when u right click the paper it opens Up a bound menu
This can be done as of v0.2.2. See Files. Just use /menu script to add the command /menu open @p [menu]. When you right-click with this item in hand, it will run the script and open the specified menu.
And this item can be permanately set to a persons menu bar?
Not permanently, that would mean preventing a player from modifying their own inventory, but you can use menu script items as of v0.2.2 from your hotbar by holding it in your hand and right-clicking.
In the next dev build, v0.2.3, I will be adding the ability to "grab" copies of all menu items from a specified menu into your inventory using a command. This will allow you to have a starter set of menu items for a player's inventory that you can give out to players quickly and efficiently, however it will not stop them from moving these items around or dropping them.
The purpose of this plugin is to be as general-purpose as possible so that people can use it for as many different things as possible. What you're suggesting would be very simple to write as a separate plugin, but very hard to fit in with this and keep it general purpose, as it would involve being very restrictive in preventing players from modifying their own inventories, which in many cases is not what people want.
If you have any ideas how this could be implemented without preventing others from using it the way they want, I may be able to add it.
Could u add the ability to bind this to an item like paper? And when u right click the paper it opens Up a bound menu. And this item can be permanately set to a persons menu bar?
@epicpotato14
I am not aware of any conflicts with other plugins. Please send me a PM with more details about your problem, http://pastebin.com of any errors on the console, what exactly isn't working and which dev build you are currently using.
I just installed this plugin but it seems to not be functioning. I have a 1.6.2 dev build for my bukkit server and I know a lot of others who have that build experienced no troubles when installing this plugin. Does this plugin not work if you have any other type of plugin? Or did I just forget something when installing?
Another development release has been uploaded. You can find it soon under Files v0.2.2. This contains most but not all of the current ideas for future development.
Custom lore and economy plugin support require some research, I will be looking into those later.
@James2025
I don't see any harm in making it case insensitive, i'll do that for the next version.
Also can you please make it so that even do someone types /menu open God-Items they can also do /menu open god-items make it non caps sensative.
I have been looking for this plugin for months! This is AMAZING! I love it!
@tommygoesha
How did you get that from what I said? O.o
Just like everything else on the ideas list, it will be added to the plugin in some future release, in one form or another. Most of them in the next build, which will take a while because I am busy with another project right now. It will also not likely be as described, because ideas get refined over time.
I was suggesting that you could get it sooner and in the exact form that you want if you request a plugin.
@XHawk87
So theres no chance you would add something like that?
@tommygoesha
If you made a plugin request on the bukkit forums, it would be very simple to write something that simply opens a menu, with the added bonus that you could make it any means of activation that you want.
Id love for the "Add command to create a special customisable "menu opening" item that can be right-clicked in inventory or right-clicked in hand to open a specific menu. " feature to be added. its the only reason why im not using this one =\
@TtocSNUMBER1
This sounds like an issue with that dev build of CraftBukkit if it has affected many plugins. There are no API changes that should have broken anything in these plugins. You should report the matter on http://leaky.bukkit.org and wait for a new dev build.
When will this be updated to 1.6.2? It doesn't work for me any more. It did, but then all the sudden it didn't, some of my other plugins were doing the same thing.
@jsingh17
You can do anything that is possible to do manually with commands. However, one issue you may come across is if the player doesn't have the points or money and use the menu item anyway, it won't necessarily stop executing instructions in the menu script. I will be working on compatibility with certain popular economy plugins in the next release.
@gamingnl
Please bear in mind that this plugin is working fine for hundreds of people, if there is a specific issue you are having I will need details of your specific situation in order to give advice. Simply saying "it doesn't work" will not allow me to help you!
Please check your console and send a http://pastebin.com link of any error logs as well as the related menu files and explain what you did to cause the error to occur.
@XHawk87
I got that version already but it doesn't work