CreateYourOwnMenus

portals.png

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.

See the Tutorial for detailed instructions.


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

"Awesome plugin." - Bobbinkin

"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

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

Donations


If you like my work, please consider donating using the Donate button in the top-right corner of the screen. As a freelance professional, I rely on donations and payments to support my work. Anything you can contribute to support my work will allow me to spend more time making plugins for Bukkit and supporting the plugins I publish. Thank you.

Everything I create here will be 100% free to download and use as you please, just keep the license attached and give me credit for the original work if you decide to redistribute.

Donate


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/

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

You must login to post a comment. Don't have an account? Register to get one!

  • Avatar of meowsome meowsome Jul 01, 2015 at 16:40 UTC - 0 likes

    @XHawk87: Go

    Thanks!

  • Avatar of XHawk87 XHawk87 Jul 01, 2015 at 11:57 UTC - 0 likes

    @meowsome: Go

    Yes. Hold the item in your hand and type "/menu script add /close". This is a special menu script command that closes the current menu for the clicking player.

    You can see other commands here: http://dev.bukkit.org/bukkit-plugins/createyourownmenus/forum/scripting/59931-basic-command-scripting/

    Waiting for a viable alternative to Bukkit

  • Avatar of meowsome meowsome Jul 01, 2015 at 05:31 UTC - 0 likes

    Hello! Is there any way I can add an item in a menu that closes the menu when you click on it? Thank you.

  • Avatar of XHawk87 XHawk87 Jun 21, 2015 at 11:28 UTC - 0 likes

    @Trolltheking: Go

    If by restart you mean /reload, I wouldn't be surprised if that causes unexpected behaviour, it is not supported by many plugins, and is known to cause memory leaks and bugs. Full server restarts should work fine.

    If not, please send me details about your server (/version) and exactly what sequence of events causes this to occur, and search your server logs for any stack traces including CreateYourOwnMenus, and send them to me in a http://pastebin.com or similar service.

    Enabling and disabling all menus and scripts from running is an interesting idea. It could probably be achieved by removing player permissions for those commands, you can also add /requirepermission [permission] onto selected menu items to ensure that players cannot run it when the permissions aren't granted.

  • Avatar of Trolltheking Trolltheking Jun 21, 2015 at 01:43 UTC - 0 likes

    Can you add a command where you stop all menus and scripts from being able to run? I really need it for my server because commands stop running when the server restarts making people able to duplicate unauthorised items. Anyways thanks for making such a nice plugin.

    Last edited Jun 21, 2015 by Trolltheking
  • Avatar of XHawk87 XHawk87 Jun 16, 2015 at 18:22 UTC - 0 likes

    @Terryjomjerry: Go

    I suspect that the /kit and /warp commands expect to be run by a player, and not a command block, console or plugin. To get around this, we provide the @p symbol that you can place anywhere in a command. It will be automatically replaced with the name of the clicking player when the menu item is activated.

    You should check the plugin documentation to see if they'll take a [player] argument, e.g. /warp [player] [warp] would be /warp @p spawn.

    If they don't provide support for that, you can use the /sudo [player] [command] command provided by CreateYourOwnMenus. This will run the command as if the specified player had typed it. So you could then do "/sudo @p warp spawn"

  • Avatar of Terryjomjerry Terryjomjerry Jun 16, 2015 at 18:16 UTC - 0 likes

    This also is with /menu script add /warp spawn

    it just runs

    /warp ------ but like you said /menu script add /say hello world

    it runs

    /say hello world

    Im really confused

  • Avatar of Terryjomjerry Terryjomjerry Jun 16, 2015 at 18:13 UTC - 0 likes

    Okay so when ever I try to enter a command such as

    /menu script add /kit tools

    it says completed, then when I click on it, it runs

    /kit

    not, /kit tools

    help please!

  • Avatar of XHawk87 XHawk87 Jun 10, 2015 at 11:58 UTC - 0 likes

    @Trolltheking: Go

    Create a new menu containing only that item in slot 6. The top row of the menu is the hotbar, 2-4 are the inventory storage rows 1-3, and the first 4 items in row 5 are the armour, from boots to helmet.

    To make an item that grabs it from the clicking player, hold the item in hand and type "/menu script add /menu grab @p my_grabbing_menu", with your menu ID in place of "my_grabbing_menu".

    Have fun!

  • Avatar of Trolltheking Trolltheking Jun 10, 2015 at 04:58 UTC - 0 likes

    How do you make a menu item when you do /menu grab to go to a specific slot? i.e. slot 6

Facts

Date created
Jun 17, 2013
Category
Last update
Aug 11, 2014
Development stage
Release
License
GNU General Public License version 3 (GPLv3)
Curse link
CreateYourOwnMenus
Downloads
25,357
Recent files

Authors