Redeem+

Overview

Redeem+ lets server owners run giveaways, starter rewards, events, and promotions using redeemable codes. Players enter codes through an in-game UI, while admins manage codes, limits, rewards, console commands, and Discord logging through an admin interface.

Each code supports configurable usage limits, one-time redemption per player, item rewards, optional console commands executed as the server, and automatic Discord webhook logs for every redemption. All data is persisted to JSON, making Redeem+ safe across restarts and updates.

Core features

• Code redemption system – Players redeem codes via a clean in-game UI
• Admin code management – Create, edit, and delete codes through an admin UI
• Usage limits – Set codes to single-use, limited-use, or unlimited
• One-time per player – Each player can redeem a specific code only once
• Item rewards – Give any Hytale item with configurable quantities
• Console commands – Optional commands executed as console on redemption
• Persistent storage – Codes, usage counts, and player tracking saved to JSON
• Discord logging – Optional webhook logging for redeemed codes

Player features

• Simple redemption UI – Enter a code and claim rewards instantly
• Clear feedback – Success and error messages for all redemption outcomes

Admin features

• Admin UI – Manage codes without editing files
• Update-safe – Editing a code preserves existing redemption counts
• Permission-based access – Admin features protected by permission nodes

1. Place the Redeem+ JAR file into your Hytale server's plugins or mods folder.
2. Restart the server to generate the default configuration files.
3. Configure your Discord webhook URL (optional) in /Hyronix_RedeemPlus/config.json.
4. Use /redeem admin (with the appropriate permission) to create your first redemption code.

Player usage

1. Run /redeem to open the redemption UI
2. Enter a redemption code (case-insensitive)
3. Click REDEEM
4. Rewards are added to your inventory
5. An error message is shown if the code is invalid or unavailable

Admin usage – Code management

1. Run /redeem admin (permission: redeem.admin)
2. Create or update a code with the following fields:
• Code – The exact string players must enter (stored in uppercase)
• Max redemptions – Total number of times the code can be redeemed (use 0 for unlimited)
• Rewards – Semicolon-separated format: ItemId:Quantity; ItemId2:Quantity
3. If a code already exists, it will be updated while preserving existing redemption counts and player data.

Reward format examples

Ingredient_Bar_Adamantite:1; Ingredient_Bar_Mithril:2
Ingredient_Bar_Adamantite:1; Ingredient_Bar_Mithril:2; Ingredient_Bar_Cobalt:3

Console commands (optional)

Admins may define console commands that execute when a code is redeemed. Commands are semicolon-separated and execute as console (admin privileges).

Placeholders:

• @p or @s – Player name
• <uuid> – Player UUID

Examples:

money give @p 1000; say @p redeemed a code!
say @p redeemed a code FOR THE FIRST TIME!

Existing codes list

The admin UI displays:

• Code name
• Current usage
• Maximum usage
• Number of unique players who redeemed the code

Example: WELCOME — 3/10 uses (3 players)

Error messages

Players

• Invalid or unknown code
• You have already redeemed this code
• This code has reached its redemption limit
• Please enter a code
• Code redeemed, but inventory was full

Admins

• You don't have permission to use admin redemption
• Enter a code
• Max redemptions must be a number (0 = unlimited)
• Add at least one reward or console command

Data storage

Redeem+ stores its data in the following locations:

• Codes – /Hyronix_RedeemPlus/codes.json
• Configuration – /Hyronix_RedeemPlus/config.json

Files are automatically created and updated when codes are modified or redeemed.

Discord webhook logging

Redeem+ can send redemption logs to Discord. Configure your webhook URL in /Hyronix_RedeemPlus/config.json:

{
  "discordWebhookUrl": "https://discord.com/api/webhooks/YOUR_WEBHOOK_URL"
}

Logged information:

• Player name
• Redeemed code
• Rewards received

If the webhook URL is empty or invalid, redemptions will still function normally.

Guidelines

• Use clear, memorable codes
• Avoid spaces (codes are normalized to uppercase)
• Use valid Hytale item IDs for rewards
• Set reasonable redemption limits
• Each player can redeem a code only once
• Updating a code does not reset existing usage data