JHS-Votifier

JHS-Votifier

JHS-Votifier is a modern, secure Votifier plugin for Hytale that allows voting websites to notify your server when players vote, automatically rewarding players, and encouraging engagement.

Designed specifically for Hytale, this plugin supports multiple vote protocols, rich in-game messaging, and seamless compatibility with server list websites.

Quick Start: https://joinhytaleservers.com/how-to-install-votifier-for-hytale

🆕 What’s New in [1.0.4] - 2026-01-27

Added

Randomized Weighted Rewards

New randomRewards system that picks one reward per vote based on configurable weights.

Each reward entry includes:

name

weight

commands

Independent randomRewardsEnabled toggle (disabled by default)

Can be used alongside or instead of fixed commands rewards

Safe Config Migration

Configs now merge new fields without overwriting existing user data.

All config files use JSON-level merging on startup

New fields are added automatically

Existing values are never modified

Changed

WebServer is now optional

The plugin loads without Nitrado:WebServer. HTTP endpoints activate only when the WebServer is present.

Removed deprecated reward options

The following options were removed to simplify configuration:

perService

randomRewardsPerService

✨ Features

🔌 Multi-Protocol Support

Votifier V1 (RSA encryption)

Votifier V2 (HMAC / token-based)

HTTP POST endpoints (via WebServer plugin, token-secured)

🎁 Automatic Vote Rewards

Execute commands when players vote

Optional per-service rewards

💬 Player Messaging

Global vote broadcast messages

Private thank-you messages

Scheduled vote reminders

Optional on-screen popup notifications (Hytale native UI)

🖥 Native Popup Notifications (1.0.1+)

Uses Hytale’s built-in on-screen popup system

Works alongside chat messages or independently

Per-notification toggles: chatEnabled and popupEnabled

Configurable popup styles: Success (green), Warning (yellow), Danger (red), Default

Popup title and description support TaleMessage formatting and placeholders

📸 Popup Examples

🧭 Custom Vote Interface

Clickable /vote GUI menu

Clickable vote links in chat

🌐 Server List Compatibility

UDP query protocol for server status polling

🎨 Rich Text Formatting

Full TaleMessage support (colors, gradients, clickable links)

🧑‍💻 Developer Friendly

Fires a VoteEvent for custom integrations

📦 Installation

Download the latest JHS-Votifier JAR

Place it in your server’s mods/ directory

Start the server to generate default configuration files

Configure your preferred vote protocol(s)

Restart the server or run /votereload

🧾 Commands

Command Description

/vote Opens the vote menu and/or sends vote links

/testvote <player> [service] Fires a test vote (no rewards) (Admin Command)

/votifieradmin status View protocol and listener status (Admin Command)

/votifieradmin reload Reload configuration files (Admin Command)

📸 Command Examples

🧩 Example Configuration

Below is a basic example configuration showing a common setup using Votifier V2 with vote rewards and a /vote command.

This configuration works out-of-the-box for most servers.

config.json (Main Configuration)

{ "debug": false, "keyPath": "keys", "messages": { "voteBroadcast": [ "<gradient:blue:aqua><bold>[ VOTE ]</bold></gradient> <green>%player%</green> <white>voted on</white> <gold>%service%</gold><white>!</white>", "<gray>Use <aqua>/vote</aqua> to vote and earn rewards!</gray>" ], "votePrivate": [ "<gradient:gold:yellow>----------------------</gradient>", "<green><bold>Thank you for voting!</bold></green>", "<white>Your vote on <aqua>%service%</aqua> was received.</white>", "<gray>Rewards have been applied to your account.</gray>", "<gradient:gold:yellow>----------------------</gradient>" ], "voteReminder": [ "<gradient:gold:orange>----------------------</gradient>", "<yellow><bold>Don't forget to vote!</bold></yellow>", "<white>Support our server and earn rewards!</white>", "<gray>Type <aqua>/vote</aqua> to see vote links.</gray>", "<gradient:gold:orange>----------------------</gradient>" ], "reminderIntervalMinutes": 1 }, "rewards": { "enabled": true, "commands": [ "# Example commands (remove # to enable):", "# give %player% diamond 1", "# give %player% emerald 5", "# experience add %player% 100" ], "perService": { "TopHytaleServers": [ "# Commands for TopHytaleServers votes:", "# give %player% gold_ingot 5" ], "HytaleServerList": [ "# Commands for HytaleServerList votes:", "# give %player% diamond 2" ] } }, "voteCommand": { "openCustomGui": true, "sendChatMessage": true, "chatHeader": [ "<gray>--------------- <gold><bold>Vote Links</bold></gold> ---------------</gray>", "<white>Click a link below to vote and earn rewards!</white>" ], "chatFooter": [ "<gray>------------------------------------------</gray>" ], "chatLinkTemplate": "<gold>[<yellow>#%id%</yellow>]</gold> <yellow><click:%link%>%name% <bold>(Click to Vote)</bold></click></yellow>" }, "voteLinks": [ { "serviceName": "JoinHytaleServers", "link": "https://joinhytaleservers.com/" } ] }

🔔 Popup Notifications Configuration (1.0.1+)

JHS-Votifier supports native on-screen popups using Hytale’s UI system. Each notification type can independently enable chat messages and popups.

Example notifications config

{ "notifications": { "voteBroadcast": { "chatEnabled": true, "popupEnabled": true, "popupStyle": "Success", "popupTitle": "<gold>Vote Received!</gold>", "popupDescription": "<green>%player%</green> voted on <aqua>%service%</aqua>" }, "voterNotify": { "chatEnabled": true, "popupEnabled": true, "popupStyle": "Success", "popupTitle": "<green>Thank You!</green>", "popupDescription": "Your vote on <aqua>%service%</aqua> was received!" }, "reminder": { "chatEnabled": true, "popupEnabled": false, "popupStyle": "Warning", "popupTitle": "<yellow>Vote Reminder</yellow>", "popupDescription": "Don't forget to <aqua>/vote</aqua> for rewards!" } } }

🔐 HTTP Token Security (1.0.1+)

HTTP vote endpoints now use a dedicated token, separate from the V2 TCP token.

Token is auto-generated on first startup

Stored in http_config.json

Can be regenerated by deleting http_config.json and restarting

Optional per-service HTTP tokens are supported

🔐 Permissions

Permission Description

jhs.votifier.admin Access to all admin commands

🔒 Security

RSA encryption for V1 protocol

Token-based HMAC authentication for V2

Cryptographically secure, auto-generated keys

Optional per-service tokens

Test votes are isolated (no rewards or broadcasts)

🌐 Protocol Support

Protocol Supported

Votifier V1 (RSA) ✅

Votifier V2 (HMAC) ✅

HTTP POST ✅

UDP Query ✅

🔗 HTTP Endpoints

Endpoint Method Purpose

/JHS/Votifier/vote POST Receive vote notifications

/JHS/Votifier/status GET Health check

/JHS/Votifier/test GET Debug testing

🧱 Dependencies & Credits

JHS-Votifier is designed to work out-of-the-box with no required external dependencies.

Bundled Libraries

TaleMessage

Used for rich text formatting (colors, gradients, clickable links).

➜ https://www.curseforge.com/hytale/mods/talemessage

Optional Dependencies

Nitrado WebServer

Required only if you want to receive votes via HTTP POST endpoints.

➜ https://www.curseforge.com/hytale/mods/nitrado-webserver

If not installed, simply disable HTTP support in http_config.json.

Minimal Setup

No additional plugins required.

Supports Votifier V1 and V2 over TCP by default.

Full Setup

Install Nitrado WebServer to enable HTTP-based voting.

🛠 For Developers

JHS-Votifier fires a VoteEvent that other plugins can subscribe to, allowing custom behavior when votes are received.

Supports standard Votifier vote-sending libraries and custom integrations.

🧪 Troubleshooting

Ensure TCP port 8192 is open

Verify protocol status using /votifieradmin status

Enable debug: true for detailed logging

Restart the server after protocol enable/disable changes

🆘 Support

Need help, found a bug, or have a feature request?

Join the official JHS Discord for support and updates:

👉 https://discord.gg/KPzSCm83Km 👉 https://joinhytaleservers.com/how-to-install-votifier-for-hytale

📜 License

MIT License