A vote reward plugin for Hytale servers. Listens for votes from HytaleVotifier and rewards players with configurable commands.
A vote reward plugin for Hytale servers. Listens for votes from HytaleVotifier and rewards players with configurable commands. You NEED to install HytaleVotifier for this plugin to work!
The plugin creates a `config.json` file in `plugins/HytaleVoteListener/` with the following options:
``` { "commands": [ "say %player% has voted on %service%", "give %player% WeaponStaffOnyxium" ], "broadcastVote": false, "debugMode": false } ```
| Option | Type | Description |
|---|---|---|
| commands | Array | List of commands to execute when a player votes. Supports placeholders (see below). |
| broadcastVote | Boolean | Currently unused. Use a say command in your commands list instead. |
| debugMode | Boolean | Enable verbose logging for troubleshooting. |
Use these placeholders in your commands - they will be replaced with actual values:
| Placeholder | Description |
|---|---|
| %player% | The username of the player who voted |
| %service% | The name of the voting site |
| %uuid% | The player's UUID (if available) |
| %timestamp% | When the vote was received |
| %streak% | The player's current vote streak (consecutive days) |
| %totalvotes% | The player's total lifetime votes |
| %reward% | The name of the random reward tier received |
Give players a chance to receive bonus rewards with weighted probability.
``` { "randomRewardsEnabled": true, "randomRewards": [ { "name": "common", "chance": 70.0, "commands": ["give %player% ConsumableApple 5"] }, { "name": "rare", "chance": 25.0, "commands": ["give %player% ArmorLeatherChest"] }, { "name": "legendary", "chance": 5.0, "commands": [ "give %player% WeaponSword_Legendary", "say %player% received a legendary vote reward!" ] } ] } ```
| Option | Type | Description |
|---|---|---|
| randomRewardsEnabled | Boolean | Enable or disable random rewards. |
| randomRewards | Array | List of reward tiers with weighted chances. |
| name | String | Display name for the reward tier. |
| chance | Number | Weight for this tier (does not need to sum to 100). |
| commands | Array | Commands to execute if this tier is selected. |
How chances work: The chances are weights, not percentages. If you have rewards with chances 70, 25, and 5, the total is 100, so they work out to 70%, 25%, and 5%. But if you had chances 7, 2.5, and 0.5, it would work the same way.
Reward players for voting on consecutive days.
``` { "streakBonusEnabled": true, "streakBonuses": [ { "streakDays": 3, "name": "3-day", "commands": ["give %player% ConsumablePotionHealth"] }, { "streakDays": 7, "name": "weekly", "commands": [ "give %player% ToolPickaxeIron", "say %player% has a %streak%-day vote streak!" ] }, { "streakDays": 30, "name": "monthly", "commands": ["give %player% ArmorSetRare"] } ] } ```
| Option | Type | Description |
|---|---|---|
| streakBonusEnabled | Boolean | Enable or disable streak bonuses. |
| streakBonuses | Array | List of streak milestones. |
| streakDays | Number | The exact streak day to trigger this bonus (e.g., 7 = on their 7th consecutive day). |
| name | String | Display name for this streak bonus. |
| commands | Array | Commands to execute when the player reaches this streak. |
Note: Streak bonuses trigger when the player's streak exactly matches `streakDays`. A player with a 7-day streak will receive the 7-day bonus but not the 3-day bonus on that vote.
Reward players for reaching total vote milestones.
``` { "milestoneBonusEnabled": true, "milestoneBonuses": [ { "votesRequired": 10, "name": "first-ten", "commands": ["give %player% ConsumablePotionHealth 3"] }, { "votesRequired": 50, "name": "fifty", "commands": ["give %player% WeaponBowRare"] }, { "votesRequired": 100, "name": "century", "commands": [ "give %player% MountHorseRare", "say %player% reached %totalvotes% total votes!" ] } ] } ```
| Option | Type | Description |
|---|---|---|
| milestoneBonusEnabled | Boolean | Enable or disable milestone bonuses. |
| milestoneBonuses | Array | List of vote count milestones. |
| votesRequired | Number | The exact total vote count to trigger this bonus. |
| name | String | Display name for this milestone. |
| commands | Array | Commands to execute when the player reaches this milestone. |
``` { "commands": [ "say %player% has voted on %service%", "give %player% WeaponStaffOnyxium" ], "broadcastVote": false, "debugMode": false, "randomRewardsEnabled": true, "randomRewards": [ { "name": "common", "chance": 70.0, "commands": ["give %player% ConsumableApple 5"] }, { "name": "rare", "chance": 25.0, "commands": ["give %player% ArmorLeatherChest"] }, { "name": "legendary", "chance": 5.0, "commands": ["give %player% WeaponSwordLegendary"] } ], "streakBonusEnabled": true, "streakBonuses": [ { "streakDays": 7, "name": "weekly", "commands": ["give %player% ToolPickaxeIron"] } ], "milestoneBonusEnabled": true, "milestoneBonuses": [ { "votesRequired": 100, "name": "century", "commands": ["give %player% MountHorse_Rare"] } ] } ```
If a player votes while offline, their rewards are stored and delivered automatically when they next join the server. Players can also use the `/claimvotes` command to manually claim any pending rewards.
The plugin stores data in the `plugins/HytaleVoteListener/` folder:
| File | Description |
|---|---|
| config.json | Plugin configuration |
| vote_data.json | Player vote statistics (streaks, total votes) |
| pending_rewards.json | Queued rewards for offline players |
| Command | Permission | Description |
|---|---|---|
| /claimvotes | hyvote.claimvotes | Manually claim pending vote rewards |
For issues and feature requests, please open an issue on GitHub, or contact us at https://hyvote.org.
MIT License
Copyright (c) 2026 Hyvote
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
0 Comments