Инструкция по работе с ботом @YaEyebot

@YaEyebot является неформальным стандартом мониторинга работы игровых серверов на МТС Fog Play. К боту подключены сотни 🖥ПК.

Для начала

Основные возможности

✅Бот предоставляет разнообразные отчеты о работе отслеживаемых 🖥ПК, в т.ч. в реальном времени. Делает он это в паре с программой-датчиком, устанавливаемой на 🖥ПК и отсылающей данные боту

✅Программа-датчик запускается в свернутом виде. По двойному клику на значке в трее её можно развернуть и закрыть

✅Если в программе указать настоящее имя 🖥ПК на МТС Fog Play (например, EF7X4), а в боте прописать промо-ссылку для своих 🖥ПК, то игроки смогут через отдельного бота @YaFreePCbot находить его и отслеживать его освобождение

✅Бот позволяет отслеживать появление новых версий 🕹игр, узнавать 📁пути к сейвам, предупреждать о неполадках с 🖥ПК

✅Программа-датчик умеет вести 🎥видеонаблюдение (если его включить)

✅Программа-датчик позволяет осуществлять резервное хранение сейвов между игровыми сессиями (если его включить)

✅Программа-датчик умеет автоматически обновляться (если включить эту функцию и соблюсти требования инструкции)

✅Программа-датчик помогает отслеживать температуры и загрузку железа через бота (если его включить и если позволят настройки вашего 🖥ПК)

✅Программа-датчик помогает автоматически обновлять МТС Remote Play (но вам потребуется самостоятельно написать скрипт, если тот, что поставляется в качестве примера, не сработает)

✅Программа-датчик поддерживает 💬диалог игроков 🖥ПК с владельцем. По умолчанию он отключен (галка "Позволить вызывать диалог с владельцем"). Также можно отправлять игроку ⚡️экстренные сообщения

Обратная связь

❔Если возникли вопросы – пишите в чат для обсуждения

Установка

Чтобы подключить 🖥компьютер к отслеживанию через @YaEyebot, установите программу-датчик.

⚠️При необходимости программа может запросить установку Java SE Development Kit

⚠️Если ранее вы уже ставили нашу программу - укажите ей ту же папку для установки. Старые настройки сохранятся.

⚠️Программа автоматически создаст новый ярлык в Автозагрузке. Удалите старый, если до этого не устанавливали программу с помощью инсталлятора. При следующих обновлениях этого делать не потребуется.

⚠️При первом запуске программа запросит Ваш id в телеграмме. Его можно узнать в @YaEyebot с помощью команды /help (или 🆘Помощь >> ❔Справка по боту)

⚠️️️Для подключения 🖥ПК к боту необходимо запросить в @YaEyebot ключ.

Это делается в меню 🎛Личный кабинет >> 🖥Мои ПК >> 🆕Добавить 🖥ПК.

Ключ необходимо вставить в поле на вкладке "Основное" программы-датчика.

❗️️Обязательно сохраните настройки и перезапустите бота в течение 10 минут с момента получения ключа, иначе придется получать заново.

⚠️Программа защищается от двойного запуска, занимая порт 55555

⚠️Для полноценной работы боту нужны данные из вашей 📚библиотеки игр, поэтому путь до нее крайне рекомендуется указывать в программе-датчике

Меню (команды) бота

/reports (📁Отчеты) – дает доступ к отчетам. Основные из них:

🕞"Длинные" отчеты – позволяют получить данные о том, когда, сколько и во что играли на ваших 🖥ПК:

🤓Специальные отчеты включают:

/private_office – 🎛Личный кабинет, где можно отказаться от предоставления доступа (👨‍💼Мои друзья), поправить некоторые данные 🖥ПК (🖥Мои ПК) и задать общие ⚙️Настройки:

В меню 🖥Мои ПК для каждого 🖥ПК можно:

Оповещения

⚠️Бот докладывает:

*если ✅включены соответствующие галки в ⚙️Настройках - см. выше☝️

Настройка вариантов отчетов

✅В платной версии можно создавать собственные отчеты, на основе описанных выше, сохранять их и затем вызывать из меню 💪Мои отчеты

Доступны для настройки в зависимости от вида отчета: период, набор 🖥ПК, 🕹игр, группировка (по ПК\играм), представление результата(💬чат\📊Excel), 🧮метод усреднения (для ⚖️отчета о ситуации на платформе), минимальная и максимальная ⏳длительность сессии

Предоставление доступа

✅В платной версии можно предоставить 👨‍💼другу доступ к своему аккаунту в боте (если, например, вы наняли администратора).

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

Чтобы предоставить 👨‍💼другу доступ - нужно просто поделиться с @YaEyeBot его контактом.

⚠️👨‍💼Друг, которому вы предлагаете полный доступ должен быть пользователем бота и принять ваше приглашение.

❗️В случае принятия, он не сможет управлять собственными 🖥ПК (если они у него есть), видеть их данные и оповещения (но прием и запись данных от программы-датчика, установленной на его 🖥ПК, продолжится).

✅Пользователей, которым вы дали полный доступ, можно найти в меню 🎛Личный кабинет >> 👨‍💼Мои друзья. Там вы можете в любой момент отозвать его

✅Пользователь с полным доступом к вашим данным всегда может отказаться от него используя меню 🎛Личный кабинет >> 🗑Отказаться от доступа

Настройка видеозаписи сессий

✅Программа-датчик умеет записывать видео всего, что происходит на 🖥ПК после подключения игрока.

Видеозапись можно не включать (при первой установке она отключена по умолчанию). Включается и настраивается на вкладке "Видео"

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

Максимальной длительности одной видеозаписи

⚠️Запись начинается в двух случаях:

Запись будет идти столько минут, сколько указано в "Максимальной длительности одной видеозаписи".

Что за WriteVideo.txt?

✅МТС Remote Play умеет запускать пользовательские скрипты: OnStart.bat - при запуске самого МТС Remote Play и OnStopIdle.bat - при бронировании ПК.

Для этого необходимо в файле $USER\AppData\Local\rds-wrtc\rds-wrtc.json прописать "run_scripts_in_standby":true

Далее в той же папке необходимо создать файлы OnStart.bat (в нем можно просто написать exit) и OnStopIdle.bat

И, наконец, в OnStopIdle.bat нужно прописать заполнение файла WriteVideo.txt: <nul set /p tmpstr="1">C:\Users\Guest\Documents\YaEyeBot\WriteVideo.txt

Теперь МТС Remote Play будет сообщать программе-датчику, что пользователь вот-вот подключится, что позволит начинать запись видео заранее.

Файлы видеозаписей

⚠️Видео сессий появляются после перезагрузки. В ходе сессии программа лишь делает скриншоты.

❗️Важно: чтобы записи видео сохранялись между сессиями - нужно внести указанную вами папку для их хранения в исключение вашей программы сохранения дефолтного состояния ПК (наверное, у большинства, это Shadow Defender).

Автообновление МТС Remote Play

✅Галка включает реакцию программы-датчика на оповещение бота о появлении новой версии МТС Remote Play, которая заключается в запуске скрипта ..\YaEyeBot\MTSUpdate.ps1

Поскольку настройки игровых 🖥ПК сильно отличаются, программа НЕ ГАРАНТИРУЕТ работу скрипта именно на вашем 🖥ПК. По умолчанию, в MTSUpdate.ps1 - просто пример того, как оно работает на некоторых 🖥ПК.

❗️Нужно самостоятельно изменить скрипт MTSUpdate.ps1 с учетом своих настроек, путей и т.п.

⚠️Этот файл не будет затираться при обновлении бота.

❗️В случае изменения MTSUpdate.ps1 - обязательно сделайте его резервную копию в папку ../YaEyeBotUpdater/ (по соседству с папкой программы-датчика).

❗️В любом случае, необходимо включить папку, куда установлен МТС Remote Play, в исключения ПО, сохраняющего дефолтное состояние ПК (папку с настройками МТС Remote Play включать не нужно).

Автообновление програмы-датчика

✅Галка включает... автообновление программы-датчика:)

❗️Необходимо включить всю папку YaEyeBot в исключения ПО, сохраняющего дефолтное состояние ПК.

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

Отслеживание показателей железа

✅Галка включает отслеживание данных о температурах и загрузке различных устройств, которые в дальнейшем можно смотреть в боте.

Это делается с помощью бесплатной утилиты Libre Hardware Monitor с открытым кодом.

⚠️Данные о процессоре, памяти и т.д. - доступны только при запуске с определенными правами.

Если вы настраивали систему по инструкции MTS FogPlay и у вас полностью выключен UAC, то должно работать.

❗️В противном случае работа не гарантируется. Можете попробовать настроить задание в Планировщике заданий по инструкции: YaEyeBot\lhm\manual.docx

✅Либо можно включить галку "Только видеокарта" - в это случае проблем с правами быть не должно, но вы будете получать только данные по температуре и загрузке видеокарты.

Чат владельца с пользователем ПК

✅Программа-датчик поддерживает диалог пользователей ПК с владельцем. По умолчанию он отключен и включается галкой "Позволить вызывать диалог с владельцем" на вкладке "Основное".

Когда галка включена, окно чата можно открыть в любой момент по Ctrl+Shift+F1 (и таким же способом закрыть, либо через крестик)

❗️Важно: окно чата будет видно только при свернутой библиотеке игр

⚡️Сообщения от игроков приходят в бота с пометкой от какого 🖥ПК. Ответные сообщения также нужно писать в бота, но ❗️обязательно ответом на какое-нибудь сообщение от игрока - так бот поймет, на какой 🖥ПК слать.

Если в настройках основного бота  @YaEyebot вы включили галку Чат с игроком в отдельном боте – ⚡️сообщения будут приходить в отдельного бота @YaEyeChatbot (соответственно, его нужно подключить в телеграме). Ответы также нужно будет писать в @YaEyeChatbot.

Срочные сообщения

⚠️Также через бота можно отправлять ⚡️⚡️⚡️срочные сообщения игроку - они будут отображаться независимо от того, включен ли чат на соответствующем 🖥ПК.

Такие сообщения выводятся в левом верхнем углу экрана поверх всего и закрываются автоматически через 10 сек.

Отправить срочное сообщение можно через любого из ботов: @YaEyebot или @YaEyeChatbot.

❗️Главное, чтоб оно соответствовало формату: #alarm <имя ПК>:<текст сообщения>

Настройка резервного копирования сейвов

✅Программа-датчик позволяет осуществлять резервное хранение сейвов между игровыми сессиями. По умолчанию оно отключено и включается галкой "Хранить сейвы между сессиями" на вкладке "Сейвы".

Когда галка включена, нужно указать Папку для хранения сейвов игроков и внести её в исключения программы сохранения дефолтного состояния ПК (наверное, у большинства, это Shadow Defender).

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

Также предусмотрен Срок хранения сейвов (чтобы не забивать диск).

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

⚠️Естественно, должен быть указан правильный путь до 📚библиотеки на вкладке "Основное", чтобы программа знала, какие папки отслеживать.

Описание алгоритма:

Отслеживание объема датасетов на вашем TrueNAS

✅Бот может отслеживать переполнение датасетов на вашем TrueNAS.

Для этого нужно скачать отдельную утилиту, распаковать на том 🖥ПК, который вы используете для администрирования TrueNAS, и поместить ярлык в Автозагрузку.

Также нужно указать верные настройки в файле settings.txt: IP-адрес TrueNAS, API-ключ к нему, ваш телеграм-id, максимально допустимый размер датасета (в Гб), при достижении которого вы хотите получать уведомление. Наконец нужен список пар: <строка для определения датасета по имени> ,<guid ПК, к которому он относится>.

Шаблон настроек с заполненными данными по вашим ПК можно найти в 🎛Личный кабинет >> ⚙️Настройки >> 📃Шаблон настроек монитора TrueNAS

Настройка реакций на процессы

✅Галка на вкладке "Реакция на процессы" включает реакции программы-датчика на те или иные процессы. Задать их можно, кликнув на "Список процессов с настройками", в следующих форматах:

Пример:

Здесь:

Настройка источников для отчета об обновленных играх

Чтобы отчет ⚡️Последние обновленные игры заработал на полную катушку - надо предоставить боту ссылки на странички игр для ежедневной проверки обновлений.

Для этого:

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

Помощь проекту

Мы будем рады любым пожертвованиям:) Их можно слать на криптокошелек 0x73306B813aAD5Ec4142Fa03998898f955234366D (сети BSC, Polygon – любые стейблы или нативные токены BNB, Matic),  или с помощью киви и карт любых российских банков

Платные функции

К платным функциям относятся:

Оплатить можно двумя способами: