**Author:** RajaAditya **Website:** [rajaaditya.my.id](https://rajaaditya.my.id) **Version:** 1.0 **API:** Paper 1.21.x --- ## Warning — GUI Status The GUI is currently under development with some unfixed bugs. | Feature | Status | |---------|--------| | Main GUI | Working — can be opened | | Sub GUIs (Commands, Expires, Max Players) | Buggy — clicks not responding | **Temporary workaround:** Use `/redeem create` to create a code, then edit rewards directly in `codes.yml` using a text editor or hosting panel. --- ## Features - Create redeem codes via commands - Set expiry duration in hours, or unlimited (`0` = unlimited) - Set player usage limit, or unlimited (`0` = unlimited) - Custom rewards — supports any console command - Auto cleanup — automatically removes expired codes - Permission system for secure access control - Fully configurable messages ## Commands | Command | Description | Permission | |---------|-------------|------------| | `/redeem

` | Redeem a code | `coderedeem.use` |
| `/redeem create   ` | Create a new code | `coderedeem.admin` |
| `/redeem delete ` | Delete a code | `coderedeem.admin` |
| `/redeem list` | List all active codes | `coderedeem.admin` |
| `/redeem reload` | Reload configuration | `coderedeem.admin` |
| `/redeem edit ` | Open edit GUI *(buggy)* | `coderedeem.edit` |

### Create Code Examples

```
/redeem create SUMMER2024 24 50
```
Creates code `SUMMER2024` — valid for 24 hours, usable by up to 50 players.

```
/redeem create WELCOME 168 100
```
Creates code `WELCOME` — valid for 168 hours (7 days), usable by up to 100 players.

```
/redeem create UNLIMITED 0 0
```
Creates code `UNLIMITED` — never expires, unlimited players.

---

## Permissions

| Permission | Default | Description |
|------------|---------|-------------|
| `coderedeem.use` | `true` | Use `/redeem ` |
| `coderedeem.admin` | `op` | Full access to all admin commands |
| `coderedeem.edit` | `op` | Open the edit GUI (still buggy) |
| `coderedeem.*` | `op` | All permissions |

**Example with LuckPerms:**

```
/lp user  permission set coderedeem.admin true
/lp user  permission set coderedeem.use true
```

---

## Configuration

### config.yml

```yaml
prefix: "§8[§6CodeRedeem§8]"

messages:
  code-created:       "§aCode %code% created successfully!"
  code-deleted:       "§aCode %code% deleted successfully!"
  redeem-success:     "§aSuccessfully redeemed code! Rewards given."
  config-reloaded:    "§aConfig reloaded successfully!"
  code-not-found:     "§cRedeem code not found!"
  code-expired:       "§cCode has expired!"
  code-max-player:    "§cCode has reached maximum player limit!"
  already-redeemed:   "§cYou have already used this code!"
  no-permission:      "§cYou don't have permission!"
  invalid-arguments:  "§cInvalid command usage!"
  code-info:          "§eDuration: §6%duration% hours | §eMax Players: §6%max_players%"
  code-list:          "§eActive codes: §6%codes%"
  edit-reward-info:   "§bEdit rewards in codes.yml for custom rewards!"
  enter-custom-value: "§bPlease enter custom value in chat! (Type 'cancel' to cancel)"

default-rewards:
  - "eco give %player% 100"

settings:
  auto-cleanup: true
  cleanup-interval: 10
```

### codes.yml

This file is auto-generated when you create codes. **Do not edit while the server is running.**

```yaml
:
  created: 
  duration: 
  max-players: 
  rewards:
    - "command %player%"
  used-by: []
  used-count: 0
```

**Full example:**

```yaml
SUMMER2024:
  created: 1704067200000
  duration: 24
  max-players: 50
  rewards:
    - "eco give %player% 1000"
    - "give %player% diamond 10"
    - "give %player% iron_ingot 32"
  used-by: []
  used-count: 0

WELCOME:
  created: 1704067300000
  duration: 168
  max-players: 100
  rewards:
    - "eco give %player% 500"
    - "give %player% emerald 5"
  used-by: []
  used-count: 0

UNLIMITED:
  created: 1704067400000
  duration: 0
  max-players: 0
  rewards:
    - "eco give %player% 10000"
    - "give %player% netherite_ingot 1"
  used-by: []
  used-count: 0
```

---

## Editing Rewards Manually

Since the GUI has issues, edit rewards directly in `plugins/CodeRedeem/codes.yml`.

1. Stop the server (or plan to use `/redeem reload` after)
2. Open `plugins/CodeRedeem/codes.yml`
3. Edit the `rewards:` section for the target code
4. Save the file
5. Start the server or run `/redeem reload`

---

## Reward Examples

**Economy** *(requires Vault):*

```yaml
rewards:
  - "eco give %player% 1000"
  - "cash give %player% 5000"
```

**Items:**

```yaml
rewards:
  - "give %player% diamond 10"
  - "give %player% iron_ingot 64"
  - "give %player% enchanted_golden_apple 1"
```

**Permissions** *(requires LuckPerms):*

```yaml
rewards:
  - "lp user %player% permission set vip"
  - "manuadd %player% premium"
```

**Effects:**

```yaml
rewards:
  - "effect give %player% strength 300 1"
  - "effect give %player% speed 600 2"
```

**Broadcast:**

```yaml
rewards:
  - "broadcast &a%player% just redeemed a special code!"
```

**Combined example:**

```yaml
rewards:
  - "eco give %player% 10000"
  - "give %player% diamond 5"
  - "give %player% emerald 10"
  - "lp user %player% permission set vip"
  - "broadcast &e%player% got VIP rewards!"
```

---

## Placeholders

| Placeholder | Used In | Example |
|-------------|---------|---------|
| `%player%` | Rewards | `give %player% diamond 1` |
| `%code%` | Messages | `Code %code% created` |
| `%duration%` | Messages | `Duration: %duration% hours` |
| `%max_players%` | Messages | `Max: %max_players% players` |
| `%codes%` | Messages | `Active: %codes%` |

## Troubleshooting

**Code cannot be redeemed?**
- Check if the code is still active with `/redeem list`
- Ensure the player has the `coderedeem.use` permission
- Check the console for error messages

**How to edit rewards?**
Edit manually in `plugins/CodeRedeem/codes.yml` — see [Editing Rewards Manually](#editing-rewards-manually).

**Unlimited duration or player limit?**
Set `duration: 0` or `max-players: 0` in `codes.yml`.

**Does it support Vault?**
Yes — use `eco give %player% 100` in the rewards list.

**GUI not responding?**
This is a known issue. Use manual editing in `codes.yml` as a workaround. A fix is planned for the next update.

**Plugin not working at all?**
- Confirm you are running Minecraft 1.21+ and Java 17+
- Check the console for error messages on startup

---

Ra-CodeRedeem