Hytale Plugin Setup

All Plans

Receive votes directly on your Hytale server — no port forwarding required

Overview

The VotePipe plugin uses outbound polling to fetch votes from our API. This means:

No inbound ports required — your server only makes outbound HTTPS requests
Works behind NAT, firewalls, and proxies
Available on all plans including Starter (free)
Near real-time delivery (5 second polling interval)

Two Operating Modes

VotePipe supports two modes for handling rewards:

Automatic Mode (Recommended): Configure rewards visually in the dashboard - no coding required!
Developer Mode: Handle votes programmatically with custom code for full control

See Automatic Mode Guide or Developer Mode Guide for details.

Installation

Download the VotePipe plugin JAR from Settings → Plugin
Place the JAR in your server's plugins/ folder
Start your server to generate the config file
Stop the server

Configuration

Edit plugins/votepipe/config.json:

json

{
  "token": "vpt_your_token_here",
  "poll_interval_ms": 5000,
  "enabled": true,
  "claim_timeout_ms": 5000
}

Configuration Options

Setting	Type	Default	Description
token	string	required	Plugin token from dashboard
poll_interval_ms	integer	5000	Polling interval in milliseconds (min: 5000)
enabled	boolean	true	Enable or disable the plugin
claim_timeout_ms	integer	5000	Timeout for event handlers

Generate Plugin Token

Go to Settings → Plugin
Click Generate to create a new token
Copy the token (it's only shown once!)
Paste it into your config.json

⚠️ Important: The token is only shown once when generated. Store it securely. If you lose it, you'll need to regenerate (which invalidates the old token).

Verify Connection

After configuring the plugin:

Start your server
Run /votepipe status
Check the dashboard — connection status should show 🟢 Connected