Redeem+

Redeem+

Support Server – https://discord.gg/DRxwt8Qg2W

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.

---

FEATURES

Core

• 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

• Simple redemption UI – Enter a code and claim rewards instantly

• Clear feedback – Success and error messages for all redemption outcomes

Admin

• 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

---

COMMANDS

/redeem
Open the redemption UI
Permission: none

/redeem admin
Open the admin code manager UI
Permission: redeem.admin

---

PERMISSIONS

redeem.admin
Required to access the admin UI and to create, edit, or delete redemption codes.

---

PLAYER USAGE

1. Run /redeem

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

Run /redeem admin

Create or update a code

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

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

If a code already exists, it will be updated while preserving existing redemption counts and player data.

---

CONSOLE COMMANDS (OPTIONAL)

Admins may define console commands that execute when a code is redeemed.

• Commands are semicolon-separated

• Commands 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

Codes are stored in
/Hyronix_RedeemPlus/codes.json

Configuration is stored in
/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

Example
{
"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

Distribution Notice:
This mod may not be redistributed or bundled with third-party setups without clear and visible credit to Hyronix Studios and the mod name. Otherwise, redistribution is not permitted.