Skip to main content

🎭 How to install HMCCosmetics

How to install HMCCosmetics on the Minecraft server

Requirements​

β€’ HMCCosmetics

β€’ ItemsAdder or Oraxen or Nexo (not required if you only use the default/vanilla resource pack)

warning

Make sure all your plugins and server software are up to date!

tip

You can use the HMCCosmetic Generator tool on this site to automatically turn an existing ItemsAdder/Oraxen/Nexo items file into ready-to-use cosmetics.yml and menu.yml files. It currently supports Oraxen and Nexo (with or without their default resource pack) β€” for ItemsAdder, follow the manual steps below.

  1. Add HMCCosmetics.jar to your server's plugins folder and start the server once so it generates its default folders.
  2. Stop the server and put your cosmetic item YAML files inside HMCCosmetics/cosmetics/ and your menu YAML files inside HMCCosmetics/menus/.
  3. Run the command /cosmetic reload (permission hmccosmetics.cmd.reload) after making any config changes.

Nexo & HMCCosmetics Setup​

  1. Make sure your Nexo item already exists in Nexo/items/.
  2. Reference it from HMCCosmetics/cosmetics/<file>.yml using the nexo:<itemid> material format.
    HMCCosmetics/cosmetics/hats.yml
    party_hat_cosmetics:
      permission: cosmetics.party_hat
      dyeable: false
      slot: HELMET
      item:
        material: nexo:party_hat
        unbreakable: true
        glow: false
        amount: 1
  3. Add a matching entry to HMCCosmetics/menus/<file>.yml so players can select it from the GUI.
    HMCCosmetics/menus/hats.yml
    party_hat_cosmetics:
      slots: [0]
      item:
        name: "<white>Party Hat"
        material: nexo:party_hat
        amount: 1
        lore:
          - ""
          - "<gray>Enabled: <#6D9DC5>%HMCCosmetics_equipped_party_hat_cosmetics%"
          - "<gray>Allowed: <#6D9DC5>%HMCCosmetics_unlocked_party_hat_cosmetics%"
      type: cosmetic
      cosmetic: party_hat_cosmetics
      locked-item:
        name: "<white>Party Hat <red><b>(LOCK)"
        material: nexo:party_hat
        amount: 1
        lore:
          - "<RED>You do not have this cosmetic available"
  4. Run the command /n reload all, then /cosmetic reload.

Oraxen & HMCCosmetics Setup​

  1. Make sure your Oraxen item already exists in Oraxen/items/.
  2. Reference it from HMCCosmetics/cosmetics/<file>.yml using the oraxen:<my_oraxen_item> material format β€” the rest of the file follows the same structure as the Nexo example above.
    HMCCosmetics/cosmetics/hats.yml
    party_hat_cosmetics:
      permission: cosmetics.party_hat
      dyeable: false
      slot: HELMET
      item:
        material: oraxen:party_hat
        unbreakable: true
        glow: false
        amount: 1
  3. Run the command /o reload all, then /cosmetic reload.

ItemsAdder & HMCCosmetics Setup​

  1. Drag the "data" folder from the HMCCosmetics ItemsAdder addon package into your ItemsAdder plugin folder.
  2. Reference your ItemsAdder item using the itemsadder:<my_ia_namespace>:<my_ia_item> material format.
    HMCCosmetics/cosmetics/hats.yml
    party_hat_cosmetics:
      permission: cosmetics.party_hat
      dyeable: false
      slot: HELMET
      item:
        material: itemsadder:cosmetics:party_hat
        unbreakable: true
        glow: false
        amount: 1
  3. In HMCCosmetics/messages.yml, change the prefix to %img_colorful% so ItemsAdder fonts render correctly in menus.
  4. Run the command /iazip, then /cosmetic reload.

Default Resource Pack & HMCCosmetics Setup​

If you don't use ItemsAdder, Oraxen, or Nexo, HMCCosmetics can still work off the vanilla resource pack using a normal item material plus a custom model data value.

HMCCosmetics/cosmetics/hats.yml
party_hat_cosmetics:
  permission: cosmetics.party_hat
  dyeable: false
  slot: HELMET
  item:
    material: LEATHER_HORSE_ARMOR
    model-data: 1001
    unbreakable: true
    glow: false
    amount: 1
  1. Put your custom textures/models into your resource pack's assets/minecraft folder using the same custom model data value.
  2. Run the command /cosmetic reload.
  3. Have players apply or reload the resource pack in Minecraft.

Frequently encountered problems​