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 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 from CurseForge or Modtale
Place the JAR in your server's mods/ folder
Start your server to generate the config file
Stop the server

Configuration

Edit mods/Mythlane_VotePipe/config.json:

json

{
  "token": "vpt_your_token_here",
  "api_base_url": "https://api.votepipe.com/v1",
  "poll_interval_ms": 5000,
  "claim_timeout_ms": 5000,
  "enabled": true,
  "debug": false,
  "intercept_legacy_votes": true,
  "store_buffered_votes": true
}

Core Settings

Setting	Type	Default	Description
token	string	required	Plugin token from dashboard (starts with `vpt_`)
api_base_url	string	https://api.votepipe.com/v1	VotePipe API base URL (only change for self-hosted)
poll_interval_ms	integer	5000	How often to check for new votes (min: 5000ms)
claim_timeout_ms	integer	5000	Timeout for Developer Mode event handlers (min: 1000ms)
enabled	boolean	true	Enable or disable the plugin
debug	boolean	false	Enable verbose logging for troubleshooting

Legacy Plugin Compatibility

These settings allow VotePipe to detect and intercept votes from legacy plugins (HytaleVotifier, HyVote) for migration tracking. See Compatibility Mode for details.

Setting	Type	Default	Description
intercept_legacy_votes	boolean	true	Detect HytaleVotifier/HyVote and forward votes to VotePipe for analytics
store_buffered_votes	boolean	true	Store intercepted votes locally if no token is configured yet

Tip: With intercept_legacy_votes: true, VotePipe automatically detects if HytaleVotifier or HyVote is installed and tracks those votes in your dashboard. This is useful during migration to compare vote counts between systems.

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 mods/Mythlane_VotePipe/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