HelpGUI 2.5.0-BETA

A inventory-based help-request-plugin!

  1. Andre_601
    Native Minecraft Version:
    1.13
    Tested Minecraft Versions:
    • 1.13
    Source Code:
    https://github.com/Andre601/HelpGUI
    HelpGUI.png

    Minecraft 1.13+: Use the latest version!
    Minecraft 1.12 and older: Use Version 1.7.1

    [​IMG] [​IMG]

    HelpGUI_about.png

    HelpGUI is a simple and easy to use help-request-plugin!
    You just need to type /help in the chat and an Inventory with the head of every player on the server opens!
    Now you can just click on a playerhead to ask for help!

    Simple as that!

    But HelpGUI comes with much more!
    It has a user/group search, lets you remove/add players to the GUI, make it only show staff (players with helpgui.staff), enable/disable it in certain worlds and for certain players and lets you change the messages to your liking.

    HelpGUI_commands.png

    Help [Name|group:<groupname>]
    Command for opening the help-menu.
    You can add a Name at the end, to search for any player, that has a name, starting with that specifc String.
    You can also search by group. Just add group:<groupname> after the command, to search for players with the group <groupname>

    HelpGUI [help|reload]
    Main command! It has two args: Help and reload.
    Help is for showing the available commands.
    Reload is to reload the files.

    HelpGUI_permissions.png

    helpgui.admin
    Admin-permission that gives:
    • helpgui.help (to use /helpgui help)
    • helpgui.reload (to use /helpgui reload)
    • helpgui.staff (Used for the Staff-mode)
    helpgui.disablehelp
    Used to disable the command /help for a user or group

    HelpGUI_installation.png
    1. Download the jar.
    2. Put it in the plugins folder
    3. restart the server
    4. Edit the config.yml to your liking
    5. Reload it with /helpgui reload

    HelpGUI_screenshots.png

    Here are some screenshots that show the plugin in action:
    Requesting help:
    [​IMG]

    The different items in the Inventory:
    [​IMG]
    [​IMG]
    [​IMG]
    [​IMG]

    The messages when sending/receiving a help-request:
    [​IMG]
    [​IMG]

    HelpGUI_config.png

    Code (YAML):
    #   _   _          _             _____            _   #
    #  | | | |        | |           / ____)          (_)  #
    #  | |_| |   ___  | |   ____   | /  __   _    _   _   #
    #  |_____|  / o \ | |  |  _ \  |_| (__| | |  | | | |  #
    #   _   _  |  __/ | |_ | |_) |  ______  | \__/ | | |  #
    #  |_| |_|  \___) |__/ |  __/   \____/   \____/  |_|  #
    #                      | |                            #
    #                      |_|  By Andre_601              #
    #                                                     #
    # Spigot Resource:                                    #
    #   https://www.spigotmc.org/resources/helpgui.33245/ #
    #                                                     #
    # GitHub:                                             #
    #   https://github.com/Andre601/HelpGUI               #
    #                                                     #
    # Wiki:                                               #
    #   https://github.com/Andre601/HelpGUI/wiki          #

    Settings
    :
     #
      # Debug:      Enable/Disable debug mode. This will print stacktraces and other information prefixed with "[DEBUG]"
      # ShowBanner: Should the banner be shown in console, when the plugin gets enabled?
      #
      Debug
    : false
      ShowBanner
    : true
      DisabledPlayers
    :
       #
        # Choose which player heads are shown in the GUI
        #
        # Modes:
        #   blacklist  ->  Players listed below will *NOT* be shown in the GUI (Default Option)
        #   whitelist  ->  Players listed below *WILL ONLY* be shown in the GUI
        #   staff      ->  Only players with the "helpgui.staff" permission node will be shown in the GUI
        #
        Mode
    : 'blacklist'
        #
        Players
    :
       - player1
        - player2
        - player3
      DisabledWorlds
    :
       #
        # Choose which worlds the /help command works in
        #
        # Modes:
        #   blacklist  ->  Worlds listed below will *NOT* have /help functioning (Default Option)
        #   whitelist  ->  Worlds listed below *WILL ONLY* have /help functioning
        #
        Mode
    : 'blacklist'
        #
        Worlds
    :
       - Example_World
        - Example_World_the_end
        - Example_World_nether
      #
      #
      #
      Inventory
    :
       #
        # The title of the inventory. You can't have more than 32 characters, including color codes.
        # This is also used as the prefix for messages.
        #
        Title
    : '&7[&aHelp&2GUI&7] '
        #
        # Define the items here for the info, the next/previous pages and the filler.
        # Colorcodes and placeholders from PlaceholderAPI are supported in both Display name and lore.
        # Placeholders won't be changed, if PlaceholderAPI isn't installed.
        # Only placeholder that will be changed is %player% for the Player-item (Name only).
        #
        # 1.13 Material list: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html
        #
        Items
    :
          Info
    :
            Item
    : 'BOOK'
            Name
    : '&7Click on a player head!'
            Lore
    :
           - ''
            - '&7Click on a playerhead in'
            - '&7the inventory, to send a'
            - '&7help-request to that player!'
            - ''
          NextPage
    :
            Item
    : 'SIGN'
            Name
    : '&bNext page >'
            Lore
    :
           - ''
          PrevPage
    :
            Item
    : 'SIGN'
            Name
    : '&b< Previous page'
            Lore
    :
           - ''
          Filler
    :
            Item
    : 'BLACK_STAINED_GLASS_PANE'
            Name
    : '&7'
            Lore
    :
           - ''
          Player
    :
            Name
    : '&7%player%'
            Lore
    :
           - ''
            - '&7Rank
    : &b%vault_rank%'
            - '&7Location
    : &b%player_world%, %player_x%, %player_y%, %player_z%'
            - ''
    Messages
    :
      Startup
    :
       #
        # These messages appear at startup of the plugin
        # Color codes are *NOT* supported here
        #
        # VaultFound:             Will be shown if Vault is found and connected to successfully
        # VaultNotFound:          Will be shown if Vault isn't found
        # PlaceholderAPIFound:    If PlaceholderAPI was found
        # PlaceholderAPINotFound: If PlaceholderAPI wasn't found
        #
        VaultFound
    : 'Hooked into Vault for group-search'
        VaultNotFound
    : 'Vault wasn''t found! Group-search disabled.'
        PlaceholderAPIFound
    : 'Hooked into PlaceholderAPI.'
        PlaceholderAPINotFound
    : 'Couldn''t find PlaceholderAPI.'
      HelpRequest
    :
       #
        # Messages for help send/recieved
        #
        # Sender:     Message sent to the sender of the request
        # Recipient:  Message sent to the recipient of the request
        #
        # Placeholders:
        #   %sender%     ->  Name of the sender. (Only in Recipient available!)
        #   %recipient%  ->  Name of the recipient. (Only in Sender available!)
        #
        #   You can use placeholders from PlaceholderAPI.
        #   The placeholders will contain values from either the sender, or recipient, depending on which message it is.
        #   Example: %player_name% turns into the name of the Sender in "Sender".
        #
        Sender
    : '&7Help-Request sent to &b%recipient%&7!'
        Recipient
    : '&b%sender% &7needs your help!'
      Errors
    :
       #
        # Messages for different errors/issues.
        #
        # CommandDisabled:  If the player has the permission helpgui.disablehelp
        # NotOnline:        If the targeted player is offline
        # DisabledWorld:    Shown when a player uses the command in a disabled world
        # NoPlayersFound:   If /help [player] had no results
        # VaultNotEnabled:  If you use /help group:[group] but Vault isn't enabled/installed
        # NoPermission:     No permission message
        #
        CommandDisabled
    : '&cYou are not allowed to use this command.'
        NotOnline
    : '&cThis player is not online!'
        DisabledWorld
    : '&cYou cannot use HelpGUI in this world.'
        NoPlayersFound
    : '&cNo players found. :,('
        VaultNotEnabled
    : '&cVault is not enabled/installed!'
        NoPermission
    : '&cYou do not have permission for that!'
        NoGroup
    : '&cYou need to provide a group after &4group:'
      Config
    :
       #
        # ConfigKey for reloading the config.
        #
        # AttemptReload:       Message on start of reload.
        # Reloaded:            When the plugin successfully reloaded the config.
        # ReloadNotifyPlayer:  Players with helpgui.notify receive this message.
        #
        # Placeholder:
        #   %player%  ->  Name of the player, that reloaded the plugin. (Only for ReloadNotifyPlayer)
        #
        AttemptReload
    : '&7Reloading config.yml...'
        Reloaded
    : '&aconfig.yml successfully reloaded!'
        ReloadNotifyPlayer
    : '&b%player% &7reloaded the config!'
     
    Check out my other plugin PingNachricht! Just click on the image below!
    [​IMG]
    inkdrak likes this.

Recent Reviews

  1. tindeptrai
    tindeptrai
    5/5,
    Version: 1.7.1
    hey, can you add timeout for each time / help???????????????????????????????????????????????????
    1. Andre_601
      Author's Response
      I don't really understand, what you actually want...
      Please give a better explanation in the discussion.
  2. Instantout
    Instantout
    5/5,
    Version: 1.3
    Love The Plugin, It Suits the Needs for Players to Get Instant Help Also
    Good Developer, You Can Rely for him to Give you a Response within 24 hours.
  3. BlueYoshi68
    BlueYoshi68
    5/5,
    Version: 1.0.1
    i r8 8/8 would download again
    ______________________________________________________________________________________________________________________
    1. Andre_601
      Author's Response
      thanks. I'm happy, that you like it :)
  4. Jimkimhk
    Jimkimhk
    5/5,
    Version: 1.0
    =========================================
    thx your idea is very good sorry my bad english.
    =========================================