Skip to content

Custom Item Configuration ​

CompanionsPlus supports custom items from:

  • CraftEngine
  • ItemsAdder
  • ModelEngine

Formats ​

PluginFormatExample
CraftEngine[CE]namespace:item_id[CE]myitems:ruby_sword
ItemsAdder[IA]namespace:item_id[IA]myitems:ruby_sword

Both plugins use the same configuration pattern; only the prefix changes.

Companion Appearance ​

Set customModelData in companions/companions.yml:

yaml
# CraftEngine
customModelData: "[CE]myitems:ruby_pet"

Or:

yaml
# ItemsAdder
customModelData: "[IA]myitems:ruby_pet"

ModelEngine usage:

Click to download free models

yaml
# ModelEngine model name
modelEngine: "example_model"

Replace example_model with the actual model name; NONE means ModelEngine is not used. Requires ModelEngine R4 and a 1.19.4+ server.

3.0.0 also supports using a vanilla virtual mob appearance directly (servers 1.20.5–1.21.11, 26.1):

yaml
# Placed under the companion node, choose one of playerSkull, modelEngine
mob: "parrot"
mobScale: 0.5

mobScale defaults to 0.5, and the Ender Dragon is not supported. Virtual mob and ModelEngine appearances do not display armor stand weapons, chestplates or poses. Captured companions use the captured mob type's appearance; see Mob Capture for scaling rules.

Companion Equipment ​

Set material in equipment/equipment.yml:

yaml
equipment:
  rubySword:
    name: "&cRuby Sword"
    material: "[IA]myitems:ruby_sword"
    custom-model-data: 0
    tooltipStyle: ""
    itemModel: ""
    lore: [ ]
    attribute: [ ]

For CraftEngine, change material to:

yaml
material: "[CE]myitems:ruby_sword"

Notes ​

  • [CE] and [IA] must remain uppercase.
  • Replace the sample item IDs with IDs that exist in the corresponding plugin.
  • The selected custom-item plugin must be installed on the server.