Commands

Everything runs through the root command /pets, aliased /pet. 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 /pets 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 /pets admin <action>. The <instance> argument is the pet instance id shown by /pets admin list, not the pet type id.

Inspection

Editing one pet

Pass none as the <trait> or <grade> to clear it instead of setting it. The three boost stats are experience, level and buff.

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

Bulk actions

The <what> argument of clear is storage (every pet that is not equipped), equipped (sends every equipped pet 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 for slots and storage, and give, take or set for a currency. Capacity cannot be taken: lowering a purchase is a set. The three currencies are trait-ticket, dice-normal and dice-special.

The [level] of give is the level the granted pets start at. Since 1.24.0 both its floor and its default are 0, the level a pet is created at, so an admin who names no level hands out a pet identical to one just found in a box rather than one that is already a level ahead of it. It has no ceiling: a level past the pet's own cap is clamped when it is applied.

The three scrolls are level, ownership and rarity. [levels] is what ONE level scroll is worth: it is stamped onto the stack when it is handed out, so scrolls of different sizes circulate side by side and lowering scrolls.level.default-levels later never devalues one already given. Omit it and the configured default is used; the other two scrolls ignore it. Its floor is 1 and stays there: [levels] is a COUNT of levels a scroll is worth, not a position on the ladder, and a scroll worth 0 levels would be an item that silently does nothing when it is used. The two arguments shared one definition until 1.24.0, which split them the moment a level was allowed to be 0. A scroll whose enabled is false is refused even when the token is spelled correctly. See Configuration.

Silent flags

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

/pets admin give Bob ember_fox 3 5 -s -sf
/pets admin currency dice-normal give Bob 10 -s
/pets admin clear Bob all -sf

-s silences the message the RECEIVER gets. Five commands send one: give (messages.pet-received), givebox and giveallbox (messages.box-received), givescroll (messages.scroll-received / messages.scroll-received-level) and currency (messages.currency-received). The other seventeen 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

Since 1.9.0 both flags are declared as the last two optional parameters of every /pets 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.

Before 1.9.0 they were accepted but not declared, and completion stops at a command's last declared argument - so on the sixteen commands whose arguments are all required they were suggested nowhere and had to be typed from memory.

Inside the position of a real optional argument (the [page] of list, the [amount] of give) the flags still 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 still accepted in silence, exactly as before.

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