Redeem

Redeem is a configurable reward redemption system developed exclusively for Valheim dedicated servers.
The mod does not create or use configuration files on the client.

Features

• Server-exclusive mod — all configuration files are created and read only on the server.
• Code-based reward system — players can redeem item packages using unique codes.
• Raffle system — administrators can run a random giveaway that awards a code to a connected player.

---

Usage

Standard Redemption

1. When the mod is first launched, it automatically creates the Redeem_data folder inside BepInEx/config, which stores all configuration and data files used by the system.
2. The administrator defines item packages in packages.yml, which serve as the reference for all available rewards.
3. New codes are manually added to code.insert.yml. When this file is saved, the system validates the entries and automatically moves valid codes to code.active.yml.
4. Active codes in code.active.yml can be redeemed by players using the chat command /redeem <CODE>.
5. When a code is successfully redeemed, the server delivers the configured items directly to the player’s inventory.
6. The used code is then removed from code.active.yml and recorded in code.claimed.yml, ensuring full history and traceability of all redemptions.

Raffle System

1. The administrator runs the console command to start a raffle using a code from code.active.yml.
2. All connected and eligible players are automatically entered into the raffle.
3. The winner receives a private and persistent message with the awarded code.
4. The code remains saved on the character even after logout and can be viewed at any time via command.
5. Important: unclaimed raffle codes:
   • expire automatically after the configured timeout period, if timeout is enabled;
   • or are reset when the server restarts, if timeout is disabled.

---

Configuration

• ServerSync — automatically synchronizes mod settings between the server and clients.
• AllowAdmins — controls whether administrators can participate in raffles.
• PendingCodeTimeoutMinutes — defines the time (in minutes) before a pending raffle code expires.
  • If set to 0, pending codes are reset when the server restarts.

---

Commands

Player Commands

Command	Description
/redeem <CODE>	Redeems the items associated with the provided code.
/redeem.mycode	Shows all pending raffle codes linked to your character.

Admin Commands (console)

Command	Description
redeem.raffle <CODE>	Starts a raffle using the specified code.

---

Installation (manual)

1. Place the Redeem.dll file into the BepInEx\plugins\ folder on both client and server.
2. On first launch, the mod will automatically create the configuration folder on the server only.