HMC Plugins Documentation

https://docs.hibiscusmc.com/
Admin
This project provides comprehensive documentation for HMC plugins, covering features, commands,...
Tokens:24,519
Snippets:339
Trust Score:5.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### Wardrobe Configuration Example

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/wardrobes/wardrobe-setup

Example configuration for setting up wardrobe locations in config.yml. Defines NPC spawn, player viewing, and exit points.

```yaml
  wardrobes:  
    default: # Id of the wardrobe  
      npc-location:  
        world: "world"  
        x: 0  
        y: 0  
        z: 0  
        yaw: 0  
        pitch: 0  
      viewer-location:  
        world: "world"  
        x: 5  
        y: 0  
        z: 5  
        yaw: 0  
        pitch: 0  
      leave-location:  
        world: "world"  
        x: 5  
        y: 5  
        z: 5  
        yaw: 0  
        pitch: 0  


```

--------------------------------

### Generic Item Example

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/serializers/items

A comprehensive example demonstrating various item properties like material, name, lore, model data, enchantments, and NBT tags.

```yaml
material: PAPER
name: "<WHITE>A Paper Backpack!"
lore:
  - ""
  - "<gray>Enabled: <#6D9DC5>%HMCCosmetics_equipped_beanie%"
  - "<gray>Allowed: <#6D9DC5>%HMCCosmetics_unlocked_beanie%"
model-data: 4
model-id: "minecraft:diamond"
amount: 2
unbreakable: true
glowing: true
nbt-tags:
  customNBTTag: 1
enchants:
  luck: 1
item-flags:
  - HIDE_ENCHANTS
owner: "LoJoSho"
texture: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvZmU1YTgzNDFjNDc4YTEzNDMwMjk4MWU2YTc3NThlYTRlY2ZkOGQ2MmEwZGY0MDY3ODk3ZTc1NTAyZjliMjVkZSJ9fX0="
color: "#FFFFFF"  
```

--------------------------------

### Updater Configuration Example

Source: https://docs.hibiscusmc.com/hmcwraps/config/updater

This snippet shows an example of how to configure the updater settings in the configuration file. It includes enabling the checker, setting the check frequency to 3 hours, and specifying Polymart as the update platform.

```yaml
# The version checker configuration  
updater:  
  # If the version checker should be enabled  
  enabled: true  
  # How often the version checker should check for updates  
  frequency: '3h'  
  # Where the version checker should check for updates (POLYMART, SPIGOT_MC)  
  platform: 'POLYMART'  

```

--------------------------------

### Computer Plushie Hat Example

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/serializers/items

Example of a player head item with a custom texture for a 'Computer Plushie' hat.

```yaml
material: PLAYER_HEAD
name: "<WHITE>Computer Plushie!"
glowing: true
texture: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvZDkzNGFlNjg2MGJiM2Y2ZTYxZGU3ZjVhYzY5Nzg2MzhmNzc4YTdmM2ZiMmE5ZmZjMjE2ZTcxZDk3MjMyYTFkYiJ9fX0="  
```

--------------------------------

### Colorful Cap Example

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/serializers/items

Example of a leather helmet item with a custom color applied.

```yaml
material: LEATHER_HELMET
name: "<BLUE>Colorful Cap!"
color: "#02eeff"  
```

--------------------------------

### Preview Action Example

Source: https://docs.hibiscusmc.com/hmcwraps/config/actions

Previews the wrap when the physical wrapper is right-clicked in the air. No arguments are needed for this action.

```yaml
items:
  SOME_COLLECTION:
    cool_wrap:
      id: 'nexo:cool_wrap'
      physical:
        id: 'nexo:cool_wrap_wrapper'
        actions:
          interact-right-air: # This previews the wrap when air is right-clicked with the phyiscal wrappper
            PREVIEW:
            - ''
```

--------------------------------

### Basic Wrap Configuration

Source: https://docs.hibiscusmc.com/hmcwraps/config/wraps

Example of a basic wrap configuration for a DIAMOND_SWORD.

```yaml
enabled: true
items:
  DIAMOND_SWORD:
    wraps:
      fire_sword:
        id: '1'
        name: '<red>Fire Sword <gray>Wrap'
        physical:
          id: 'PAPER'
          name: '<red>Fire Sword <gray>Wrap'
          model-id: '2'
          keep-after-unwrap: true

```

--------------------------------

### Big Head Example

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/serializers/items

Example of a player head item where the owner is dynamically set using a placeholder.

```yaml
material: PLAYER_HEAD
name: "<RED>%player_name% # This placeholder will be processed when a player equips this as a cosmetic item or in a menu.   
owner: "%player_name%"  
```

--------------------------------

### ItemsAdder Example with Shared Model ID

Source: https://docs.hibiscusmc.com/hmcwraps/config/collections

This example illustrates how to configure items using ItemsAdder, ensuring all items within a conceptual collection share the same 'model_id' for consistent wrap application. Note the shared 'model_id: 5000' across different item types and materials.

```yaml
info:
  namespace: hmcwraps
items:
  fire_sword:
    display_name: '&fFire Sword'
    resource:
      material: NETHERITE_SWORD
      generate: false
      model_path: fire_sword
      model_id: 5000
  fire_pickaxe:
    display_name: '&fFire Pickaxe'
    resource:
      material: NETHERITE_PICKAXE
      generate: false
      model_path: fire_pickaxe
      model_id: 5000
  fire_sword_diamond:
    display_name: '&fFire Sword'
    resource:
      material: DIAMOND_SWORD
      generate: false
      model_path: fire_sword
      model_id: 5000
  fire_pickaxe_diamond:
    display_name: '&fFire Pickaxe'
    resource:
      material: DIAMOND_PICKAXE
      generate: false
      model_path: fire_pickaxe
      model_id: 5000

```

--------------------------------

### Wrap Configuration with Armor Imitation

Source: https://docs.hibiscusmc.com/hmcwraps/config/wraps

Example of a wrap configuration for DIAMOND_HELMET with armor imitation enabled.

```yaml
enabled: true
items:
  DIAMOND_HELMET:
    wraps:
      fire_sword:
        id: '1'
        name: '<blue>John Doe <gray>Wrap'
        color: '#ff0000'
        armor-imitation: true

```

--------------------------------

### Example GUI Item Configuration

Source: https://docs.hibiscusmc.com/hmcwraps/config/gui

Defines a GUI item with a specific material, name, and click action. Use `EMPTY` for an empty item slot.

```yaml
    45:
      # The Bukkit material or hook
      id: 'GRAY_STAINED_GLASS_PANE'
      # The name
      name: '<rainbow>Example GUI Item'
      # Actions
      actions:
        # When the item is clicked in any way
        any:
          # Send a message
          MESSAGE:
            - '<green>You clicked the <rainbow>Example GUI Item!!!'

```

--------------------------------

### Item Hook Configuration Example

Source: https://docs.hibiscusmc.com/hmcleaves/optional-dependencies

Configure an item hook by setting the HMCLeaves item ID and the Item Hook ID to be the same. This example shows the configuration for 'pine_log'.

```yaml
logs:
  # This is the id of the HMCLeaves item *and* the Item Hook item
  pine_log:
    log-material: OAK_LOG
    stripped-log-material: STRIPPED_OAK_LOG
```

--------------------------------

### Example Command Reward Configuration

Source: https://docs.hibiscusmc.com/hmcrewards/Reward-Types

This snippet shows how to configure a command reward, including required inventory space, display icon, and the commands to be executed upon claiming.

```yaml
rewards:
  example_command:
    type: "command"

    # Required Inventory Slots for claiming
    required-space: 3

    # icon
    display:
      material: 'oraxen:gift_box'
      name: '<red>Example Command Reward'
      lore:
        - '<#d24c9f><bold>Contains:'
        - '<dark_gray>x1 <aqua>Diamond'
        - '<dark_gray>x1 <gold>Enchanted Golden Apple'
        - '<dark_gray>x1 <green>Emerald'

    # Commands to deliver to player
    commands:
      - 'say %player% claimed a command reward from HMCRewards!'
      - 'minecraft:give %player% minecraft:diamond 1'
      - 'minecraft:give %player% minecraft:enchanted_golden_apple 1'
      - 'minecraft:give %player% minecraft:emerald 1'

```

--------------------------------

### Example Permission Settings

Source: https://docs.hibiscusmc.com/hmcwraps/config/permission_settings

Configure how permissions are handled for wrap inventories, previews, and item wrapping. This includes enabling/disabling checks for opening inventories, previews, and physical/virtual item wrapping, as well as setting an interval for checking wraps without permission.

```yaml
# Settings on how permissions should be handled  
permissions:  
  # If the wrap inventory open permission should be checked on wraps inventory open  
  inventory-permission: false  
  # If the preview should be disabled if the player doesn't have the permission for the wrap  
  preview-permission: false  
  # If permission checks should be performed during usage for...  
  # ...physical wraps  
  check-permission-physical: false  
  # ...virtual wraps  
  check-permission-virtual: true  
  # If permissions should be checked on appliance for...  
  # ...physical wraps  
  permission-physical: false  
  # ...virtual wraps  
  permission-virtual: true  
  # The interval in minutes to check for wraps without permission, set to -1 to disable  
  inventory-check-interval: 10  


```

--------------------------------

### Message Action Example

Source: https://docs.hibiscusmc.com/hmcwraps/config/actions

Sends a message to the player. This action can be used multiple times within a single configuration.

```yaml
items:
  SOME_COLLECTION:
    1:
      actions:
        # When the wrap is applied
        wrap:
          MESSAGE:
            - '<red>yo pog yo unwrapped noice'
            - '<yellow>I luv cheese'
        # When the wrap is applied virtually
        wrap-virtual: {}
        # When the wrap is applied physically
        wrap-physical: {}
        # When the wrap is removed
        unwrap: {}
        # When the wrap is removed virtually
        unwrap-virtual: {}
        # When the wrap is removed physically
        unwrap-physical: {}
        # When the wrap is previewed
        preview: {}
        # When the wrapped item is used to hit any entity including players
        hit-any: {}
        # When the wrapped item is used to hit an entity
        hit-entity: {}
        # When the wrapped item is used to hit a player
        hit-player: {}
        # When the player presses any mouse button
        interact: {}
        # When a block is clicked with the left button
        interact-left-block: {}
        # When a block is clicked with the right button
        interact-right-block: {}
        # When nothing is clicked with the left button
        interact-left-air: {}
        # When nothing is clicked with the right button
        interact-right-air: {}
```

--------------------------------

### Preview Configuration Example

Source: https://docs.hibiscusmc.com/hmcwraps/config/preview

Configure various aspects of item previews, such as display type, duration, rotation, sneak cancellation behavior, and bobbing effects. When 'HAND' type is used, rotation and bobbing are ignored.

```yaml
# Preview settings  
preview:  
  # The type of the preview, either 'FLOATING' or 'HAND', floating being the item turning in the air and  
  # item being the players item in hand turning into the wrap temporarily.  
  # When using 'HAND', rotation and bobbing will be ignored. (The preview item is client-side only)  
  type: 'FLOATING'  
  # Duration of the preview in seconds  
  duration: 5  
  # Rotation per tick (50ms)  
  rotation: 5  
  # Sneak to cancel preview settings  
  sneak-cancel:  
    # If the preview should be cancelled when sneaking  
    enabled: true  
    # If the configured message should be sent as an action bar while previewing  
    action-bar: true  
  # Lets the preview item move up and down  
  bobbing:  
    # If the item should bob while previewing  
    enabled: true  
    # How fast it should bob up and down  
    speed: 7  
    # How far it should bob up and down  
    intensity: 0.25  

```

--------------------------------

### Main Menu Configuration

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/menus/GUI-Configuration

A basic example of a main menu configuration file. This defines the structure and items for the primary menu users will interact with.

```yaml
title: "<white>Default Menu"
rows: 1
permission: hmccosmetics.menu.default
items:
  hats_menu:
    slots:
      - 2
    item:
      material: PAPER
      name: "<blue>Hat Cosmetics"
      amount: 1
    type: empty
    actions:
      any:
        - "[MENU] hat_cosmetics"
  backpack_menu:
    slots:
      - 3
    item:
      material: PAPER
      name: "<blue>Backpack Cosmetics"
      amount: 1
    type: empty
    actions:
      any:
        - "[MENU] backpack_cosmetics"
  hand_accessory_menu:
    slots:
      - 4
    item:
      material: PAPER
      name: "<blue>Offhand Cosmetics"
      amount: 1
    type: empty
    actions:
      any:
        - "[MENU] offhand_cosmetics"
  balloon_menu:
    slots:
      - 5
    item:
      material: PAPER
      name: "<blue>Balloon Cosmetics"
      amount: 1
    type: empty
    actions:
      any:
        - "[MENU] balloon_cosmetics"

```

--------------------------------

### Wrap Configuration Example

Source: https://docs.hibiscusmc.com/hmcwraps/config/wraps

This snippet shows a basic configuration for a wrap, including permission, UUID, ID, color, wrap name, wrap lore, and physical wrap settings.

```yaml
# The permission to virtually apply this wrap (inventory) (not required)  
permission: 'hmcwraps.fire_sword'  
# The UUID (global identifier), has to be unique in ALL wraps!  
uuid: 1  
# Either custom model data (1) or a hook to get the custom model id (oraxen:my_sword)  
id: '1'  
# The color of the wrap (not required)  
color: '#ff0000'  
# The name applied to the item when wrapped  
wrap-name: '<red>Something cool'  
# The lore applied to the item when wrapped  
wrap-lore:  
  - 'hello!'  
# The physical wrap to apply (not required)  
physical: # A physical wrapper (not required)  

```

--------------------------------

### Configure EMOTE Cosmetic

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/cosmetics/Emotes

Example configuration for an EMOTE cosmetic named 'handstand'. Ensure the animation file matches the configured name.

```yaml
handstand:
  slot: EMOTE
  animation: handstand

```

--------------------------------

### Configure Collections in config.yml

Source: https://docs.hibiscusmc.com/hmcwraps/config/collections

This example demonstrates how to integrate a collection definition directly into the main HMCWraps configuration file (config.yml).

```yaml
# The collections entry in config.yml
collections:
  # The name of the collection
  SWORDS:
    # All items the collection contains
    - 'NETHERITE_SWORD'
    - 'DIAMOND_SWORD'
    - 'IRON_SWORD'
    - 'STONE_SWORD'
    - 'WOODEN_SWORD'

```

--------------------------------

### Getting the API instance

Source: https://docs.hibiscusmc.com/hmcleaves/api

Retrieves the singleton instance of the HMCLeavesAPI.

```APIDOC
## Getting the API instance

### Description
Retrieves the singleton instance of the HMCLeavesAPI.

### Method
`HMCLeavesAPI.getInstance()`

### Code Example
```java
HMCLeavesAPI api = HMCLeavesAPI.getInstance();
```
```

--------------------------------

### Preservation Configuration Example

Source: https://docs.hibiscusmc.com/hmcwraps/config/preservation

Configure preservation settings for model ID, color, name, and lore. Use `original-enabled` to restore previous values and `default-enabled` to set a fallback value.

```yaml
# Settings for model id & color preservation  
preservation:  
  model-id:  
    # If the model id should be restored after it gets unwrapped from before the item got wrapped  
    # NOTE: If there is an original model id stored on the item, that will get preferred over original model ids  
    # NOTE: Disabling both options will result in all items ending up with the model id '-1' when unwrapped  
    original-enabled: false  
    # If the model id should be set to the id below when the item is unwrapped  
    default-enabled: false  
    # The default model ids for items that get unwrapped  
    defaults:  
      # Every item in the 'PICKAXES' collection will end up with the model id 0 after getting unwrapped  
      PICKAXES: 0  
      # Iron shovels will end up with the model id 0 after getting unwrapped  
      IRON_SHOVEL: 0  
  # Basically the same as model-id preservation, but with the color  
  color:  
    original-enabled: false  
    default-enabled: false  
    defaults: { }  
  # Still the same, but with the name  
  name:  
    original-enabled: false  
    default-enabled: false  
    defaults: { }  
  # I think you get the idea  
  lore:  
    original-enabled: false  
    default-enabled: false  
    defaults: { }
```

--------------------------------

### Unwrap Action Example

Source: https://docs.hibiscusmc.com/hmcwraps/config/actions

Closes the player's inventory. This action is used when an inventory item is clicked.

```yaml
inventory:
  items:
    1:
      actions:
        # When the item is clicked in any way
        any:
          UNWRAP:
            - ''
          MESSAGE:
            - 'YOU CLICKED THE <red>SPOOOOOKY <white>BUTTON!!1!!'
        # When the item is clicked using the left mouse button
        left: {}
        # When the item is clicked using the right mouse button
        right: {}
```

--------------------------------

### HELMET Cosmetic Configuration

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/cosmetics/Hats

Example configuration for a 'beanie' HELMET cosmetic. This defines its slot, permission, dyeability, and item properties.

```yaml
beanie:  
  slot: HELMET  
  permission: "hmccosmetics.beanie"  
  dyeable: true  
  item:  
    material: LEATHER_HORSE_ARMOR  
    model-data: 2  
    name: "<rainbow>Beanie Hat</rainbow>"  
    lore:  
      - ""  
      - "<gray>A basic beanie!"  
    amount: 1  


```

--------------------------------

### Listen to ItemWrapEvent

Source: https://docs.hibiscusmc.com/hmcwraps/api

Example of listening to the ItemWrapEvent and cancelling it. This demonstrates how to hook into HMCWraps events within your plugin.

```java
public class ItemWrapListener implements Listener {
      
    @EventHandler
    public void onItemWrap(ItemWrapEvent event) {
        event.setCancelled(true);
    }
      
}
  
public class SomePlugin extends JavaPlugin {
      
    public void onEnable() {
        Bukkit.getPluginManager().registerEvents(new ItemWrapListener(), this);
    }
  
}
```

--------------------------------

### Get Cosmetic by ID

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/api

Retrieve a specific cosmetic item using its unique identifier.

```java
Cosmetic cosmetic = HMCCosmeticsAPI.getCosmetic(id);
```

--------------------------------

### Configure a Kite Balloon Cosmetic

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/cosmetics/Balloons

Example configuration for a kite balloon cosmetic using ModelEngine. Set 'show-lead' to false to hide the leash and 'balloon-offset' to adjust the attachment point.

```yaml
kite:  
  slot: BALLOON  
  permission: "hmccosmetics.kite"  
  model: kite  
  show-lead: true # If this is not here, it'll default to true.  
  balloon-offset: # If this is not here, it'll default to what's found in the config  
    x: 0.5  
    y: 3  
    z: 0.5  
  item: # Because this relies on a model, the item here is only useful if you add it to a GUI.   
    material: PAPER  
    model-data: 7  
    name: "<blue>Kite"  
    amount: 1  

```

--------------------------------

### HMCWraps Wrap Configuration with ItemsAdder

Source: https://docs.hibiscusmc.com/hmcwraps/frequent_issues

Example of configuring a wrap in HMCWraps to use an ItemsAdder item. Use the shortest item identifier for the 'id' field.

```yaml
SWORDS:
  wraps:
    1:
      uuid: 'fire_sword'
      id: 'itemsadder:hmcwraps:fire_sword'
      (other configuration)

```

--------------------------------

### Configuring Wraps in config.yml

Source: https://docs.hibiscusmc.com/hmcwraps/config/wraps

Adds wraps directly within the main config.yml file. This example shows how to apply a 'fire_sword' wrap to a DIAMOND_SWORD, including its physical wrap configuration.

```yaml
items: # Items entry in config.yml
  DIAMOND_SWORD: # Where the wrap should be applicable. Either a material or a collection
    wraps:
      fire_sword:
        id: '1'
        name: '<red>Fire Sword <gray>Wrap'
        physical:
          id: 'PAPER'
          name: '<red>Fire Sword <gray>Wrap'
          model-id: '2'
          keep-after-unwrap: true
```

--------------------------------

### Get API Instance

Source: https://docs.hibiscusmc.com/hmcleaves/api

Retrieves the singleton instance of the HMCLeavesAPI. This is the primary entry point for interacting with the API.

```java
HMCLeavesAPI.getInstance();
```

--------------------------------

### Global Disable Configuration Example

Source: https://docs.hibiscusmc.com/hmcwraps/config/global_disable

This snippet shows how to configure global disables for various item properties in hmcwraps. Use this to prevent specific items from being wrapped by any wrap.

```yaml
# Items with these properties can't be wrapped  
global-disable:  
  # Any model id in this list can't be wrapped. If you want to disable items with no model id, use -1.  
  model-id:   
  - -1  
  - 2  
  # You can use hex or rgb, check the documentation. If you want to disable items with no color, use 'none'.  
  color:   
  - '#555555'  
  oraxen: [ ]  
  itemsadder: [ ]  
  mythic: []  
  nexo: []  
  executable-items: []  

```

--------------------------------

### Auction House and Trade Plugin Integration Configuration

Source: https://docs.hibiscusmc.com/hmcwraps/config/integrations

Configure blacklisting for auction house and trade plugins. This example enables blacklisting for virtual items and a specific wrap ('fire_sword').

```yaml
# Integrations with other plugins  
integrations:  
  # zAuctionHouse, AuctionGUI+, AxAuctions, AxTrade integration  
  auction-house:  
    # If the integration should be enabled, this will enable for zAuctionHouse and AuctionGUI+  
    enabled: true  
    # If the integration should be enabled for trade plugins as well (AxTrade), this also works if the main integration is disabled  
    trade-enabled: true  
    # If virtually wrapped items should be blacklisted from being listed in the auction house  
    blacklist-virtual: true  
    # If physically wrapped items should be blacklisted from being listed in the auction house  
    blacklist-physical: false  
    # Add the UUIDs of the wraps that should be blacklisted from being listed in the auction house  
    blacklisted-wraps:   
    - fire_sword  

```

--------------------------------

### Get HMCWraps Plugin Instance

Source: https://docs.hibiscusmc.com/hmcwraps/api

Retrieve the HMCWraps plugin instance if it is enabled. This is necessary to use other API methods.

```java
if (Bukkit.getPluginManager().isPluginEnabled("HMCWraps")) {
    var wraps = (HMCWraps) Bukkit.getPluginManager().getPlugin(HMCWraps.class);
}
```

--------------------------------

### Get CosmeticUser by Player ID

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/api

Retrieve a CosmeticUser object for a given player's unique ID.

```java
CosmeticUser user = HMCCosmeticsAPI.getUser(playerUnqiueId);
```

--------------------------------

### Wrap Access Range Configuration

Source: https://docs.hibiscusmc.com/hmcwraps/config/wraps

Defines specific item criteria for wrap access using include or exclude lists. This example restricts wraps to items with model IDs 22, 23, or 24.

```yaml
range:
  model-id:
    include:
    - 22
    - 23
    - 24
```

--------------------------------

### Get Item Wrap

Source: https://docs.hibiscusmc.com/hmcwraps/api

Retrieve the wrap associated with an item. Returns null if the item is not wrapped.

```java
var wrap = wraps.getWrapper().getWrap(item);
```

--------------------------------

### Basic Item Configuration

Source: https://docs.hibiscusmc.com/hmcwraps/config/item

The most basic ConfigItem configuration requires an ID and can include a name.

```yaml
item:  
  id: 'DIAMOND_SWORD'  
  name: '<red>Diamond <gray>Sword'
```

--------------------------------

### Get Amount of Unlocked Cosmetics in Slot

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/PlaceholderAPI

Retrieves the number of unlocked cosmetics a player has in a specific slot.

```APIDOC
## %hmccosmetics_amount_<slot>_unlocked%

### Description
Returns the amount of cosmetics a player has unlocked in a slot.

### Parameters
#### Path Parameters
- **<slot>** (string) - Required - The cosmetic slot. Accepted values: `HELMET`, `BACKPACK`, `OFFHAND`, `CHESTPLATE`, `LEGGINGS`, `BOOTS`.

### Response
- **integer** - The number of unlocked cosmetics in the specified slot.
```

--------------------------------

### Configure Wrapping Settings

Source: https://docs.hibiscusmc.com/hmcwraps/config/wrap_settings

This snippet shows the complete configuration structure for wrapping settings in config.yml. It covers wrapper stackability, wrapper return after item break, and detailed rewrapping options for virtual and physical wraps, including rewrapping with the same wrap.

```yaml
# Settings related to wrapping  
wrapping:  
  # If wrappers and unwrappers should be unstackable, changing this will only affect newly given items  
  make-wrappers-unstackable: false  
  # If the physical wrapper should be given back after the item breaks with the wrap on it  
  give-wrapper-after-breaking: false  
  # If wraps should be able to be rewrapped (wrapped again while wrapped)  
  rewrap:  
    # If rewrapping should be enabled for...  
    # ...virtual wrapping  
    virtual-enabled: true  
    # ...physical wrapping  
    physical-enabled: true  
    # If the player should be able to rewrap items that are already wrapped with the same wrap for...  
    # ...virtual wrapping  
    same-virtual-enabled: false  
    # ...physical wrapping  
    same-physical-enabled: false  

```

--------------------------------

### Open Another Menu

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/menus/Actions

Opens another HMCC menu. Add '-o' to ignore permissions.

```yaml
actions:
  any:
    - "[MENU] main_menu"
```

--------------------------------

### Get Block Data at Location

Source: https://docs.hibiscusmc.com/hmcleaves/api

Retrieves the BlockData object for a specific location in the world. Assumes the HMCLeavesAPI instance is available as 'api'.

```java
final Location location = new Location(Bukkit.getWorld("world"), 0, 0, 0);
final BlockData blockData = api.getBlockDataAt(location);
```

--------------------------------

### Global Configuration Options

Source: https://docs.hibiscusmc.com/hmcleaves/configuration

Sets global options for leaves, including world persistence behavior and world whitelisting.

```yaml
# if this is enabled, world-persistence will be ignored if placing leaves
# against any block that will cause the leaf to have a distance less than 7
only-follow-world-persistence-if-connected-to-log: true
# if the world whitelist should be used
use-world-whitelist: true
# the worlds that custom leaves are enabled in
whitelisted-worlds:
  - "world"
```

--------------------------------

### Get Amount of Cosmetics in Slot

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/PlaceholderAPI

Retrieves the number of cosmetics available in a specific slot, or the total number of all cosmetics if no slot is specified.

```APIDOC
## %hmccosmetics_amount_<slot>%

### Description
Returns the amount of cosmetics in a slot. Not specifying a slot will return the total amount of all cosmetics.

### Parameters
#### Path Parameters
- **<slot>** (string) - Optional - The cosmetic slot. Accepted values: `HELMET`, `BACKPACK`, `OFFHAND`, `CHESTPLATE`, `LEGGINGS`, `BOOTS`. If omitted, returns total amount.

### Response
- **integer** - The number of cosmetics in the specified slot or total.
```

--------------------------------

### ItemsAdder Item Configuration

Source: https://docs.hibiscusmc.com/hmcwraps/frequent_issues

Defines custom items like 'fire_sword' using ItemsAdder's YAML format. Ensure 'model_id' is consistent across item types if they share a model.

```yaml
fire_sword:
  display_name: '&fFire Sword'
  resource:
    material: NETHERITE_SWORD
    generate: false
    model_path: fire_sword
    model_id: 5000
fire_sword_iron:
  display_name: '&fFire Sword'
  resource:
    material: IRON_SWORD
    generate: false
    model_path: fire_sword
    model_id: 5000
fire_sword_diamond:
  display_name: '&fFire Sword'
  resource:
    material: DIAMOND_SWORD
    generate: false
    model_path: fire_sword
    model_id: 5000

```

--------------------------------

### Create Menu Navigation Button

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/menus/GUI-Configuration

Add a button to your menu to navigate to another menu. Use the '[MENU] <menu_name>' action to specify the target menu.

```yaml
main_menu:
  slots:
    - 26
  item:
    material: PAPER
    name: "<#d24c9f>Next Page"
    amount: 1
  type: empty # use empty type for buttons
  actions:
    any:
      - "[MENU] main_menu"

```

--------------------------------

### Add Cosmetic to Menu

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/menus/GUI-Configuration

Use this template to add a cosmetic to your menu configuration. Ensure the cosmetic is defined in your cosmetic configurations.

```yaml
beanie:
  slots:
    - 0
  item:
    material: hmccosmetics:beanie
    lore:
      - ""
      - "<gray>Enabled: <#6D9DC5>%HMCCosmetics_equipped_beanie%"
      - "<gray>Allowed: <#6D9DC5>%HMCCosmetics_unlocked_beanie%"
  type: cosmetic
  cosmetic: beanie

```

--------------------------------

### Console Command Action

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/menus/Actions

Sends a command as the console. This is useful for server-side actions.

```yaml
actions:
  any:
    - "[CONSOLE-COMMAND] say Hi"
```

--------------------------------

### Basic Backpack Cosmetic Configuration

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/cosmetics/Backpack

This is the basic configuration for a backpack cosmetic. It defines the slot, permission, and item properties.

```yaml
backpack:
  slot: BACKPACK
  permission: "hmccosmetics.backpack"
  item:
    material: PAPER
    model-data: 4
    name: "<blue>Backpack"
    amount: 1

```

--------------------------------

### Leggings Cosmetic Configuration

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/cosmetics/Equipment

Configure a cosmetic item for the player's leggings slot. Requires the 'hmccosmetics.pants' permission.

```yaml
pants:  
  slot: LEGGINGS  
  permission: "hmccosmetics.pants"  
  item:  
    material: DIAMOND_LEGGINGS  
    name: "<blue>Pants"  
    amount: 1  

```

--------------------------------

### Get Current Cosmetic Data

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/PlaceholderAPI

Retrieves specific data about the current cosmetic a player is using in a given slot. Supports material, custom model data, name, lore, and permission.

```APIDOC
## %hmccosmetics_current_<type>_<data>%

### Description
Returns the current cosmetic the player is using for a specified slot and data type.

### Parameters
#### Path Parameters
- **<type>** (string) - Required - The slot type. Accepted values: `HELMET`, `BACKPACK`, `OFFHAND`, `CHESTPLATE`, `LEGGINGS`, `BOOTS`.
- **<data>** (string) - Required - The type of data to retrieve. Accepted values: `material`, `custommodeldata`, `name`, `lore`, `permission`.

### Response
- **string** - The requested data for the current cosmetic in the specified slot.
```

--------------------------------

### Gradle Repository Configuration (Kotlin)

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/api

Add this repository to your Gradle build script (Kotlin) to access HMCCosmetics releases.

```kotlin
maven {
    url = uri("https://repo.hibiscusmc.com/releases")
}
```

--------------------------------

### Enable Dyeable Cosmetics

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/FAQ

To make a cosmetic dyeable, set the `dyeable` option to `true` in its configuration.

```yaml
    dyeable: true  

```

--------------------------------

### Player Command Action

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/menus/Actions

Sends a command as the player who clicked the menu item.

```yaml
actions:
  any:
    - "[PLAYER-COMMAND] say Hi"
```

--------------------------------

### Cosmetic Menu Item Configuration

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/menus/Types

This snippet shows how to configure a 'cosmetic' type menu item. It links to a specific cosmetic and defines its display properties, including lore that shows equipped and unlocked status.

```yaml
beanie:  
    slots:  
      - 0  
    item:  
      material: hmccosmetics:beanie  
      lore:  
        - ""  
        - "<gray>Enabled: <#6D9DC5>%HMCCosmetics_equipped_beanie%"  
        - "<gray>Allowed: <#6D9DC5>%HMCCosmetics_unlocked_beanie%"  
    type: cosmetic  
    cosmetic: beanie  
```

--------------------------------

### Item Lore Configuration

Source: https://docs.hibiscusmc.com/hmcwraps/config/item

Configure the lore for an item. Each line of lore is a separate entry in the list.

```yaml
lore:  
  - '<green>Some lore'
```

--------------------------------

### GUI Sort Order Configuration

Source: https://docs.hibiscusmc.com/hmcwraps/config/gui

Specifies the order in which wraps are sorted in the GUI. Options include permission-based sorting, custom sort IDs, and model ID sorting.

```yaml
  # The sort order by which the wraps in the inventory will be sorted
  sort-order:
    - 'PERMISSION' # The items the player has access to will be shown first
    - 'SORT_ID' # You can define a sort id on a wrap, lower numbers will be shown first. Example: 'sort: 3'
    - 'MODEL_ID' # Sorted by model id, lower numbers will be shown first

```

--------------------------------

### Boots Cosmetic Configuration

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/cosmetics/Equipment

Configure a cosmetic item for the player's boots slot. Requires the 'hmccosmetics.boots' permission.

```yaml
boots:  
  slot: BOOTS  
  permission: "hmccosmetics.boots"  
  item:  
    material: DIAMOND_BOOTS  
    name: "<blue>Boots"  
    amount: 1  

```

--------------------------------

### Play Sound to Player

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/menus/Actions

Plays a sound to the player who clicked the menu item. Specify sound name, volume, and pitch.

```yaml
actions:
  any:
    - "[SOUND] minecraft:sound.name volume pitch"
```

--------------------------------

### Configure Custom Logs

Source: https://docs.hibiscusmc.com/hmcleaves/configuration

Defines properties for a custom log block, including its world material, stripped log material, and item representation.

```yaml
logs:
    # the id for the logs
  test_log:
    # the material of the log in the world, this is not sent to the client
    # this has to be a log
    log-material: OAK_LOG
    # the material of the stripped log in the world, this is not sent to the client
    # this has to be a stripped log
    stripped-log-material: STRIPPED_OAK_LOG
    # the material of the item in the hand if not using an item hook
    material: PAPER
    # the model data of the item in the hand if not using an item hook
    model-data: 2
    # the name of the item in the hand if not using an item hook
    name: "&5Test Log"
    # the lore of the item in the hand if not using an item hook
    lore:
      - "&aLine 1"
    # the instrument of the log if not using a block from another plugin
    instrument: BANJO
    # the note of the log if not using a block from another plugin
    note: 2
    # the instrument of the stripped log if not using a block from another plugin
    stripped-instrument: BANJO
    # the note of the stripped log if not using a block from another plugin
    stripped-note: 3
```

--------------------------------

### Command on Cosmetic Removal

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/menus/Actions

Executes a console command when a cosmetic is unequipped.

```yaml
actions:
  on-unequip:
    - "[CONSOLE-COMMAND] say A player removed a cosmetic"
```

--------------------------------

### Gradle Repository Configuration (Groovy)

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/api

Add this repository to your Gradle build script (Groovy) to access HMCCosmetics releases.

```groovy
maven {
    url "https://repo.hibiscusmc.com/releases"
}
```

--------------------------------

### Implement Item Priority

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/menus/GUI-Configuration

Use the priority system to determine which item is displayed when multiple items are assigned to the same slot. Higher numbers indicate higher priority.

```yaml
test1:
  slots:
    - 1
  item:
    material: RED_DYE
    name: "<red>Test 1"
  type: EMPTY
  priority: 5 # Since 5 is bigger than 1, this will take priority. 
test2:
  slots:
    - 1
  item:
    material: BLUE_DYE
    name: "<BLUE>Test 2"
  type: EMPTY
  priority: 1

```

--------------------------------

### Configure Custom Saplings

Source: https://docs.hibiscusmc.com/hmcleaves/configuration

Defines properties for a custom sapling, including its material, item representation, and associated schematic files for growth.

```yaml
saplings:
  # the id for the sapling
  test_sapling:
    # the material of the sapling in the world, this is not sent to the client
    # this has to be a sapling
    sapling-material: OAK_SAPLING
    # the material of the item in the hand if not using an item hook
    material: PAPER
    # the model data of the item in the hand if not using an item hook
    model-data: 3
    # the name of the item in the hand if not using an item hook
    name: "&6Test Sapling"
    # the lore of the item in the hand if not using an item hook
    lore:
      - "&aLine 1"
    # the stage of the sapling if not using a block from another plugin
    stage: 1
    # a random schematic file is chosen from the list when the sapling grows
    # these schematics must be in the HMCLeaves/schematics folder
    schematic-files:
      - "test.schem"
      - "test2.schem"
    # if the schematic should be randomly rotated when pasted
    random-paste-rotation: true
    # the model path as described above
    model-path: "blocks/saplings/test_sapling"
```

--------------------------------

### First-Person Backpack Cosmetic Configuration

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/cosmetics/Backpack

Configuration for first-person backpack cosmetics. It includes a 'height' property and a separate 'firstperson-item' for the wearer's view.

```yaml
backpack:
  slot: BACKPACK
  permission: "hmccosmetics.backpack"
  height: 5
  item:
    material: PAPER
    model-data: 4
    name: "<blue>Backpack"
    amount: 1
  firstperson-item: # This is a second backpack you need to configure
    material: PAPER
    model-data: 8
    name: "<white>Backpack"
    amount: 1

```

--------------------------------

### Maven Repository Configuration

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/api

Add this repository to your Maven pom.xml to access HMCCosmetics releases.

```xml
<repository>
            <id>hmc-repo-releases</id>
            <name>HibiscusMC Repository</name>
            <url>https://repo.hibiscusmc.com/releases</url>
        </repository>
```

--------------------------------

### Item Color Configuration

Source: https://docs.hibiscusmc.com/hmcwraps/config/item

Set the color of an item using either HEX or RGB format.

```yaml
color: '#ff0000'
```

```yaml
color: '255,0,0'
```

--------------------------------

### Queue Multiple Item Rewards

Source: https://docs.hibiscusmc.com/hmcrewards/Commands

Queues multiple units of a vanilla item reward for a player. The quantity must be specified for item rewards.

```minecraft-commands
/hmcrewards queue Notch item PAPER 3
```

--------------------------------

### Queue Multiple Item Rewards with Force Flag

Source: https://docs.hibiscusmc.com/hmcrewards/Commands

Queues multiple units of a vanilla item reward for a player, attempting to deliver them directly to the inventory first. The -f flag forces this behavior.

```minecraft-commands
/hmcrewards queue Notch item PAPER 3 -f
```

--------------------------------

### Armor Imitation Material Configuration

Source: https://docs.hibiscusmc.com/hmcwraps/config/wraps

Sets the base material for armor imitation. Use this to apply wraps to armor types not natively supported by Minecraft. Ensure resource pack changes are applied to the specified base material.

```yaml
armor-imitation: 'LEATHER'
```

```yaml
armor-imitation: 'CHAINMAIL'
```

--------------------------------

### Chestplate Cosmetic Configuration

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/cosmetics/Equipment

Configure a cosmetic item for the player's chestplate slot. Requires the 'hmccosmetics.chestplate' permission.

```yaml
chestplate:  
  slot: CHESTPLATE  
  permission: "hmccosmetics.chestplate"  
  item:  
    material: DIAMOND_CHESTPLATE  
    name: "<blue>Chestplate"  
    amount: 1  

```

--------------------------------

### Define Multiple Slots for an Item

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/menus/GUI-Configuration

Configure an item to occupy a range of slots or specific individual slots within a menu. This allows for flexible item placement.

```yaml
niftyString:
  slots:
    - 7-10 # This will only fill slot 7->10. 
    - 12 # This will only fill slot 12. 
  item:
    material: STRING
    amount: 1
    lore:
      - "<WHITE>"
      - "<gray>Colorful balloon!"

```

--------------------------------

### Wardrobe Location Serialization

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/serializers/location

Illustrates the serialization format for wardrobe locations, specifying NPC, viewer, and leave locations within a world. Each location includes world, coordinates, yaw, and pitch.

```yaml
wardrobes:
  default:
    npc-location:
      world: "world"
      x: 0
      y: 0
      z: 0
      yaw: 0
      pitch: 0
    viewer-location:
      world: "world"
      x: 5
      y: 0
      z: 5
      yaw: 0
      pitch: 0
    leave-location:
      world: "world"
      x: 5
      y: 5
      z: 5
      yaw: 0
      pitch: 0

```

--------------------------------

### Toggle Cosmetic Visibility

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/menus/Actions

Changes the visibility of cosmetics, switching between hidden and shown states.

```yaml
actions:
  any:
    - "[TOGGLE]"
```

--------------------------------

### Filter Configuration Settings

Source: https://docs.hibiscusmc.com/hmcwraps/config/filter

Configure the filter feature globally. You can enable or disable the feature and set its default state (e.g., whether to show only owned wraps by default).

```yaml
# The inventory filter configuration
# This feature shouldn't do anything if you don't use the action, but if you have and don't want it anymore, disable this
# If you want the inventory to only show wraps the player owns, enable this feature and set default to 'true' and don't change it using actions
filter:
  # If the feature should be enabled
  enabled: true
  # If the inventory should be filtered by default
  default: false

```

--------------------------------

### Plugin.yml Dependency

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/api

List HMCCosmetics in the 'depend' section of your plugin.yml to declare it as a dependency.

```yaml
depend: [HMCCosmetics]
```

--------------------------------

### Offhand Cosmetic Configuration

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/cosmetics/Equipment

Configure a cosmetic item for the player's offhand slot. This cosmetic will be temporarily unapplied when the player switches items and reapplied when they switch back.

```yaml
lantern_cosmetic:  
  slot: OFFHAND  
  permission: "hmccosmetics.lantern_cosmetic"  
  item:  
    material: PAPER  
    model-data: 5  
    name: "<blue>Lantern Cosmetic"  
    amount: 1  

```

--------------------------------

### Physical Wrap Item Configuration

Source: https://docs.hibiscusmc.com/hmcwraps/config/wraps

Defines a physical item used to apply a wrap. Includes options for the item's ID, model ID, display name, lore, and whether it's kept after unwrapping.

```yaml
physical:
  # The Bukkit material or a hook
  id: 'PAPER'
  # Custom model id, automatically applies if you have set a hook in the id value
  model-id: 2
  # Name displayed
  name: '<red>Fire Sword <gray>Wrap'
  # If the physical should be given back to the player after they unwrap 
  # an item wrapped with the physical wrapper or not
  keep-after-unwrap: true
  # Lore displayed
  lore:
    - '<green>Apply this to an item to wrap it!'
```

--------------------------------

### Queue Item Reward with Force Flag

Source: https://docs.hibiscusmc.com/hmcrewards/Commands

Queues a vanilla item reward for a player, attempting to deliver it directly to the inventory before queuing. The -f flag forces this behavior.

```minecraft-commands
/hmcrewards queue Notch item PAPER -f
```

--------------------------------

### Item NBT Configuration

Source: https://docs.hibiscusmc.com/hmcwraps/config/item

Apply custom NBT data to an item, strictly following Minecraft's container-based approach.

```yaml
nbt: '{publicBukkitValues:{somePlugin:{someValue:"sus"}}}'
```

--------------------------------

### Generic Location Serialization

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/serializers/location

Defines the basic structure for a location, including world, coordinates (x, y, z), yaw, and pitch. The world must exist for the location to be created.

```yaml
world: "world" # This defines the world. If the world does not exist then it can't create the location
x: 0
y: 0
z: 0
yaw: 0
pitch: 0

```

--------------------------------

### Configure Equipped Cosmetic Item Display

Source: https://docs.hibiscusmc.com/hmccosmetics%20remapped/menus/GUI-Configuration

Set a specific item to display when a player has a particular cosmetic equipped. This item overrides the default item when the cosmetic is active.

```yaml
cosmeticsystem:
  slots:
    - 21
  item:
    material: "paper"
    name: "<#d24c9f>Earth Day Grabber (Limited Time!)"
    amount: 1
  equipped-item:
    material: "YELLOW_WOOL" # If this does not exist, it will take the material in the original material found under item
    name: "This cosmetic has been equipped!"

```
Tokens:
Raw