- Tested Minecraft Versions:
This is helpGui, the plugin that creates a GUI (with folders) for when a player does /help. this plugin is a useful way of making help pages seem less confusing to a new player as the information can be structured in a way that only a small amount of it is displayed to the user at a time.
Thank you EmpirePlays and Staff Team of DarkLeague for coming up with the idea of the plugin and giving me permission to upload it to Bukkit / Spigot
like all plugins download the plugin and put it in your plugins folder, then reload your server, if all has worked a config file should be made!
These are actions which are run when the user selects the item in the GUI, this can either:
- Move the player to another folder
- Send a message to the player
- Force the player to run a command
- Close the inventory
No permission is required to access the default /help page, but you can make some items only appear if the user has a certain permission (see "setting up items")
As the setup process is GUI based there is a single permission required: "helpgui.admin".
Setting up items:
Use the button in /helpsu to create a new item.
You can change the name by selecting it under items.
you can also change the lore and associated permission in the same way.
Using the plugin:
The easiest way of using the plugin is to use the configuration GUI (/helpsetup [or /helpsu]) there you will find a GUI which can guide you through the setup process.
If you prefer commands, type in the command /helpsu help to get a list of applicable commands.
if you have any suggestions for the plugin leave them as a comment!
Config: (In case the comments get deleted and you need them for support)
BUGSCode (YAML):# thank you for downloading HelpGUI, updates will be comming soon with GUIs for creating items etc..
# Just a quick warning: I like commenting in too much detail so I can be certain the config is understandable
# If you still have issues understanding, leave a message on the plugin page or message booksaw123 on spigot (the creator (https://www.spigotmc.org/resources/authors/booksaw123.120955/))
# "seperator" determines the string which is banned from the rest of the config, it will be used for back-end saving of data for example enchantments on items
# WARNING: DO NOT USE THIS STRING ANYWHERE ELSE IN THE CONFIG, IT IS USED AS PART OF THE SYNTAX OF THE CONFIG TO SEPERATE PIECES OF INFORMATION
# REQUIRED: SET THIS BEFORE CONFIGURING THE PLUGIN
# info: Please set to be a string which you will not use elsewhere in the config,
# In a worst case scnario where the seperator must be used elsewhere use CTRL + F and run a find and replace from the old seperator to the new one
# Though success cannot be garunteed
# layout with explanations
# note: any new items created should be added to the itemList below
# <item name> = the name that will be used to refrence the item through the plugin, the user cannot see this name
# so make the name quickly understandable instead of presentable
# <item meta> = this is got by doing the command /createitem while holding the item you want to use
# this will then add the catogory <item> to the config and store the item details, copy these details into the item meta section
# WARNING: Doing so may remove the comments from the config (there is a chance that will happen whenever the config is edited by the plugin) so make a backup of the config
# so you can refrence the comments if you need help.
# NOTE: the ":" in the action syntax should be replaced with the "seperator" if it is changed to something else.
# this is what is run when the user clicks on that item... examples of actions include
# COMMAND:<command> - relpace <command> with the command that the user will run, EG: COMMAND:me Hi
# to refrence the users name use the condition "@p" (this is a default minecraft refrence, nothing added by the plugin)
# MESSAGE:<mesage> - replace <message> with the message you want to send to the user, normal use of colors using the refrence '&'
# EG MESSAGE:&6Hello
# FOLDER:<NAME> - this redirects the user to the specified folder using the refrence (see below) this makes the item seem like a folder
# in a file explorer (A chest may be a good item)
# INVSTATUS:<status> - either "show" or "hide", this makes the inventory be hidden, there is no need to use the refrence "show" as the inventory is already showing
# but it exsists for back-end reasons
# Once you have created an item, add it to a folder (for testing, the main folder "help" would work) then click on it,
# any unrecognised actions will be output in the console, so use this to test if you have correctly set-up the item.
# <item name>:
# item: <item meta>
# - <ACTION>:<ARGS>
# NOTE: § is actually the selector symbol for chat colours, but gets changed during compilation. (not & but the squiggely symbol)
item: '§6§lEssentials:CHEST:1:0:§bAll commands for essentials::'
item: '§6§l/fly:FEATHER:1:0:§bAllows you to fly::'
- MESSAGE:&6The command has been run for you
item: '§6§l/nick <nickname>:PAPER:1:0:§bChanges your nickname=§c/nick notch §bchanges
your nickname to notch::'
- MESSAGE:&c/nick &b<nickname>
# list of all active items, make sure to add any new items you create above to this list, else they will not be registered by the plugin
# NOTE the folder name "help" is reserved for the opening folder, any other name is allowed.
# folders are used to break down the amount of information presented to the user, the use may be to break down the help page into subcatogories so there is less
# for the user to go through to find what they want.
# layout with explanations
# <folder name / refrence> this is used in items if you want to switch to that folder (see above) make the name clear and understandable. must be different per folder
# <name> this is the name of the item that you used above when creating the item
# <location> this is the slot of the inventory that the item will be in (the first slot is 0, last slot on the first line is 8 etc.)
# NOTE: change the ":" if you ever change the seperator above (at top of config)
# <dislay name> this is the name that will be displayed at the top of the gui.
# <folder name / refrence>:
# - <name>:<location>
# displayName: <displayName>
# list of all the folders, make sure to add any new folders you create above to this list, else they will not be registered by the plugin
If you find a bug, please pm me about it and I will do my best to fix it.
please do not leave a bad review due to a bug if you do not try to contact me first.
A gui version of /help to make commands and ideas more comprehensible (includes folders)
- improvement on deleting items and selecting folders Aug 2, 2018
- Removing actions and bug fix Jul 31, 2018
- Help setup workflow improvements Jul 30, 2018