Identica

commands.yml

Every setting of commands.yml.

commands.yml holds Identica's own commands: their aliases, permissions, descriptions and syntax, and a few settings that apply to all of them. Features and providers keep their commands in their own commands.yml with the same structure, such as providers/Credential/commands.yml or features/verification/commands.yml. Managing accounts lists the staff commands.

behavior

Settings that apply to all commands.

help

sortAlphabetically

Takestrue or false

Defaulttrue

Affectswhether /identica help lists commands alphabetically

With false, help lists them in the order they were registered.

suggestions

playerLimit

Takesan integer

Default25

Affectshow many player names a command suggests while staff type it

0 or lower suggests no names.

clear

confirmTtl

Takesa duration

Default"60s"

Affectshow long a pending admin clear or delete confirmation stays valid

This is the time window between requesting an account clear or deletion (/identica admin clear or /identica admin delete) and confirming it. A later confirmation is refused and nothing is changed.

sessions

listPageSize

Takesan integer

Default7

Affectshow many sessions /identica admin session list shows per page

migration

confirmTtl

Takesa duration

Default"60s"

Affectshow long a player has to confirm a move to another provider, such as with /premium confirm

useBrigadier

Warning

Takestrue or false

Defaultfalse

Affectshow Velocity parses the commands players type

With false, Velocity passes what the player typed to Identica as it is. Passwords may contain any symbol, and Identica answers wrong input with its own messages.

With true, Velocity parses commands with Brigadier, which accepts fewer symbols in arguments and rejects some input before Identica sees it, without Identica's messages. Passwords with such symbols then cannot be typed.

Keep false unless you have a reason to use Brigadier.

commands

Every command, keyed by its id, such as admin-reload.

Command keys

Change the values inside a command, but keep its key: Identica finds each of its commands by its key, and a renamed key leaves the command without its settings.

Every command has the same fields.

Command fields

enabled

Takestrue or false

Affectswhether the command exists

aliases

Takesa list of alias strings

Affectsthe names the command answers to

An alias is a word such as help or a phrase such as admin session list; subcommands of /identica use phrases. An enabled command without any alias is not registered, and the console warns about it on startup.

permission

Takesa string

Affectsthe permission a player needs to use the command

An empty string lets everyone use it.

description

Takesa string

Affectsthe command's description in /identica help

usage

Advanced

Takesa string

Affectsthe syntax shown in help and in error messages, and which arguments the command takes

usage is both what players read and what the command accepts: Identica takes from it which arguments are required and which are optional.

The syntax:

  • <name> means a required argument
  • [name] means an optional argument
  • <name...> or [name...] means an argument that takes the rest of the line
  • {...} placeholders are only shown, never parsed

Built-in usages commonly use placeholders such as:

  • {alias} for the currently used alias
  • {command} for the root command path

Rules:

  • Keep the argument names of the default usage. A name the command does not have stops the command from registering, and the console says so.
  • Aliases come only from aliases, never from usage.
  • An optional argument can be left out of usage; the command then no longer accepts it, and help and the invalid-syntax message no longer show it.
  • Settings never change usage: when a setting makes an optional argument unnecessary, such as Credential's changePassword.requireRepeat, the argument stays in the syntax until you remove it.

Examples:

  • "{command} {alias} <target> [provider]" means:

    • shows the root command and the alias the player used
    • target is required
    • provider is optional
  • "{alias}" means:

    • the command takes no arguments
    • only the alias is shown

cooldown

Reserved

Takesenabled, duration and group

Affectsnothing yet

Identica reads these fields but does not apply command cooldowns yet. Leave them as they are.

enabled

Takestrue or false

Defaultfalse

duration

Takesan integer

Default0

group

Takesa string

Default"default"

arguments

Takesa map of argument name to description

Affectshow each argument is described in help

It only describes arguments; which arguments exist comes from usage.

hide

Takestrue or false

Defaultfalse

Affectswhether /identica help leaves the command out

A hidden command still works.

Built-in command groups

The default commands.yml holds these commands:

  • Core: main, help, enroll, availability-username
  • Admin: admin, admin-reload, admin-clear, admin-clear-confirm, admin-clear-cancel, admin-delete, admin-delete-confirm, admin-delete-cancel, admin-reservation-set, admin-reservation-info, admin-reservation-delete, admin-session, admin-session-list, admin-session-info, admin-session-end, admin-username-duplicates, admin-verification-reset
  • Migration: migration-list, migration-start, migration-cancel, migration-primary, migration-drop
  • Verification: verification, verification-status, verification-enroll, verification-confirm, verification-enroll-confirm, verification-use, verification-disable, verification-enroll-cancel

On this page