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
@quapo1
You need version 0.2 for that feature. Currently awaiting moderator approval. Should be available by tomorrow.
Nice Plugin but when i put in /menu script hide the lore of the item will be hide :D can you fix that or did i made something wrong?
@LordKainzo
1) I tried applying colour to a menu item name myself while testing earlier and it worked fine. Here is the menu file: http://pastebin.com/G4EZWD9q
2) Yes, I realised this, that's why I posted again below. I have decided to add currency features in the next release.
3) Well keep checking back, I am making updates as more requests come in and I have more ideas too.
@XHawk87
1) I tried the selection code and it did not work for the colorizing, strange.
2) adding in an economy cost is fine and dandy, but it isnt a check-based system, if the player doesn't have the coin, it will allow the selection, understand? It needs to have a check if the player has the coin and if so, allow the command.
3) I'm using another menu-plugin atm but I liked the setup of this one, just not as feature complete yet!
The next release build v0.2 has been uploaded and is awaiting moderator approval.
@XHawk87
There may be an issue with the command-based approach to applying a cost-per use for a menu script. Currently the execution of the script will not stop unless the command cannot execute, i.e. its not found. I can probably change that to stop if it returns false, but even so, much commands will not return false even if they fail, instead preferring to display a more appropriate error message and return true.
I will think about adding support a variety of currency plugins in the future. Most likely a special script command for checking a player has at least a certain amount of currency. Applying the cost if they do, or stopping the script if they don't.
@jacob_vejvoda
The sources are on github from the link above. You can build the dev version for yourself there.
The menu files are currently created in plugins/CreateYourOwnMenus, however in the next release they will be moving to plugins/CreateYourOwnMenus/menus.
@LordKainzo
Yes, you can run the command as player by prefixing the command with @p, as in @p/kill. This is available from the dev version.
The next release build will also contain commands to show and hide all commands on a menu item. My ETA on that is 2 days, probably approved within 3. This will leave all comments unchanged, so it can have lore.
As for color-codes on item names, it should work if you add the section symbol to the display-name in the menu file and reload it. I haven't tried this yet, but if it doesn't work I'll see what I can do to fix it.
You can integrate a cost for clicking items into any economy plugin that can subtract currency based on an admin command. Just add that command to the script with the appropriate cost and target it at the clicking player using @p.
@XHawk87
Is there no way to run the command as the player? Also I'd be nice if there was a way to hide the commands that certain items have. so that when a player clicks it - it does run the cmd but it will do so on the back end, making for a better end-user experience so we can actually have the item have LORE not just a command, etc.
It would also be nice to be able to use color-codes on the name of the items... I have tried "§" and "&" with a corresponding color and it doesnt work.
It'd be nice to have a vault-integrated cost for clicking an item as well... "cost: 50" for 50 currency. Just adding to this post :)
Where can I get a dev build, and where are the in-game created menus stored?
@jacob_vejvoda
Please use http://pastebin.com/ or similar for pasting code. It makes it so much easier to read, and takes up a lot less of the comments page.
It appears that you're running /warp suvival as the console. You can run it as the player if you add @p in front of the command, like @p/warp suvival, but this requires you to use the development version.
Alternatively, if the /warp command can optionally take a player, e.g. /warp @p suvival, you could use that with the current release version. You will have to look up the /warp command to see if this is possible.
What wrong with my menu?
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.
@XHawk87
It does have an in-game menu creator, you access it by using /menu create, its much easier to just create the menu via file over the in-game one though.
@parrothead1337
This is completely Bukkit API-compliant. It does not use any CraftBukkit or NMS methods, nor does it use any deprecated methods within Bukkit. It was built with the latest version Bukkit 1.5.2-R1.0, and uses the newly-added Inventory events and API. It should continue to work with later versions of CraftBukkit without any updates.
@Faldonboy
This is already in the latest development build. I need to make a few more changes before creating a new release-build, but if you would like to use the dev build now, the sources are available on github from the link above.
I took a look at ItemMenu, it appears it does not allow you to design, create and modify menus within game either. Its an API with YAML save files, but contains no GUI menu editor.
This is very similar to ItemMenu the main selling point(for me at least) that will keep me using that plugin over this one is the ability to set "scripts" to run commands as the player or as an OP. If you can add that(mainly being able to have them run a command as if the player was an OP) then I'll gladly switch over to this. :)
This looks amazing! I'm sure that we'll be able to use this in my new server project.
Question: How resistant is this plugin to Bukkit updates?
Edit: Fixed horrible grammar. If you ever see this, feel free to change the testimonial on the plugin page!
Awesome plugin.
It appears that the file has now been approved. You can download it from the link in the top-right corner.
@LegozandParatroopaz
chestcommand plugin can only have ONE menu. That's the downside of it.
@midnightfang22
I was thinking of having commands to show and hide all commands in a menu item by setting them to black and back again.
If you are running a command as the player, the player will need to have the permission for that command. This requires the development or later version of the plugin however, as the release build does not yet contain the ability to run commands as the player.
@Pr0XM4A1
No. For a start, there isn't just one menu, you can create as many menus as you want. None of them open automatically. They open through /menu open command only.
Another plugin could be used to open the menu directly, or if you have scripting plugin on your server to run commands for a player when they join you could open a specified menu for them by running the command.
@xXMcProjectzXx
invi?