CurseForge · Hytale mod

Nitrado WebServer

A base plugin for the game Hytale, allowing other Hytale plugins to serve web-based content.

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which Nitrado WebServer release should I use?

Updated last month

We could not find enough file information to pick a stable Hytale setup for Nitrado WebServer.

Where it goes

Where should Nitrado WebServer be installed in Hytale?

Do not install it as a separate client mod. Enable it on the world host—the local server in singleplayer or the dedicated server in multiplayer.

Separate client mod Not supported

World host / dedicated server Required

Mod system for this release Built-in Hytale mod system

Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

Put Hytale mods on the world host or dedicated server. Singleplayer runs a local server too; Hytale does not use separate client mods.

Read the Hytale installation guide

What else does Nitrado WebServer need?

Choose a release before relying on this list.

This file does not give us a dependency list. Check the creator notes before installing.

This file does not list any required or optional project dependencies. Check the creator notes before changing an existing world.

Before you install it

Add Nitrado WebServer without breaking your instance.

We could not pick a file, so treat this as a checklist—not a compatibility promise.

01
Stick to this file

We could not pick a stable file here. Check the game version and loader on the official project page before installing anything.
02
Bring the mods it needs

This file does not give us a dependency list. Check the creator notes before installing.
03
Enable it on the world host

Do not install it as a separate client mod. Enable it on the world host—the local server in singleplayer or the dedicated server in multiplayer.
04
Pick the file you checked

There is no download page for this exact file. Open the project page in Resources and choose the matching release there.

About this project

What does Nitrado WebServer add?

Hytale WebServer Plugin

A base plugin for the game Hytale, allowing other Hytale plugins to serve web-based content.

Overview

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.

This plugin provides a common solution for plugin developers, and solves 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.http are used.

Quick Start

Installation

Copy the plugin JAR file into your server's mods/ folder. The web server binds to the game server's port +3 by default.

Basic Configuration

Create mods/Nitrado_WebServer/config.json to customize settings:

{
  "BindHost": "127.0.0.1",
  "BindPort": 7003
}

Documentation

Server Administrator Guide - Installation, TLS configuration, authentication setup, and service account management.
Plugin Developer Guide - Integrating your plugins with WebServer, registering routes, and handling permissions.

Project description from CurseForge.

Recent files