commands.yml
Все настройки commands.yml.
commands.yml содержит собственные команды Identica — их псевдонимы, права, описания и синтаксис — и несколько настроек, общих для всех команд. Функции и провайдеры хранят свои команды в собственных commands.yml с той же структурой, например providers/Credential/commands.yml или features/verification/commands.yml. Команды для персонала перечислены в руководстве Управление аккаунтами.
behavior
Настройки, общие для всех команд.
help
Принимаетtrue или false
По умолчаниюtrue
Влияет нато, перечисляет ли /identica help команды по алфавиту
При false справка выводит их в порядке регистрации.
suggestions
Принимаетцелое число
По умолчанию25
Влияет нато, сколько ников игроков команда подсказывает, пока персонал её набирает
При 0 или меньше ники не подсказываются.
clear
Принимаетдлительность
По умолчанию"60s"
Влияет нато, сколько времени действителен ожидающий подтверждения запрос администратора на очистку или удаление
Это промежуток времени между запросом на очистку или удаление аккаунта (/identica admin clear или /identica admin delete) и его подтверждением. Более позднее подтверждение отклоняется, и ничего не меняется.
sessions
Принимаетцелое число
По умолчанию7
Влияет нато, сколько сессий /identica admin session list показывает на одной странице
migration
Принимаетдлительность
По умолчанию"60s"
Влияет нато, сколько времени у игрока есть на подтверждение перехода к другому провайдеру, например командой /premium confirm
Осторожно
Принимаетtrue или false
По умолчаниюfalse
Влияет нато, как Velocity разбирает команды, которые вводят игроки
При false Velocity передаёт Identica введённое игроком как есть. Пароли могут содержать любые символы, а на неверный ввод Identica отвечает собственными сообщениями.
При true Velocity разбирает команды через Brigadier, который допускает в аргументах меньше символов и отклоняет часть ввода ещё до Identica, без её сообщений. Пароли с такими символами тогда ввести нельзя.
Оставьте false, если у вас нет причины использовать Brigadier.
commands
Все команды; ключом служит идентификатор команды, например admin-reload.
Ключи команд
Меняйте значения внутри команды, но сохраняйте её ключ: Identica находит каждую свою команду по ключу, и команда с переименованным ключом остаётся без своих настроек.
У всех команд одинаковые поля.
Поля команды
Принимаетсписок строк-псевдонимов
Влияет наназвания, на которые откликается команда
Псевдоним — это слово, например help, или фраза, например admin session list; подкоманды /identica используют фразы. Включённая команда без единого псевдонима не регистрируется, и при запуске в консоли появляется предупреждение.
Принимаетстроку
Влияет направо, которое нужно игроку для использования команды
Пустая строка разрешает команду всем.
Для опытных
Принимаетстроку
Влияет насинтаксис, который показывается в справке и в сообщениях об ошибках, и на то, какие аргументы принимает команда
usage — это одновременно то, что читают игроки, и то, что принимает команда: по нему Identica определяет, какие аргументы обязательные, а какие — необязательные.
Синтаксис:
<name>— обязательный аргумент[name]— необязательный аргумент<name...>или[name...]— аргумент, который забирает остаток строки- плейсхолдеры
{...}только отображаются и никогда не разбираются
Во встроенных строках usage часто встречаются такие плейсхолдеры:
{alias}— псевдоним, который используется сейчас{command}— путь корневой команды
Правила:
- Сохраняйте имена аргументов из
usageпо умолчанию. Имя, которого у команды нет, не даёт команде зарегистрироваться, и консоль сообщает об этом. - Псевдонимы берутся только из
aliases, никогда изusage. - Необязательный аргумент можно убрать из
usage; тогда команда перестаёт его принимать, а справка и сообщение о неверном синтаксисе перестают его показывать. - Настройки никогда не меняют
usage: если настройка делает необязательный аргумент ненужным, напримерchangePassword.requireRepeatпровайдера Credential, аргумент остаётся в синтаксисе, пока вы его не уберёте.
Примеры:
-
"{command} {alias} <target> [provider]"означает:- показываются корневая команда и псевдоним, который использовал игрок
target— обязательный аргументprovider— необязательный аргумент
-
"{alias}"означает:- команда не принимает аргументов
- показывается только псевдоним
Зарезервировано
Принимаетenabled, duration и group
Влияет напока ни на что
Identica читает эти поля, но пока не применяет кулдауны команд. Оставьте их как есть.
Принимаетсловарь «имя аргумента — описание»
Влияет нато, как каждый аргумент описан в справке
Он только описывает аргументы; какие аргументы существуют, определяет usage.
Принимаетtrue или false
По умолчаниюfalse
Влияет нато, скрывает ли /identica help эту команду
Скрытая команда продолжает работать.
Встроенные группы команд
commands.yml по умолчанию содержит такие команды:
- Основные:
main,help,enroll,availability-username - Администрирование:
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-list,migration-start,migration-cancel,migration-primary,migration-drop - Верификация:
verification,verification-status,verification-enroll,verification-confirm,verification-enroll-confirm,verification-use,verification-disable,verification-enroll-cancel