HyQuery
Let server lists show your server's status — players online, MOTD, and more.
Описание
HyQuery
Пусть списки серверов показывают статус вашего сервера - игроки онлайн, MOTD и многое другое!
Что такое HyQuery?
HyQuery - это протокол запросов сервера, разработанный специально для серверов Hytale. После установки списки серверов и инструменты мониторинга могут автоматически отображать количество игроков, имя сервера и другие детали - никаких ручных обновлений не требуется!
Независимо от того, создаете ли вы веб-сайт с перечислением серверов, бота Discord или инструмент управления сервером, HyQuery предоставляет стандартизированный способ получения информации о сервере.
HyQuery является стандартной реализацией для большинства списков серверов Hytale.
Почему HyQuery?
- Установить и забыть — работает из коробки, конфигурация не требуется
- Работа в существующем порту - никаких изменений брандмауэра, необходимых для автономных настроек
- Установите пользовательский MOTD Показать что-то другое в списках серверов
- Конфиденциальность Вы точно контролируете, какой информацией делятся
- Сетевая поддержка Совокупный игрок рассчитывает на нескольких серверах
Чем делятся?
По умолчанию, только основы:
- Имя сервера и MOTD
- Количество игроков (текущее и максимальное)
- Серверная версия
- Задержка ответа
Вы можете опционально включить:
- Список онлайн игроков
- Список установленных плагинов
Формат ответа
HyQuery возвращает серверную информацию в простом формате JSON:
{
"онлайн": правда,
"Игроки": {
"онлайн": 42,
"макс": 100
?
"версия": "1.0.0",
"Мотд": {
«Добро пожаловать на мой сервер!»
«Добро пожаловать на мой сервер!»
?
"Задержка": 24
?Начало работы
Автономная настройка
Для одного сервера это просто:
- Скачать плагин
- Бросьте его в свой
модпапка - Перезагрузите свой сервер
Вот так!
Настройка сети
Если вы управляете сетью с несколькими серверами (например, лобби и несколькими мини-серверами), HyQuery поддерживает агрегирование количества игроков по всей сети. Это позволяет спискам серверов точно отображать общую численность сети.
Примечание: Наша текущая сборка поддерживает однохабовые сети. В ближайшее время появится поддержка Multi-Hub.
Как это работает
Функция сети использует основную / рабочую архитектуру. Ваш сервер концентратора действует как основной и получает обновления подсчета игроков со всех ваших рабочих серверов (мини-игры, гейммоды и т. Д.). При запросе первичный агрегирует все связанные данные работника в один ответ.
1. Установка на всех серверах
Скачать HyQuery и разместить его в мод папка на всех серверах в вашей сети (хаб и рабочие).
2.Настройка вашего сервера (первичная)
На вашем сервере концентратора настройте плагин в качестве основного узла:
{
"Включено": правда,
"ShowPlayerList": правда,
«ShowPlugins» — ложный
"UseCustomMotd": ложный,
"customMotd": "Моя сеть",
"Сеть": {
"Включено": правда,
"роль": "первичная",
"WorkerTimeoutSeconds": 30,
"Работники":
{ "id": "minigame-1", "key": "your-secret-key"},
{ "id": "minigame-2", "key": "your-secret-key"}
]
?
?3. Настройка ваших рабочих серверов
На ваших серверах мини-игры / гейммода настройте каждый из них как рабочий:
{
"Включено": правда,
"ShowPlayerList": правда,
«ShowPlugins» — ложный
"UseCustomMotd": правда,
"customMotd": "Minigame Server",
"Сеть": {
"Включено": правда,
"роль": "рабочий",
"id": "minigame-1",
«primaryHost»: «lobby.example.com»,
"Первичный Порт": 5520,
"ключ": "ваш секретный ключ",
«Обновление IntervalSeconds»: 5
?
?4. Откройте порт
Обязательно откройте порт HyQuery (по умолчанию: 5520) на сервере концентратора, чтобы он мог запрашиваться извне и получать обновления от сотрудников.
кастомизация
Если вы хотите изменить вещи, отредактируйте Моды/HyQuery/config.json:
- Включите или выключите запрос
- Показать или скрыть имена игроков
- Показать или скрыть плагины
- Установите пользовательский MOTD с цветовыми кодами
- Ограничение скорости и кэширование
- Включить сетевой режим для многосерверных настроек
Советы
Отладка сетевого режима
Настройка logStatusОбновления то истинный Настройка вашей сети. Это выводит на консоль всякий раз, когда отправляются или принимаются обновления. Как только все сработает, переключите его обратно на ложный Уменьшить консольный спам.
Поддержка Wildcard
Вы можете использовать wildcards для рабочих идентификаторов. определять мини-игры* в вашей основной конфигурации, а затем настроить отдельные серверы как Мини-игра-1, Мини-игра-2и т.д. с одинаковым общим ключом. Первичный будет принимать обновления от всех соответствующих работников.
Проверьте свою настройку
Вы можете использовать проверку состояния сервера на Hyvote, чтобы убедиться, что HyQuery работает правильно на вашем сервере.
Работать с
Запуск списка серверов? Свяжитесь с Discord, чтобы добавить.
Лицензия
MIT - используйте его, как вам нравится!
Нужна помощь? предрасположенность
Присоединяйтесь к нам на Discord для помощи в настройке, сообщений об ошибках или просто для общения с другими владельцами серверов.
Показать оригинальное описание (English)
HyQuery
Let server lists show your server's status - players online, MOTD, and more!
What is HyQuery?
HyQuery is a server query protocol developed specifically for Hytale servers. Once installed, server lists and monitoring tools can automatically display your player count, server name, and other details - no manual updates needed!
Whether you're building a server listing website, a Discord bot, or a server management tool, HyQuery provides a standardized way to get server information.
HyQuery is the standard implementation for most Hytale server lists.
Why HyQuery?
- Install and forget — works out of the box, no configuration required
- Works on your existing port — no firewall changes needed for standalone setups
- Set a custom MOTD — show something different on server lists
- Privacy friendly — you control exactly what info is shared
- Network support — aggregate player counts across multiple servers
What gets shared?
By default, just the basics:
- Server name and MOTD
- Player count (current and max)
- Server version
- Response latency
You can optionally enable:
- List of online players
- List of installed plugins
Response Format
HyQuery returns server information in a simple JSON format:
{
"online": true,
"players": {
"online": 42,
"max": 100
},
"version": "1.0.0",
"motd": {
"raw": "Welcome to My Server!",
"clean": "Welcome to My Server!"
},
"latency": 24
}Getting Started
Standalone Setup
For a single server, it's as simple as:
- Download the plugin
- Drop it in your
modsfolder - Restart your server
That's it!
Network Setup
If you're running a network with multiple servers (such as a lobby and several minigame servers), HyQuery supports aggregating player counts across your entire network. This allows server lists to display your total network population accurately.
Note: Our current build supports single-hub networks. Multi-hub support is coming soon.
How It Works
The network feature uses a primary/worker architecture. Your hub server acts as the primary and receives player count updates from all your worker servers (minigames, gamemodes, etc.). When queried, the primary aggregates all connected worker data into a single response.
1. Install on All Servers
Download HyQuery and place it in the mods folder on all servers in your network (hub and workers).
2. Configure Your Hub Server (Primary)
On your hub server, configure the plugin as the primary node:
{
"enabled": true,
"showPlayerList": true,
"showPlugins": false,
"useCustomMotd": false,
"customMotd": "My Network",
"network": {
"enabled": true,
"role": "primary",
"workerTimeoutSeconds": 30,
"workers": [
{ "id": "minigame-1", "key": "your-secret-key" },
{ "id": "minigame-2", "key": "your-secret-key" }
]
}
}3. Configure Your Worker Servers
On your minigame/gamemode servers, configure each as a worker:
{
"enabled": true,
"showPlayerList": true,
"showPlugins": false,
"useCustomMotd": true,
"customMotd": "Minigame Server",
"network": {
"enabled": true,
"role": "worker",
"id": "minigame-1",
"primaryHost": "lobby.example.com",
"primaryPort": 5520,
"key": "your-secret-key",
"updateIntervalSeconds": 5
}
}4. Open the Port
Make sure to open the HyQuery port (default: 5520) on your hub server so it can be queried externally and receive updates from workers.
Customisation
If you want to tweak things, edit mods/HyQuery/config.json:
- Turn the query on or off
- Show or hide player names
- Show or hide plugins
- Set a custom MOTD with colour codes
- Configure rate limiting and caching
- Enable network mode for multi-server setups
Tips
Debugging Network Mode
Set logStatusUpdates to true while configuring your network. This outputs to the console whenever updates are sent or received. Once everything is working, switch it back to false to reduce console spam.
Wildcard Support
You can use wildcards for worker IDs. Define minigame-* in your primary config, then configure individual servers as minigame-1, minigame-2, etc. with the same shared key. The primary will accept updates from all matching workers.
Test Your Setup
You can use the Server Status checker on Hyvote verify HyQuery is working correctly on your server.
Works With
Running a server list? Get in touch on Discord to be added.
License
MIT - use it however you like!
Need a hand? 💬
Join us on Discord for setup help, bug reports, or just to chat with other server owners.
