Commands and Permissions
This plugin requires no permission configuration by default, ready to use out of the box (hot-reloading plugins may cause default permissions to be invalid)
For types mentioned below that you don't know, use tab completion in lower versions, versions 1.12+ will automatically remind
Permissions
| Permission | Purpose | Default Owner |
|---|---|---|
| companionsPlus.clearData | Clear data | op |
| companionsPlus.coin | Give/Set/Take player companion coins | op |
| companionsPlus.convert | Convert data between MySQL and SQLite | op |
| companionsPlus.give | Give a companion to a player | op |
| companionsPlus.giveItem | Give a specified mystery box to a player | op |
| companionsPlus.giveCapture | Give a specified capture item to a player | op |
| companionsPlus.giveEquipment | Give companion equipment to a player | op |
| companionsPlus.reload | Reload configuration files | op |
| companionsPlus.open | Open warehouse GUI | true |
| companionsPlus.shop | Open shop GUI | true |
| companions.upgrade.ability | Upgrade companion button | true |
| companions.upgrade.changeWeapon | Change companion equipment button | true |
| companions.upgrade.rename | Change companion name button | true |
| companions.upgrade.hideName | Show/hide companion name button | true |
| companions.upgrade.refineQuality | Refine companion quality button | true |
| companions.admin.blacklist | Bypass the companion naming blacklist | op |
| companions.buy.all | Shop shows all companions | op |
companions.buy.<companion key> | Shop shows the specified companion | op |
companions.have.<companion key> | Auto-grant the specified companion, requires isHavePermission enabled | op |
CompanionsPlus.companionLimit.<node> | Use the corresponding warehouse capacity from the main config, requires capacity limit enabled | As configured |
| companionsPlus.show | Use the configured summon command, node is customizable | As configured |
| companionsPlus.vanish | Use the configured recall command, node is customizable | As configured |
Commands
The main command is /companionsPlus, abbreviated as /cpp. Companion keys, equipment keys and item keys are node names in the configuration.
| Command | Purpose |
|---|---|
| /cpp clearData [player/all] | Clear data for the specified player or all players |
| /cpp coin [give/set/take] [player] [amount] | Give/Set/Take player companion coins |
| /cpp convert [mysql/sqlite] | Convert the database storage type; not for importing legacy YAML data |
| /cpp give [player] [companion key] (true/false) | Give a companion instance; the last argument is whether to enable it immediately, defaults to false |
| /cpp giveItem [player] [mystery box key] [amount] | Give a mystery box configured in box.yml |
| /cpp giveCapture [player] [capture item key] [amount] | Give a capture item configured in capture.yml |
| /cpp giveEquipment [equipment key] [player] | Give companion equipment; each player can own only one item per equipment key |
| /cpp reload | Reload configuration files |
| /cpp open | Open warehouse GUI; click a companion to enter the management screen |
| /cpp shop | Open shop GUI |
| /s | Default summon command, re-displays the selected companion |
| /v | Default recall command, recalls the companion and deselects it |
/s and /v are configured in the main config's settings.show and settings.vanish, and multiple commands can be set with English commas. After using /v, you need to select the companion again in the warehouse before summoning it again.
[] Required () Optional