Skip to main content
The Rewards Extension allows you to give rewards to players even when they are offline or have full inventories. Rewards are queued and can be claimed later.

Features

Deferred Claiming

Store rewards safely.

Visual GUI

Menu for claiming pending items.

Scheduling

Cron support for daily rewards.

History

Track lifetime claimed rewards.

Architecture

Entries

Definition

Reward Def: Reusable template.

Actions

Give Reward: Queue reward.
Open Menu: Claim UI.

Config

Menu Config: UI setup.

Quick Start

1. Configure Settings

Start with the configuration entry: reward_definition, reward_definition. This defines global settings for the extension.→ reward_definition → reward_definition

2. Trigger Actions

Use action entries to interact with the extension: give_reward, open_menu. Trigger them from commands, NPCs, events, or other entries.→ give_reward → open_menu

Placeholders

Prefix: %typewriter_rewards_*%
PlaceholderDescription
%typewriter_rewards_pending%Total pending count
%typewriter_rewards_pending_<id>%Count for specific ID
%typewriter_rewards_claimed_total%Lifetime claimed

Dependencies

ExtensionRequiredUsage
GUI ExtensionRequiredMenu rendering and layout system.
PlaceholderAPIOptionalFor @Placeholder fields.