hClansMenuAddon
Configurable Clan Menu Addon for hClans Servers
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
hClansMenuAddon is an addon for
hClans that adds a configurable clan menu.
The addon registers a new clan subcommand, opens a custom GUI, displays clan information and allows you to create clickable menu items that execute configured actions.
The menu is fully configured through YAML: size, title, items, slots, materials, names, lore, custom heads, glow, CustomModelData, click actions and command aliases.
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Main Features
- Adds a configurable /clan menu subcommand.
- Custom inventory menu for hClans.
- Configurable menu size.
- Configurable menu title.
- Optional clan-only access.
- Custom GUI items.
- Slot ranges support.
- Custom materials.
- Custom player heads and base64 heads.
- Custom item names and lore.
- CustomModelData support.
- Glow support.
- Hide attributes support.
- Click-based actions.
- Command aliases through config.
- Optional tab-complete visibility.
- Clan placeholders in menu title, item names and lore.
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
How It Works
Players open the menu through the clan subcommand:
When the command is used, the addon checks whether the player is in a clan if
requireClan is enabled.
If the player is allowed to open the menu, the addon builds the GUI from the configuration file, applies placeholders, creates all configured items and opens the inventory.
When a player clicks an item, the addon reads the click action from the item configuration and executes the configured actions.
────────────────────────────────────────
Clan-Only Access
The menu can be restricted only to players who are in a clan.
This is controlled by:
Code (Text):
settings:
menu:
requireClan: true
If the player is not in a clan, the addon runs the configured
notInClan actions.
────────────────────────────────────────
Custom Menu Layout
The menu size can be configured as a standard Minecraft inventory size.
Supported sizes:
Code (Text):
9
18
27
36
45
54
The title is configurable and supports clan placeholders.
Example:
Code (Text):
settings:
menu:
size: 54
title: "&0Clan menu {clan}"
────────────────────────────────────────
Custom Items
Every item in the menu can be configured separately.
Item settings include:
- single slot or multiple slots
- slot ranges
- material
- amount
- display name
- lore
- CustomModelData
- glow
- hidden attributes
- custom skull owner
- base64 head texture
- click actions
Example slot formats:
Code (Text):
slot: 22
slots:
- "10-16"
- "19"
- "25"
This makes it possible to create borders, buttons, information items and navigation items directly from the config.
────────────────────────────────────────
Custom Heads
The addon supports custom heads through the hClans skull API.
You can use base64 head values in item material configuration.
Example:
Code (Text):
material: basehead-BASE64_VALUE
This allows you to create cleaner and more unique menu buttons without requiring separate resource packs.
────────────────────────────────────────
Click Actions
Items can execute actions when clicked.
Default configuration examples use actions such as:
Code (Text):
[MESSAGE]
[PLAYER]
[CLOSE]
Example:
Code (Text):
actions:
click:
- "[PLAYER] execute:/clan storage"
- "[CLOSE]"
You can use menu items to redirect players to other clan commands, open other menus, show messages or close the inventory.
────────────────────────────────────────
Click Types
The addon supports different click action keys.
Examples:
Code (Text):
click
left
right
shift_left
shift_right
middle
This allows different behavior depending on how a player clicks an item.
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Configuration
Default configuration structure:
Code (Text):
settings:
command:
visibleInTabComplete: true
aliases: {}
menu:
size: 54
title: "&0Clan menu {clan}"
requireClan: true
items:
info:
slot: 4
material: BOOK
name: "#FDBE00Clan information"
lore:
- "Clan: {clan}"
- "Members: {members}"
- "Owner: {owner}"
- "Level: {level}"
glow: true
actions: {}
────────────────────────────────────────
Action Sections
Global action sections:
Code (Text):
notInClan
usage
open
Item action section example:
Code (Text):
items:
storage:
slot: 23
material: CHEST
name: "Clan Storage"
actions:
click:
- "[PLAYER] execute:/clan storage"
────────────────────────────────────────
Placeholders
The addon supports placeholders in menu title, item names, lore and actions.
Available placeholders include:
Code (Text):
{player}
{display}
{uuid}
{clan}
{clanColor}
{members}
{memberCount}
{owner}
{ownerUuid}
{level}
Additional placeholders may also be processed through hClans formatting utilities.
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Commands
Main command:
Additional aliases for the
menu subcommand can be configured in:
Code (Text):
settings.command.aliases
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Permissions
hClansMenuAddon does not define separate Bukkit permissions in the current version.
Access is controlled through:
- whether the player is in a clan
- the settings.menu.requireClan option
- permissions of commands executed by menu item actions
If an item action runs another command, that command may still require its own permission depending on the target plugin.
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Requirements
- Java 17 or newer.
- Minecraft 1.16 or newer.
- A server compatible with Bukkit/Spigot/Paper.
- hClans plugin.
Important: hClansMenuAddon is an addon and requires
hClans to work.
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Installation
- Install hClans on your server.
- Place hClansMenuAddon.jar into the plugins folder.
- Start or restart the server.
- Open the generated configuration file.
- Configure menu size, title, items and actions.
- Restart the server again or reload hClans/addons in your normal workflow.
Configuration file:
Code (Text):
plugins/hClansMenuAddon/config.yml
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Notes
- The addon registers menu as a clan subcommand.
- The menu can be hidden from tab-complete through the config.
- The menu can require clan membership.
- All GUI items are configured through YAML.
- Slot ranges can be used for borders and decorations.
- Item clicks can execute configured actions.
- The addon uses hClans systems for command registration, actions and placeholders.