Nitrado WebServer
A base plugin for the game Hytale, allowing other Hytale plugins to serve web-based content.
Описание
Плагин Hytale WebServer
Это базовый плагин для игры Hytale, позволяющий другим плагинам Hytale обслуживать веб-контент.
Цель этого плагина
Многие случаи использования плагинов требуют обслуживания данных через HTTP, например, для веб-хуков, живых карт или для разоблачения. Данные о подключенных игроках. Тем не менее, несколько плагинов открывают свои собственные HTTP-серверы. Соответствующие варианты использования не требуют накладных расходов и вызывают головную боль для администраторов серверов и поставщиков услуг.
Целью этого плагина является предоставление общего решения для разработчиков плагинов и решение типичных задач. требования к веб-серверам в одном месте, чтобы плагины оставались совместимыми друг с другом.
Поставщикам игрового сервера рекомендуется обнаруживать наличие этого плагина и предоставлять ему конфигурацию, которая Обеспечивает совместимость с соответствующей хостинговой платформой.
Основные характеристики
- Безопасность по умолчанию: TLS использует самоподписанные или предоставленные пользователем сертификаты, а также поддержку Получение сертификата.
- Аутентификация игроков: Игроки могут аутентифицироваться на основе своей учетной записи Hytale, позволяя использовать плагины. действовать в контексте соответствующего игрока.
- Проверка разрешений: Встроенная поддержка для выполнения проверок авторизации на основе аутентификации Разрешения игрока на сервере Hytale.
- Сервисные аккаунты (пользователи API): Разрешение владельцам серверов создавать учетные записи независимо от игрока Учетная запись, которой все еще можно управлять с помощью системы разрешений Hytale.
- Расширимость: Все важные реализации находятся за интерфейсами, так что их можно заменить.
при необходимости. Для обеспечения совместимости с другими веб-серверами, классы
jakarta.servlet.httpиспользуются.
Для полной документации, пожалуйста, посетите Репозиторий GitHub.
Показать оригинальное описание (English)
Hytale WebServer Plugin
This is a base plugin for the game Hytale, allowing other Hytale plugins to serve web-based content.
Purpose of this plugin
Many plugin use cases require serving data via HTTP, such as for webhooks, live maps, or for exposing data about the connected players. However, multiple plugins each opening their own HTTP servers for their respective use cases is unnecessary overhead, and causes headaches for server admins and service providers.
The aim of this plugin is to provide a common solution for plugin developers, and to solve typical requirements around web servers in one single place, so that plugins stay compatible with each other.
Game Server Providers are encouraged to detect the presence of this plugin, and to provide it with a configuration that ensures compatibility with their respective hosting platform.
Main Features
- Secure by default: TLS using self-signed or user-provided certificates, as well as support for certificate retrieval.
- Player Authentication: Players may authenticate based on their Hytale account, allowing plugins to act in the context of that respective player.
- Permission checks: Built-in support for performing authorization checks based on an authenticated player's permissions on the Hytale server.
- Service Accounts (API Users): Allowing server owners to create accounts independent of a player account, which can still be managed using Hytale's permission system.
- Extensibility: All important implementations are behind interfaces, so that they can be replaced
if required. To ensure intercompatibility with other web servers, classes from
jakarta.servlet.httpare used.
For the full documentation please visit the GitHub repository.
