Игры и API
Описание
Руководство пользователя
Подключите API ваших игр к серверу: участники привязывают свои аккаунты, смотрят статистику, следят за состоянием игровых серверов и сравнивают себя в рейтинге. 23 игры поставляются готовыми к работе, и вы можете добавить свои.
Что это делает
- Позволяет каждому участнику привязать игровой аккаунт к серверу.
- Показывает статистику игрока по запросу.
- Публикует состояние игровых серверов в постоянно обновляемом сообщении и может переименовывать голосовой канал-счётчик.
- Автоматически публикует новости игры в канале.
- Формирует рейтинг участников, привязавших свои аккаунты.
- Предлагает поиск по базам данных некоторых игр.
- Конструктор позволяет подключить любой API, возвращающий JSON, без написания кода.
Быстрый старт (админ)
- Откройте панель управления, модуль Игры и API, вкладка Каталог.
- Найдите свою игру и нажмите Включить. Настройки игры откроются сразу же.
- Если игра помечена как «Требуется ключ», вставьте свой ключ API в карточку Ключ API. Если отображается пометка «Ключ TennoCore», значит ключ уже предоставлен и делать ничего не нужно.
- При желании включите автоматизации: Новости, Статус, Рейтинг — каждой нужен канал и интервал.
- Нажмите кнопку Проверить, чтобы убедиться, что API отвечает, затем Сохранить.
- Расскажите участникам про
/game list: там они увидят доступные игры и привяжут аккаунт командой/game link.
Команды
Все команды доступны всем участникам и отвечают приватно, когда речь идёт о привязке аккаунта.
| Команда | Описание |
|---|---|
/game list | Перечисляет игры, включённые на сервере, с описанием возможностей каждой. |
/game link | Открывает форму для привязки вашего аккаунта к выбранной игре. |
/game unlink | Удаляет привязку вашего аккаунта для этой игры. |
/game stats | Показывает статистику участника (по умолчанию вашу). |
/game status | Показывает состояние игровых серверов. |
/game lookup | Ищет запись в базе данных игры. |
/game leaderboard | Строит рейтинг участников сервера, привязавших свои аккаунты. |
Игры, поставляемые с ботом
В комплекте 23 коннектора. Каждый предоставляет одну или несколько возможностей: Статистика игрока, Статус серверов, Новости, Поиск.
| Игра | Возможности | Ключ API |
|---|---|---|
| Apex Legends | Статистика игрока | Требуется |
| Brawl Stars | Статистика игрока | Требуется |
| Chess.com | Статистика игрока | Нет |
| Clash Royale | Статистика игрока | Требуется |
| Destiny 2 | Статистика игрока | Требуется |
| Epic Games — бесплатные игры | Новости | Нет |
| Fortnite | Статистика игрока | Требуется |
| Free-To-Game — релизы F2P | Новости, Поиск | Нет |
| Genshin Impact | Статистика игрока | Нет |
| Hypixel (Minecraft) | Статистика игрока | Требуется |
| League of Legends | Статистика игрока, Статус серверов | Требуется |
| Lichess | Статистика игрока | Нет |
| Minecraft — Игрок | Статистика игрока | Нет |
| Minecraft — Сервер | Статус серверов | Нет |
| osu! | Статистика игрока | Требуется |
| Покедекс (PokéAPI) | Поиск | Нет |
| RAWG — база данных игр | Поиск, Новости | Требуется |
| Roblox | Статистика игрока | Нет |
| Статус (обычный Statuspage) | Статус серверов | Нет |
| Steam — новости игры | Новости | Нет |
| Steam — профиль | Статистика игрока | Требуется |
| Valorant | Статистика игрока | Требуется |
| Warframe — мир | Статус серверов, Новости | Нет |
Настройки в панели управления
Модуль состоит из пяти вкладок.
- Каталог — все доступные игры с фильтрами по категории или названию. На каждой карточке указаны возможности игры и потребность в ключе. Кнопки Включить, Дублировать (чтобы взять за основу существующий коннектор) и ссылка на документацию API.
- Мои игры — игры, включённые на этом сервере: состояние, активные автоматизации, число привязанных аккаунтов, источник ключа, последняя возникшая неполадка. Кнопка Настроить открывает параметры:
- Общее: игра активна или приостановлена, и роль, автоматически выдаваемая участнику при привязке аккаунта.
- Ключ API: ваш ключ, хранящийся в зашифрованном виде и никогда не отображаемый повторно. Оставьте поле пустым, чтобы ничего не менять.
- Параметры коннектора: настройки, свойственные конкретной игре (идентификатор приложения Steam, регион и так далее).
- Новости: канал, интервал (от 5 до 1440 минут, по умолчанию 30) и, при необходимости, упоминание роли.
- Статус: канал панели, интервал (по умолчанию 10 минут) и голосовой канал-счётчик с шаблоном названия.
- Рейтинг: канал, интервал (по умолчанию 60 минут) и напоминание о том, какая статистика берётся за основу.
- У каждой автоматизации есть кнопка Опубликовать сейчас.
- Конструктор — создание собственного коннектора: общие сведения, аутентификация, поля, запрашиваемые у участника, шаги вызовов и описание формируемого сообщения. Испытательный стенд делает настоящий вызов и показывает дерево ответа: нажмите на значение, чтобы скопировать его путь и использовать в оформлении.
- Игроки — все привязанные аккаунты сервера, с возможностью отвязать участника.
- Журнал — 50 последних исходящих вызовов к API, с длительностью, результатом и подробностями ошибки.
Полезно знать
- Игра должна быть включена, чтобы существовать. Автодополнение команд предлагает только включённые игры, и лишь те, что совместимы с используемой командой: игра, предоставляющая только новости, не появится в
/game stats. - Привязка проверяется сразу.
/game linkделает настоящий вызов к API: если аккаунт не найден, ничего не сохраняется, а участник получает ошибку, возвращённую игрой. Поэтому привязанный аккаунт — это всегда работающий аккаунт. - Форма привязки ограничена 5 полями — это ограничение Discord.
- Гибридный режим ключей API: ваш ключ всегда в приоритете; при его отсутствии используется глобальный ключ TennoCore, если он есть. Указав свой ключ, вы получаете собственную квоту. Сохранённый ключ никогда не отображается в интерфейсе повторно.
- Квоты: каждый коннектор задаёт свой предел вызовов (как правило, 30 в минуту на сервер). При его превышении бот отвечает, что нужно подождать минуту. Ответы кешируются на несколько минут, что сглаживает повторные запросы.
- Рейтинг: опрашивается не более 40 привязанных аккаунтов, отображаются первые 20. Вызовы намеренно разнесены во времени, чтобы не исчерпать квоту сервера — задавайте широкий интервал, если привязано много участников. Рейтинг останется пустым, если коннектор не задаёт статистику для сравнения.
- Первый проход новостной ленты: ничего не публикуется, бот лишь запоминает существующую историю. Так сделано намеренно, чтобы не завалить канал сообщениями. Публикации начинаются со следующего прохода.
- Голосовой канал-счётчик: Discord допускает только 2 переименования за 10 минут. Слишком короткий интервал будет молча проигнорирован Discord.
/game listпоказывает не более 25 игр, а автодополнение — 25 вариантов.- Удаление игры стирает её настройки и историю новостей, но сохраняет привязанные аккаунты участников.
- Сообщения модуля используют новый формат отображения Discord: каждое поле занимает отдельную строку, разбивки на колонки нет.
- Собственные коннекторы: вызываемые адреса должны указывать на публичный API. Любой внутренний или частный адрес отклоняется из соображений безопасности.
- Журнал вызовов хранится 7 дней.
- Модуль находится в категории «В разработке» панели управления: его интерфейс ещё может измениться.