> For the complete documentation index, see [llms.txt](https://docs.cozycrafters.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cozycrafters.net/plugin-docs/cozyrewards.md).

# CozyRewards

### What It Does

CozyRewards is a server rewards plugin for timed reward menus, reward pouches, and command vouchers.

Players can open a rewards menu, claim configured timed rewards, redeem vouchers, and open pouches. Admins can give pouches and vouchers, reset timed reward cooldowns, reload reward files, and manage voucher definitions with commands.

### Main Features

<table><thead><tr><th width="192.046875">Feature</th><th>What It Does</th></tr></thead><tbody><tr><td>Rewards menu</td><td>Opens a GUI where players can claim configured timed rewards.</td></tr><tr><td>Timed rewards</td><td>Supports configured rewards with cooldowns, including the bundled hourly, daily, and weekly examples.</td></tr><tr><td>Streak rewards</td><td>Timed rewards can use progressive streak tiers when enabled in <code>daily.yml</code>.</td></tr><tr><td>Reward pouches</td><td>Gives players physical pouches that can reward Vault money, PlayerPoints, or vanilla XP.</td></tr><tr><td>Command vouchers</td><td>Gives players physical vouchers that run configured console commands when redeemed.</td></tr><tr><td>Claim broadcasts</td><td>Can announce successful timed reward claims, with optional milestone messages.</td></tr><tr><td>Reward reminders</td><td>Can remind online players when timed rewards are claimable.</td></tr><tr><td>Vote links menu</td><td>Can show configured vote links from the rewards GUI. Vote processing and vote rewards are not handled by CozyRewards.</td></tr></tbody></table>

### Basic Admin Workflow

1. Configure timed rewards in `daily.yml`.
2. Configure pouches in `pouches.yml` if the server uses reward pouches.
3. Configure vouchers in `vouchers.yml`, or create voucher drafts with admin commands.
4. Give players pouches or vouchers with admin commands when needed.
5. Use `/rewardsadmin daily reset <player> [reward-id]` to reset reward cooldowns.
6. Use `/rewardsadmin reload` after changing the plugin YAML files.

### Notes

* `/rewards` opens the player rewards menu. `/reward` and `/daily` are aliases.
* Players need `cozyrewards.use` to open the menu and redeem pouches or vouchers. This permission defaults to everyone.
* Admin tools use `cozyrewards.admin`, which defaults to operators.
* Pouches that use `VAULT` require Vault and a compatible economy plugin.
* Pouches that use `PLAYERPOINTS` require PlayerPoints.
* PlaceholderAPI, CozyStats, and Oraxen are listed as optional soft dependencies.
* Oraxen item support is available for configured GUI icons, pouches, and vouchers when Oraxen is present.
* Vote links can be displayed, but CozyRewards does not process votes or grant vote rewards by itself.
* Per-link vote permissions can be configured in `daily.yml`, but no specific vote permission nodes are bundled by default.

### Common Use Cases

<table><thead><tr><th width="286.21875">Use Case</th><th>How Admins Use CozyRewards</th></tr></thead><tbody><tr><td>Let players claim regular rewards</td><td>Configure timed rewards, then have players use <code>/rewards</code>.</td></tr><tr><td>Give a player a reward pouch</td><td>Use <code>/pouch give &#x3C;player> &#x3C;pouch-id> [amount]</code>.</td></tr><tr><td>Give a player a command voucher</td><td>Use <code>/voucher give &#x3C;player> &#x3C;voucher-id> [amount]</code>.</td></tr><tr><td>Reset a player's timed reward</td><td>Use <code>/rewardsadmin daily reset &#x3C;player> [reward-id]</code>.</td></tr><tr><td>Reload reward settings</td><td>Use <code>/rewardsadmin reload</code>.</td></tr><tr><td>Let players mute claim broadcasts</td><td>Players can use <code>/rewards broadcasts</code>.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.cozycrafters.net/plugin-docs/cozyrewards.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.