Eranio
Color theme

Overview, installation & commands

Eranio Published on: 14. October 2026

StreamBridge (Hytale): Overview, installation & commands

StreamBridge-Hytale is the Hytale server plugin that connects your Hytale server to a streamer panel. Viewers use it to trigger actions directly in the game via TikTok gifts or Twitch channel points. This guide is for operators of their own Hytale server, not for viewers.


How it works

The plugin periodically asks the panel for new actions (HTTP polling), your server does not need to be reachable from the outside.

  • Protocol: HTTPS (POST requests, JSON)
  • Endpoint: set in the configuration, pre-filled by the panel it was downloaded from
  • Authentication: Bearer token in the HTTP header, which you get from the panel
  • Data transfer: the plugin sends a snapshot of current player data (name, world, health, game mode) and receives a list of actions to execute and the viewer_control block (for which players viewer control should remove hostile creatures within which radius)
  • Version identification: the plugin sends its version in the User-Agent (StreamBridge/<version>) for compatibility checks

Installation

  1. Download the current version (StreamBridge-Hytale-1.7.1.jar) and place it in your Hytale server's plugin folder.
  2. Start the server once so the plugin creates the config.json file in the plugin folder.
  3. Enter the authentication token from your panel into config.json and reload the configuration (/sb reload) or restart the server.

Configuration (config.json)

Field Type Default Description
url String (pre-filled by the panel) The API address of the panel this plugin stays in contact with
token String empty Your secret authentication token
pollIntervalMs Number 1000 Interval between checks in milliseconds. Minimum: 500
paused Boolean false When active, no actions from the panel are executed
showTitle Boolean true Whether title messages are shown in-game
language String de Language of the server command output (de or en)

Server commands

All commands run through the base command /streambridge (short form: /sb).

Command Effect
/sb status Shows the connection status to the panel (connected/not connected), the current error (if any), and whether interventions are active (running) or paused (paused)
/sb pause Immediately pauses all incoming actions from the panel
/sb resume Re-enables processing of actions
/sb reload Reloads config.json and rebuilds the connection to the panel
sb test <player> <action> [name=value ...] Console only: runs an action at once without the panel, e.g. sb test Steve steer direction=left strength=2. The result (test steer ok or test steer fail <reason>) is written to the server log
`sb clear <radius off>`
sb calibrate <setting> <number> Console only: tunes viewer control until the next restart. side, turn, pitch with 1 or -1 flip left/right, turning or up/down. speed, steps, interval (step length, step count, gap in ms), jump, jumpsteps, turnsteps, edge (distance of the edge check), minescale (hit strength when mining, 1 = like a player) and mineinterval (gap between hits in ms)
/live For all players: shows who is currently live (platform, duration, viewer count, clickable link)
/live hud on / /live hud off For all players: shows or hides the live sidebar on the right for the current session. Only applies while the player is online, turns back on after the next login

Command output is shown in the language set in language.

Live display in-game

From version 1.7.1 the plugin automatically shows when one of the streamers registered on your panel goes live:

  • Chat announcement: When a live starts (not on every poll), all players on the server get a chat message with a clickable link.
  • Live sidebar: A narrow card on the right edge of the screen, shown as long as at least one streamer is live. Shows platform, name, duration and viewer count for each streamer. If the viewing player is themselves the live streamer, their own row is marked accordingly.
  • /live: Lists every currently live streamer with platform, duration, viewer count and link.

Each player can hide the sidebar for their own session with /live hud off and show it again with /live hud on. The chat announcement and /live are unaffected by this. On the panel, the Live display in-game switch on the Hytale page controls whether your server gets these features at all.

If an error occurs while building the sidebar, the plugin only disables the sidebar (a one-time warning appears in the server log); the chat announcement and /live keep working regardless.

Compatibility

  • Requires the Hytale Server API (uses Universe, World, PlayerRef and other components)
  • The version number is read automatically from the plugin manifest, fallback value 1.0.0

FAQ

Does my server need to be reachable from the outside? No, the plugin actively polls the panel itself, no incoming connection is needed.

Where do I get the token? In your streamer panel, on the Hytale page, where you set up the connection to your server.

How do I know if the connection is up? With /sb status. The connection only counts as active if the last successful communication was less than 15 seconds ago.