I. Companion Management

Use /cpp open to open the warehouse, then click a companion to enter the management screen, where you can select, upgrade, rename, show/hide the name, change equipment, refine quality or release.

3.0.0 supports holding multiple companions of the same type; each instance's level, quality, random attributes, name and equipment are saved independently, and only one companion can be selected at a time. Management operations only affect the clicked instance.

• Warehouse screen: gui/open.yml.
• Companion management screen: gui/upgrade.yml; each button can be toggled via enable.
• Quality refinement: re-rolls the quality and random attributes, see Companion Attributes (opens new window) for details.
• Changing equipment: the equipment must first be given by an administrator, see Companion Equipment (opens new window) for details.

II. Warehouse Capacity

The main config config.yml does not limit the amount by default; enable it when needed:

companionLimitEnable: true
companionLimit:
  default: 10
  vip: 20

default is the default capacity. After giving a player the CompanionsPlus.companionLimit.vip permission, the corresponding vip capacity is used; more permission tiers can be added the same way, and 0 means unlimited.

Capacity is counted by companion instance, and companions of the same type each take up a slot. Once the limit is reached, you must release companions or increase the capacity before obtaining more. The current version checks capacity for online players; when giving companions to offline players, their permission capacity is not checked.

When the limit is enabled and the player's effective limit is greater than 0, the warehouse title can append count information, configured in gui/open.yml:

titleLimit: " &7(&a${count}&7/&a${limit}&7)"

${count} is the current instance count and ${limit} is the current limit.

III. Releasing Companions

release.enable in gui/upgrade.yml controls the release button and is enabled by default. Clicking it opens the double confirmation screen in gui/confirm.yml.

Confirming the release permanently deletes the selected companion instance; if it is in use, it is also recalled. Its bound equipment is unbound and kept in the player's companion equipment warehouse.

IV. Name and Summon Commands

The main config config.yml can set a unified name format for owned companions:

companionNameFormat: "${quality} ${name} &fLv.${level}"
settings:
  maxNameLength: 10
  blacklistedNames:
    - "forbidden_name"
  show:
    perms: companionsPlus.show
    commands: /s
  vanish:
    perms: companionsPlus.vanish
    commands: /v

${name} is the companion name, ${quality} is the quality text and ${level} is the instance level. Renaming uses Dialog input on supported higher versions and chat input otherwise; enter T or cancel to cancel, and companions.admin.blacklist bypasses the naming blacklist.

commands supports multiple commands separated by English commas, and changes take effect after reloading the config. /s re-displays the selected companion; /v recalls the companion and deselects it, after which it must be selected again in the warehouse before it can be summoned again. Permission nodes are determined by the corresponding perms config.