Page cover

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

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

Зміст

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

/command [param_1] <param_2> <param_3>

  • Декотрі команди мають параметри, які можуть бути обов'язковими або необов'язковими /command [param]

  • Якщо аргумент зазначений у квадратних дужках [] то він являється обов'язковим

  • Якщо аргумент зазначений в трикутних дужках <> то він являєтся необов'язковим

Приклад:

/parse_replay [replay] [region] <output_type>

  • Параметр replay являєтся обов'язковим.

  • Аргумент output_type является необов'язковим, так що його можна не указивати.

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

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

Налаштування:

1: /set_lang [lang]

Параметри:

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

Що робить:

  • Встановлює мову локалізації для вас.

Примітка

  • Мова default вмикає автоматичний вибор мови. Автоматичний вибор спирається на мову встановленну в интерфейсІ Додатка Discord.

  • Може не працювати зі старими версіями Discord.


2: /set_player [nickname] [region]

Параметри:

  • nickname Нікнейм гравця для сбереження (строка)

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

Що робить:

  • Записує гравця в базу данних для подальшого використання, наприклад для команди /astats

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

1: /stats [nickname] [region]

Параметри:

  • nickname Нікнейм гравця для пошука (строка)

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

Що робить:

  • Проводить пошук гравця с заданным нікнеймом в заданому регіоні. Якщо гравець знайден то повертається картинка з докладною статистикою. Инакше повертається помилка.


2: /astats

Що робить:

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

Ігрові сесії:

Увага:

1: /start_session

Що робить:

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


2: /start_autosession <timezone> <restart_time>

Параметри:

  • 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

Що робить:

  • Запускає автоматичну сесію або перезапускає вже існуючу (скидує статистику) котра буде перезапускатися в указанний час.


3: /get_session

Що робить:

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


4: /session_state

Що робить:

  • Відображає чи активна сесія, та час який сесія активна.


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

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>

Параметри:

  • 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

Що робить:

  • Відправляє користувачеві його поточні параметри зображення у вигляді зображення.

Картинка налаштування зображення.

5: /image_settings_reset

Що робить:

  • Скидає всі налаштування зображення на налаштування за промовчанням.

Примітка:

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


Налаштування сервера:

1: /server_settings <params>

Параметри:

  • allow_custom_backgrounds - Параметр визначальний, чи дозволено користувачам використовувати свої фони для статистики на цьому сервері.

Що робить:

  • Якщо False то підмінює зображення користувача на встановлене за промовчанням для цього сервера або на стандартне зображення, якщо на сервері не встановлено фон за промовчанням.


2: /server_settings_get

Що робить:

  • Виводить користувачеві поточні налаштування сервера прямо як /image_settings_get

Інші команди:

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

Параметри:

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

  • region Регіон в якому був зіграний бій

  • output_type Тип виводу, ігноруйте якщо не знаєте що таке

    JSON

Що робить:

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


2: /ping

Що робить:

Відображає час відгуку робота.

Увага:

Last updated

Was this helpful?