Page cover

⚙️Документация команд

Здесь описаны все команды которые доступны в нашем боте

Содержание

Синтаксис команд:

/command [param_1] <param_2> <param_3>

  • Некоторые команды имеют параметры, которые могут быть обязательными или необязательными /command [param]

  • Если аргумент указан в квадратных скобках [] то он является обязательным

  • Если аргумент указан в треугольных скобках <> то он является необязательным

Пример:

/parse_replay [replay] [region] <output_type>

  • Параметр replay является обязательным.

  • Аргумент output_type является необязательным, так что его можно не указывать.

Обязательные параметры отображаются сразу, необязательные нужно добавить отдельно или проигнорировать (см. скриншот ниже) .

Пример отображения обязательных и необязательных аргументов

Мультиаккаунт и профиль:

Концепция мультиаккаунта:

Мультиаккаунт означает возможность к 1 аккаунту в боте привязать несколько игровых аккаунтов что может существенно облегчить использование бота для нескольких аккаунтов. Все аккаунты полностью изолированны друг от друга и могут работать независимо. Так же разрешается привязка одинаковых аккаунтов что позволяет вести разные сессии на одном и том-же аккаунте. Все команды взаимодействующие с параметрами какого-либо аккаунта всегда имеют необязательный аргумет account что позволяет выбирать аккаунт для взаимодействия. Если аккаунт не выбран явно то выбирается аккаунт по умолчанию. Аккаунт по умолчанию можно узнать в профиле используя команту /profile Для этого нудно посмотреть на какой аккаунт указываетс стрелочка в картинке профиля (-->). Аккаунт по умолчанию можно сменить используя /switch_account Так же часто при использовании команд в сообщении будет указано к какому аккаунту была применена команда.

1: /profile

Что делает:

  • Отправляет вам картику с вашим профилем в боте.

Отображение:

Пример изображения профиля

Профиль разделён на 5 зон:

Зона 1:

  • Значки профиля. Значки даются за различные достижения, в основном за роли на сервере поддержки.

Зона 2:

  • Информация о последних 10 использованных командах в боте. Слева идёт нумерация команд а справа время использования. По центру название команды.

Зона 3:

  • Информация о всех привязанных аккаунтах.

  • Стрелочка --> указывает на текущий выбранный аккаунт по умолчанию. Это означает что используя любые команды где есть параметр account при отсутсвии явного указания номера аккаунта команда будет применена к этому аккаунту.

  • Цвет никнейма аккаунта в этом списке указывает на то что на данном аккаунте запущена сессия. Если бы ник был серым это означало бы то, что аккаунт привязан но сессия на нём неактивна. Сам цвет говорит о % побед на аккаунте с запущенной сессией. В данном примере это зелёный что говорит о том что на аккаунте запущена сессия и % побед на нём лежит в диапазоне от 50 до 59.9 %

  • Серые поля с надписью [---/set_player---] указывают на то что данный слот пуст но вы можете привязать туда аккаунт командой /set_player указав номер этого слова в параметре slot

  • Серые поля с написью [---/premium---] Указываю на то что слот пуст но для его использования нужен премиум доступ. Для получения информации о премиуме используйте команду /premium

Зона 4:

  • Информация о других данных профиля.

  • Строка 1: Статус премиума

  • Строка 2: Время через которое премиум статус истечёт. Если ваш премиум начисляется за счёт того что вам доступна определённая роль на сервере поддержки то данное значение будет всегда в диапазоне от 1 до 24 часов пока у вас есть необходимая роль.

  • Строка 3: Общий опыт в системе уровней бота. Опыт начисляется за использования команд бота и его количество зависит от используемой команды и везения.

  • Строка 4: Счётчик всех использованных команд

Зона 5:

  • Система уровней бота. Слева указан текущий опыт а справа опыт необходимый для перехода на следующий уровень. По центру отображён сам уровень. Максимальный уровень 50. При достижении 50 уровня опыт перестаёт начислчяться.

2: /switch_account

Что делает:

  • Возвращает сообщение с выпадающим списком которое позволяет выбрать аккаунт для переключения. При выборе аккаунта из списка происходит переключения аккаунта по умолчанию.

Отображение:

Настройки:

1: /set_lang [lang]

Параметры:

  • lang Список доступных языков (строка)

Что делает:

  • Устанавливает язык локализации бота для вас.

Примечание

  • Язык default включает автоматический выбор языка. Автоматический выбор опирается на язык установленный в интерфейсе приложения Discord.

  • Может не работать со старыми версиями Discord.


2: /set_player [nick_or_id] [region] <slot>

Параметры:

  • nick_or_id Никнейм игрока для сохранения (строка или число)

  • region Регион для поиска (строка)

  • slot Номер слота для сохранения аккаунта (1-5)

Что делает:

  • Записывает игрока в базу данных для последующего использования, например для команды /astats

Статистика аккаунта:

1: /stats [nickname] [region]

Параметры:

  • nickname Никнейм игрока для поиска (строка)

  • region Регион для поиска (строка)

Что делает:

  • Проводит поиск игрока с заданным никнеймом в заданном регионе. Если игрок найден то возвращается картинка с подробной статистикой. Иначе возвращается ошибка.


2: /astats <account>

  • account Номер аккаунта для запроса статистики

Что делает:

  • Тоже самое что и /stats только данные вводить не нужно, они берутся из базы данных после регистрации их командой /set_player

Игровые сессии:

Внимание:

1: /start_session <account>

  • account Номер аккаунта для запуска сессии

Что делает:

  • Запускает сессию, после запуска сессии вам необходимо сыграть несколько боёв для генерации статистики.


2: /start_autosession <timezone> <restart_time> <account>

Параметры:

  • timezone : int Смещение вашего времени от UTC (Времени по Гринвичу). Например часовой пояс МСК это UTC + 3, следовательно в параметр надо передавать число 3 если вы хотите время по МСК. По умолчанию 0 (Время UTC)

  • restart_time : str Время, в которе будет перезапускаться сессия, указывается в виде строки времени в 24 часовом формате.

Пример подходящего значения времени: 12:30, 19:22, 00:10, 03:45

Пример неправильных значений: 3:45, 12:34:20, 09:22PM, 26:32

  • account Номер аккаунта для запуска сессии

Что делает:

  • Запускает автоматическую сессию или перезапускает уже существующую (сбрасывает статистику) которая будет перезапускаться в указаное время.


3: /get_session <account>

  • account Номер аккаунта для получения сессии

Что делает:

  • Генерирует сессию игрока и отправляет в ответ картинку с сессионной статистикой.


4: /session_state <account>

  • account Номер аккаунта для проверки состояния сессии

Что делает:

  • Отображает активна ли сессия и время, которое сессия активна.


Кстомизация:

1: /set_background [image] <server> <resize_mode>

Параметры:

  • image Файл изображения (700x1350), имеет следующие ограничения:

    • Форматы PNG, JPEG

    • Размер одной из сторон не более 2048 px и не менее 256 px

    • Вес не более 2МБ

  • server Если True то изображение применяется как изображение по умолчанию для сервера в котором была вызвана команда. Требуются права администратора на сервере.

  • resize_mode Метод подгонки изображения по размеру (если оно не 700x1350)

    • AUTO Автоматическое определение лучшего метода изменения размера

    • RESIZE Изменение размера игнорируя пропорции, применяется автоматически когда отклонение от номинального размера составляет менее 10% по X и 15% по Y

    • CROP_OR_FILL - Обрезка изображения и центровка если оно больше нужного или центровка и добавление заполнителя в виде размытых частей исходного изображения если размер картинки меньше необходимого. Не нарушает пропорции картинки. Применяется автоматически если невозможен метод RESIZE по причине сильного искажения пропорций.

Что делает:

  • Сохраняет выбраное изображение в качестве фона для изображений со статистикой для вас или на сервер где была вызвана команда (Зависит от параметра server)

Внимание:

Предупреждение:

Примечание:

  • Еслы вы являетесь администратором сервера на котором используете бота вы можете отключить возможность пользователям использовать кастомные фоны для статистики на вашем сервере и установить свой фон, который будет отображаться пользователям.


2: /unset_background

Что делает:

  • Сбрасывает пользовательский фон удаляя его из базы данных.


3: /image_settings <params> <account>

Параметры:

  • account Номер аккаунта для применения настроек


  • use_custom_bg : bool Возможность использовать свой фон (True по умолчанию)

  • glass_effect : int Параметр размытия фона за блоками со статистикой на изображении. 0 - Отключает размытие.

  • blocks_bg_brightness : int Яркость фона за блоками со статистикой в %

  • nickname_color : str Цвет никнейма в формате HEX Color. Пример #ff0000 - красный. Выбрать цвкт и скопировать его можно тут -> Google palette

  • clan_tag_color : str Цвет клан-тега

  • stats_color : str Цвет цифр с основной статистикой, такой как например количество боёв на аккаунте.

  • main_text_color : str Цвет главного текста, какого как например категории статистики

  • stats_text_color : str - Цвет статистики надписей по типу: средний урон или рейтинг которые находятся под основной статистикой.

  • disable_flag : bool - Выключение флага региона на изображении

  • disable_cache_label : bool - Выключение значка кеша если данные были использованы сохранённые данные.

  • hide_nickanme : bool - Скрытие никнейма. Если включено никнейм изменяется на Player

  • hide_clan_tag : bool - Скрытие клан-тега в статистике. Если включено клан-тег не отображается.

  • disable_stats_blocks : bool - Отключает отрисовку контрастных блоков которые выделяют статистику на фоне изображения. Может пригодится если вы подготовили своё фоновое изображение и вам мешает стандартное выделение статистики.

  • disable_rating_stats : bool - отключает отображение блока с рейтинговой статистикой при запросе сессионной статистики.

  • positive_stats_color : str - Определяет цвет положительной сессионой статистики

  • negative_stas_color : str - Определяет цвет отрицательной сессионой статистики

Что делает:

  • Сохраняет и применяет установленые настройки для изображения.

Примечание:

Все параметры этой команды являются необязательными, меняйте за раз столько настроек, сколько сочтёте нужным, не тронутые настройки просто не изменятся.


4: /image_settings_get <account>

  • account Номер аккаунта для получения настроек

Что делает:

  • Отправляет пользователю его текущие настройки изображения в виде картинки.

Картинка настроек изображения.

5: /image_settings_reset <account>

  • account Номер аккаунта для сброса настроек

Что делает:

  • Сбрасывает все настройки изображения на настройки по умолчанию.

Примечание:

Не влияет на фоновое изображение, если вам нужно сбросить фоновое изображение то используйте: /unset_background


Настройки сервера:

1: /server_settings <params>

Параметры:

  • allow_custom_backgrounds - Параметр определяющий разрешено ли пользователям использовать свои фоны для статистики на этом сервере.

Что делает:

  • Если False то подменяет изображение пользователя на установленное по умолчанию для этого сервера или на стандартное изображение если на сервере не установлен фон по умолчанию.


2: /server_settings_get

Что делает:

  • Выводит пользователю текущие настройки сервера.

Другие команды:

1: /parse_replay [replay] [region] <output_type>

Параметры:

  • replay Файл реплея с расширением .wotbreplay

  • region Регион в котором был сыгран бой

  • output_type Тип вывода, игнорируйте если не знаете что такое JSON

Что делает:

  • Показывает основную информацию о реплее, список участников боя из реплея и их статистику.


2: /ping

Что делает:

  • Отображает время отклика бота.

Внимание:

3: /hook_stats [stats_name] [trigger] [target_value] [watch_for]

Аргументы:

  • stats_name Имя отслеживаемой статистики. (список вариантов)

  • trigger Условие срабатывания триггера (список вариантов)

    • Триггер сработает если отслеживаемая статистика:

    • MORE_THAN больше целевого значения

    • MORE_OR_EQUAL больше или равна целевому значению

    • LESS_THAN меньше целевого значения

    • LESS_OR_EQUAL меньше или равна целевому значению

    • EQUAL_FOR равна целевому значению

    • NON_EQUAL не равна целевому значению

  • target_value Целевое значение. Используется вместе с trigger образуя общее условие срабатывания хука. Может быть любое чило, положительно или отрицательное а так-же цисло с плавающей запятой (дробное число).

  • watch_for Этот параметр определяет за каким типом статистики вести отслеживание. (список вариантов)

    • main Общая статистика по аккаунту

    • session Сессионая статистика

    • diff Разница между сессионной статистикой и основной.

Что делает:

  • Создаёт захват статистики по определённым условиям и если условия оказываются верны то бот упоминает вас в том же канале где и был создан хук.

Время жизни хука 48 часов после чего если хук так и не был активирован (не сработал) он удаляется автоматически.

4: /hook_state <account>

Аргументы:

  • account номер аккаунта для которого надо проверить состояние хука.

Что делает:

  • Возвращает информацию о состоянии хука. Если хук активен так же под сообщение о состоянии хука будет кнопка позволяющаа отключить хук.

Last updated

Was this helpful?