Commands

Everything runs through the root command /companions, aliased /companion. The alias list lives in command.aliases in config.yml and is authoritative at runtime, so you can rename or extend it without touching the jar. Bare /companions opens the storage menu for a player and prints the help for the console.

Arguments in <angle brackets> are required. Arguments in [square brackets] are optional.

Player commands

Admin commands

Every admin action sits under /companions admin <action>. The <instance> argument is the companion instance id shown by /companions admin list, not the companion type id.

Inspection

Editing one companion

Since 1.10.0 setlevel accepts 0, which is the level a companion is created at, so a companion can be put back to fresh. See A companion is created at level 0.

Bulk actions

The <what> argument of clear is storage (every companion that is not equipped), equipped (sends every equipped companion back to storage), group (one whole group, named by the optional [group] argument) or all (the entire collection).

Granting

The <mode> argument is give or set. Capacity cannot be taken: lowering a purchase is a set.

The [level] of give is the level the granted companions start at. Since 1.10.0 both its floor and its default are 0 - level 0 is the level a companion is created at - so an admin who names no level hands out a companion identical to one just hatched from an egg rather than one that is already a level ahead of it. It has no ceiling: a level past the companion's own cap is clamped when it is applied.

Silent flags

Every /companions admin command accepts two optional flags, in any order and combinable:

/companions admin give Bob ember_fox 3 5 -s -sf
/companions admin openegg Bob basic_egg 10 -s
/companions admin clear Bob all -sf

-s silences the message the RECEIVER gets. One command sends one: give (messages.companion-received). openegg only looks like a second: what the player reads is the egg's own reward line, announced by the egg engine exactly as it would be for a bought egg, so -s does not touch it - and neither does it touch the other lines an open can produce, such as a storage that filled or companions that could not be saved, which come from the same engine. The other sixteen have never messaged their target, so -s is accepted there and simply has nothing to silence. An offline receiver is never messaged either way.

Tab completion

Both flags are declared as the last two optional parameters of every /companions admin command, so they complete on tab and show up in the usage line as [-s] [-sf]. Type a command's own arguments, press tab, and you get -s and -sf; press tab again after typing one and you still get the other. Declaring the two slots is what reaches past a command's last real argument: completion stops there, so on the thirteen commands whose arguments are all required an undeclared flag would be suggested nowhere and have to be typed from memory.

Inside the position of a real optional argument (the [page] of list, the [amount] of give) the flags appear only once you type a leading -, so they never crowd the list of values you were actually reaching for. A trailing token that is neither an argument nor a flag is accepted in silence.

The suggestions themselves are SnLib's. With more than 100 companion files, run SnLib 1.34.1 or later: older versions cut the option list at 100 before matching what you typed, so the companion ids past the hundredth were unreachable from tab even by their own first letters. Typing an id in full always worked.

The flags do not apply to /companions reload, /companions help or /companions debug, which SnLib owns at root level, nor to /companions toggle and /companions hide, which act on you alone and have no second party to silence.