Redeem

Redeem

Redeem is a configurable reward redemption system developed exclusively for Valheim dedicated servers.

Features

• Server-authoritative system — redemption data and validation are handled on the server.
• Code-based reward system — players can redeem item packages using unique codes.

Usage

• 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.
• The administrator defines item packages in packages.yml, which serve as the reference for all available rewards.
• 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.
• The administrator must then provide a valid code to the player by any desired method, such as an event reward, purchase reward, manual distribution, or private message.
• Active codes in code.active.yml can be redeemed by players using the chat command /redeem.
• When a code is successfully redeemed, the server delivers the configured items directly to the player’s inventory.
• The used code is then removed from code.active.yml and recorded in code.claimed.yml, ensuring full history and traceability of all redemptions.

File Examples

Example package (packages.yml)

Packages:

• Id: starter

Items:

• Prefab: Coins, Amount: 500
• Prefab: Wood, Amount: 100
• Prefab: Stone, Amount: 100

• Id: vip_bundle

Items:

• Prefab: Coins, Amount: 5000
• Prefab: Bronze, Amount: 20
• Prefab: SwordIron, Amount: 1, Quality: 3

Example code (code.insert.yml or code.active.yml)

Codes:

• Code: ABCD-1234-START

Package: starter

• Code: ABCD-2345-START

Package: starter

• Code: ABCD-3456-START

Package: starter

• Code: VIP-ONLY-9999

Package: vip_bundle

• Code: VIP-ONLY-8888

Package: vip_bundle

• Code: VIP-ONLY-7777

Package: vip_bundle

Commands

| Command | Description |

|------------------|------------------------------------------------------|

| /redeem | Redeems the items associated with the provided code. |

Installation (manual)

• Place the Redeem.dll file into the BepInEx\plugins\ folder.
• On first launch, the mod will automatically create the configuration folder on the server only.