# **CommandGUI Plugin**<\/p>\n
## **Overview**
\nCommandGUI is a Minecraft Spigot plugin that provides players with a custom GUI to execute commands as the player interacting with the GUI. The GUI is fully configurable, allowing you to define items, commands, and layout. Players can also receive a custom item that opens the GUI when used.<\/p>\n
—<\/p>\n
## **Features**
\n– **Custom GUI**: A player-friendly interface to execute commands with a click.
\n– **Configurable Items**: Define items, their appearance, and the commands they execute in the GUI via the configuration file.
\n– **Dynamic Inventory Sizing**: Automatically adjusts the GUI size based on the number of items.
\n– **Customisable Tool**: Players can use a custom tool to open the GUI.
\n– **Command Reload**: Easily reload the plugin’s configuration with `\/commandgui reload`.<\/p>\n
—<\/p>\n
## **Commands**
\n### `\/commandgui`
\n– **Description:** Opens the Command GUI for the player.
\n– **Aliases:** `\/cg`<\/p>\n
### `\/commandgui tool`
\n– **Description:** Gives the player a tool that opens the Command GUI when used.
\n– **Aliases:** `\/cg tool`<\/p>\n
### `\/commandgui give ### `\/commandgui help` ### `\/commandgui reload` —<\/p>\n ## **Permissions** —<\/p>\n ## **Installation** —<\/p>\n ## **Configuration** “`yaml gui-items: – slot: 1 – slot: 2 ### Configuration Options<\/p>\n #### General Settings #### GUI Items – **`name`**: The display name of the item in the GUI, with color codes supported (e.g., `&aGo to Spawn`). —<\/p>\n ## **Usage** 2. **Adding Items**: —<\/p>\n ## **Contributing** —<\/p>\n ## **License** — <\/p>\n ### **Thanks for using CommandGUI**<\/p>\n","protected":false},"excerpt":{"rendered":" Customizable Command GUI for Spigot\/Paper<\/p>\n","protected":false},"featured_media":44591,"template":"","meta":{"_minecraft_slug":"commandgui","_minecraft_project_id":"nyJoB1vO","_minecraft_author":"Alfie51m","_minecraft_license":"Apache-2.0","_minecraft_downloads":704,"_minecraft_follows":5,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"commandgui.zip","_minecraft_size_bytes":104657,"_minecraft_version_count":8,"_minecraft_updated_at":"2026-05-16T09:36:43.896489Z","_minecraft_date_created":"2024-12-30T07:27:25.194374Z","_minecraft_date_modified":"2026-02-20T23:29:02.010197Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/commandgui","_minecraft_icon_attachment_id":44591,"_minecraft_imported_at":"2026-06-02T02:53:08+00:00","_minecraft_import_hash":"4fb7984e250049a9b51b0e5a004e043a","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[124,90,127,129,92],"mod_loader":[130,132,134],"minecraft_version":[62,37,40,41,73,74,38,78,79,80,81,82],"class_list":["post-44590","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-bukkit","mod_category-optimization","mod_category-paper","mod_category-spigot","mod_category-utility","mod_loader-bukkit","mod_loader-paper","mod_loader-spigot","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-11","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9"],"yoast_head":"\n
\n– **Description:** Gives the specified player the Command GUI Tool.
\n– **Aliases:** `\/cg give
\n– **Description:** Displays all the plugin’s commands.
\n– **Aliases:** `\/cg help`<\/p>\n
\n– **Description:** Reloads the plugin’s configuration.
\n– **Aliases:** `\/cg reload`<\/p>\n
\n| Permission | Description | Default |
\n|———————|————————————–|———|
\n| `commandgui.use` | Allows player to open the GUI. | OP |
\n| `commandgui.bypass` | Allows player to bypass cooldowns. | OP |
\n| `commandgui.tool` | Gives player a tool to open the GUI. | OP |
\n| `commandgui.give` | Gives another player the GUI Tool. | OP |
\n| `commandgui.reload` | Allows reloading the plugin config. | OP |<\/p>\n
\n1. Download the CommandGUI plugin `.jar` file.
\n2. Place the `.jar` file in your server’s `plugins` directory.
\n3. Start the server to generate the default configuration file.
\n4. Configure the plugin by editing `plugins\/CommandGUI\/config.yml`.
\n5. Reload the plugin with `\/commandgui reload` or restart the server.<\/p>\n
\nThe `config.yml` file allows you to customize the items in the GUI.<\/p>\n
\n# General settings
\nlanguage-file: “en_us.yml” # Default language file. Changing languages will break existing CommandGUI tools!
\nverbose-mode: false # Set to true to enable verbose messages globally for all items (default fallback)
\ngui-size-mode: “dynamic” # Options: “dynamic”, “fixed”
\ngui-tool: “COMPASS” # This is the item used to open the GUI given by “\/cg tool”<\/p>\n
\n – slot: 0
\n name: “&aGo to Spawn”
\n command: “spawn”
\n item: “COMPASS”
\n run-as-player: true
\n cooldown: 0 # No cooldown
\n verbose: true # Always log interaction for this item
\n lore:
\n – “&7Click to teleport to spawn”<\/p>\n
\n name: “&cHeal”
\n command: “heal”
\n item: “GOLDEN_APPLE”
\n run-as-player: true
\n cooldown: 30 # 30 seconds cooldown
\n verbose: false # Never log interaction for this item
\n lore:
\n – “&7Click to heal yourself”<\/p>\n
\n name: “&bDiamonds”
\n command: “give %player% diamond 1”
\n item: “DIAMOND”
\n run-as-player: false
\n cooldown: 60 # 60 seconds cooldown
\n # No verbose field; falls back to global verbose-mode
\n lore:
\n – “&bReceive a diamond!”
\n – “&3This is a server reward.”
\n“`<\/p>\n
\n– **`language-file`**: The language file to use (default: `en_us.yml`).
\n– **`verbose-mode`**: If `true`, displays verbose messages for item interactions globally (default: `false`).
\n– **`gui-size-mode`**: Determines the size of the GUI. Options:
\n – `”dynamic”`: Adjusts the inventory size based on the number of items.
\n – `”fixed”`: Sets the GUI size to a fixed double chest (54 slots).
\n– **`gui-tool`**: Sets the tool used to open the GUI.<\/p>\n
\nEach item in the GUI has the following options:<\/p>\n
\n– **`command`**: The command executed when the item is clicked (e.g., `spawn` or `give %player% diamond 1`).
\n– **`item`**: The item’s material (e.g., `DIAMOND`, `GOLDEN_APPLE`, `COMPASS`).
\n– **`slot`**: The inventory slot for the item (optional, auto-increment if not provided).
\n– **`lore`**: A list of text lines displayed as the item’s lore (optional, supports color codes).
\n– **`run-as-player`**: If `true`, the command will run as the player. If `false`, the command will run as the console (default: `false`).
\n– **`cooldown`**: The cooldown in seconds before the item can be used again (default: `0` for no cooldown).
\n– **`verbose`**: If `true`, overrides the global `verbose-mode` and enables verbose logging for this item (optional).<\/p>\n
\n1. **Opening the GUI**:
\n – Use the `\/commandgui` command to open the GUI.
\n – Alternatively, use the tool provided with `\/commandgui tool`.<\/p>\n
\n – Edit the `config.yml` file to add or modify items in the GUI.
\n – Reload the configuration with `\/commandgui reload`.<\/p>\n
\nContributions are welcome! Please fork the repository, make your changes, and submit a pull request.<\/p>\n
\nThis plugin is licensed under the Apache License 2.0.<\/p>\n