@encx_bot

Быстрый старт

Для запуска бота можно воспользоваться командой /start с параметрами: URL анонса игры, логин, пароль. Необходимо использовать любой свободный аккаунт из команды.

/start http://minsk.en.cx/GameDetails.aspx?gid=50 air Password123

Выполнять эту команду необходимо в чате, в котором планируется использование бота. При этом пароль от аккаунта смогут увидеть все его участники. Чтобы избежать этого, можно воспользоваться командой /encrypt. Вызывать её соответственно необходимо в личных сообщениях с ботом.

>> /encrypt Password123

<< enc:xgiawhTzztn05/DrQkbRjQ==

Строка для запуска в этом случае будет выглядеть следующим образом:

/start http://minsk.en.cx/GameDetails.aspx?gid=50 air enc:xgiawhTzztn05/DrQkbRjQ==

Также допустимы следующие комбинации параметров:

/start minsk.en.cx 50 air Password123

/start minsk.en.cx 50

/start http://minsk.en.cx/GameDetails.aspx?gid=50

Настройки

Все допустимые настройки для бота открываются с помощью команды /settings. Настройка производится для каждого чата отдельно. Перенести личные настройки в общий чат можно с помощью кнопки Запустить в чате. Данная кнопка доступна в /settings в личном чате.

Ссылка на игру

/game_url http://minsk.en.cx/GameDetails.aspx?gid=50

Прием кодов из чата

/answers_on

/answers_off

Позволяет запретить боту вбивать коды, присылаемые в чат с помощью команды /код. Это может понадобиться на уровнях, где авторы установили штраф за неверное вбитие искусственно (не средствами движка).

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

Отображение текста задания при получении нового уровня

/task_content_on

/task_content_off

При получении нового уровня присылать текст самого задания. В случае, если отображение текста выключено, будет присылаться только сообщение с общей информацией о новом уровне. Может быть полезно, например, для минимизации информации, отправляемой в канал.

Вывод названия секторов при получении нового уровня

/sector_on

/sector_off

При получении нового уровня присылать не только информацию о количестве секторов на уровне, но и их названия. Максимум - 20 секторов. Полный список можно посмотреть с помощью соответствующей команды /sectors

Вывод информации о закрытом секторе

/sector_notification_on

/sector_notification_off

Уведомления о закрытых секторах, если он взят из-под аккаунта, отличного от аккаунта, используемого ботом.

Вывод информации об открытых бонусах при получении нового уровня

/bonus_on

/bonus_off

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

Если невыполненных бонусов, содержащих текст, не больше трёх, то будет выведено их содержимое.

Если бонусов от 3 до 10, то выведется список команд, позволяющих открыть каждый из них.

Если бонусов больше 10, то выведется только информация о их наличии.

Уведомления об изменении статуса бонуса

/bonus_notification_on

/bonus_notification_off

Изменение статуса бонуса: выполнен бонус, открылся новый бонус, истекло время действия бонуса. Выдаётся только текст, описывающий произошедшие события.

Пример:

Открылись новые бонусы: /bonus58 Бонус 58: 20, /bonus59 Бонус 59: 20, /bonus60 Бонус 60: 20

Выполнены бонусы: /bonus58 Бонус 58: 20

Бонусы истекли: /bonus25 Бонус 25, /bonus26 Бонус 26, /bonus27 Бонус 27, /bonus28 Бонус 28

Отображение текста бонуса при его появлении

/bonus_content_on

/bonus_content_off

При изменении статуса бонуса выводить его содержимое.

Пример:

Бонус 55: 19

2й этаж, стена напротив 4 окна справа от лестницы

Вывод геолокации (распознавание координат)

/gps_on

/gps_off

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

Поиск координат в тексте бонусов

 /bonus_gps_on

 /bonus_gps_off

При выдаче нового задания геолокации бот присылает не только из текста самого задания, но и из бонусов. В некоторых случаях необходимо выключить отправку координат из бонусов. Например, если в тексте задания есть координаты основы, на которую нужно ехать, а в бонусах дополнительные бонусные координаты, которые будут мешать основному прохождению. Ещё один пример будет рассмотрен ниже.

Построитель маршрута по координатам из задания

/navigation_on

/navigation_off

Данная настройка позволяет включить/выключить рисование карт доезда от текущего местоположения до точки назначения.

Текущее местоположение

• Установленная с помощью команды /from точка
• Если ранее была установлена точка назначения, то она становится текущим местоположением в следующих случаях (точка назначения при этом сбрасывается): выдача нового уровня; координата в подсказке; координаты в тексте открывшегося бонуса или выполненного, если включена опция Поиск координат в тексте бонусов

Точка назначения

• Установленная с помощью /to точка
• Первая найденная координата из текста уровня
• Первая найденная координата из подсказки
• Первая найденная координата из нового сообщения организатора
• Первая найденная координата в тексте открывшегося бонуса или выполненного, если включена опция Поиск координат в тексте бонусов

При появлении новой точки назначения, кроме случая выставления с помощью команды /to, в чат отправляются две картинки: полный маршрут, увеличенное начало маршрута.

Вывод адреса координат

/address_on

/address_off

Отправлять помимо геолокации ближайший к точке адрес.

Логин или id

/login air

Пароль

/password Password123

Выполнять эту команду необходимо в чате, в котором планируется использование бота. При этом пароль от аккаунта смогут увидеть все его участники. Чтобы избежать этого, можно воспользоваться командой /encrypt. Вызывать её соответственно необходимо в личных сообщениях с ботом.

>> /encrypt Password123

<< enc:xgiawhTzztn05/DrQkbRjQ==

>>/password enc:xgiawhTzztn05/DrQkbRjQ==

Остальные команды для управления ботом

Настройки

/settings - настройки

Работа с чатом

/pause - остановить слежение; прием кодов из чата при этом все равно остается доступным - чтобы запретить коды, см. команду /answers_off

/stop - полностью остановить работу бота

/join - подключиться к данному чату или подключить этот чат к чату, где запущен бот; подробнее данная функциональность будет рассмотрена ниже

/info [информация] - задать полезную информацию по игре или получить текущее значение (если параметр команды информация не указан)

Работа с движком

/level - отобразить описание текущего уровня

/task - отобразить текущее задание

/time - отобразить время до автоперехода

/monitor - вывести последние ответы из мониторинга

/messages - вывести список сообщений организатора

/код - вбить в движок код

/код #хештег - вбить в движок код

/!код - принудительно вбить в движок код (даже если есть ограничение на уровне)

Секторы:

/sectors - отобразить все секторы

/sectors_left - отобразить незакрытые секторы

Подсказки:

/hints - вывести список подсказок

/hint - вывести текст последней подсказки

/hint<N> - вывести текст подсказки номер <N> (например, /hint1, /hint2)

/hint_time - вывести время, оставшееся до ближайшей подсказки

Бонусы:

/bonuses - отобразить все бонусы

/bonus<N> - вывести текст бонуса номер <N> (например, /bonus1, /bonus2)

Штурмовая игра:

/levels - список уровней

/level<N> - перевести слежение на уровень номер <N> (нарпимер, /level1, level2)

Координаты и карты

/from - установить текущее местонахождение

/to - установить пункт назначения

/go - проложить маршрут от текущего местоположения до пункта назначения

/kml - скачать kml с маркерами текущего уровня

/kml_full - скачать KML со всеми маркерами игры

/coords - получить координаты точек уровня

Подключение чатов и каналов

К запущенному слежению можно подключать с помощью команды /join дополнительные чаты. Следует обратить внимание, что настройки бота в каждом чате свои, т.е. можно регулировать правила уведомлений и т.п. в каждом чате отдельно.

Подключение чата

Если в чате не запущен бот, то по команде /join бот выдаёт ссылку, которой можно воспользоваться для подключения данного чата к чату, в котором слежение запущено.

Если в чате запущен бот, то по команде /join происходит подключение личного чата к данному.

Подключение канала

Подключение канала допустимо только к слежению в личном чате, в том числе, транзитивно, т.е. если личный чат подключен к другому чату. Настройки для личного чата и канала общие.

Чтобы подключить канал, необходимо сделать бота администратором в канале и сделать форвард любого сообщения из канала в личные сообщения с ботом. В ответ будет выдано сообщение для запуска и остановки слежения в канале.

Важные замечания

Если будет вызвана команда /stop в исходном чате, к которому подключались другие чаты, то все подключения сбросятся.

Регулировать слежение можно с помощью команд /pause, /start в каждом чате отдельно.