🌟 RedeemCodes – Easy & Powerful Code Redemption Plugin for Minecraft

RedeemCodes is a powerful plugin that allows server administrators to create, manage, and redeem custom codes to reward players.

🔧 Features

• 🎟️ Custom Redeemable Codes – Define unlimited codes with flexible reward options.
• ⛔ Blacklist/Whitelist System – Block or allow specific players for each code.
• 🔄 Redemption Limits & Cooldowns – Set per-player or global redemption limits with cooldown timers.
• 🎨 Interactive GUI Editor – Manage codes and rewards directly in an intuitive in-game GUI.
• 🔊 Success & Error Sounds – Configurable sounds that play on successful or failed redemption.
• 🧩 Placeholder Support – Use placeholders like %player%, %uuid%, %random-min-max%, and more inside reward commands.
• 🔐 Permission-Based Access – All admin commands are fully permission protected.
• 🧠 Fully Configurable – Customize all messages, sounds, and prefix in config.yml.

🎁 Reward System

• Console Command: Rewards are assigned as console commands, creating endless possibilities without limitations.
• Placeholder Support: Supports placeholders to add custom values in commands.

🧩 Supported Placeholders

• %player% – Player's name
• %uuid% – Player's UUID
• %displayname% – Player's display name
• %world% – World name
• %random-min-max% – Random number within a range

Example reward:

- "eco give %player% %random-100-500%"

📦 Commands & Permissions

✅ Player Command

/redeem <code>

Redeem a code and claim its reward. ⤷ Permission: None (available to all players)

🔧 Admin Commands

/rc create <code>                - Create a new code
/rc remove <code>                - Remove a code
/rc reward                       - Add/Remove/View rewards
/rc sack                         - Add/Remove/View Sacks
/rc event                        - Add/Remove/Play Events
/rc list                         - List all codes
/rc redeemed <code>              - Show players who redeemed a code
/rc rewards <code>               - Show rewards attached to a code
/rc reload                       - Reload plugin configs
/rc version                      - View plugin version
/rc show <code>                  - Show details of a code
/rc redeemed <code> [page]       - View redeemed users with pagination
/rc review <message>             - Send a review or bug report to developers
/rc gui                          - Open the RedeemCodes menu interface
/rc help [page]                  - Show the help menu

⤷ Permission: redeemcodes.admin

🖥️ GUI System

The plugin includes a modern and easy-to-use GUI for code management:

• Main Menu

  • Create Code
  • Codes List
  • Admin Panel

  !RedeemCodes Menu

• Codes List GUI

  • View all available codes at a glance

  !Codeslist!

• Code Editor

  • Edit rewards, settings, and options directly in-game

  !Code editor

🛠 Example Code Setup

# ==============================================================================
#                           REDEEM CODES CONFIGURATION
# ==============================================================================
# This file contains all the redemption codes and their settings.
# You can create codes using the in-game GUI command: /rc gui
# ==============================================================================

Codes:
  # Example Code: "welcome_gift"
  # Users redeem this by typing: /redeem welcome_gift
  welcome_gift:

    # Enable or disable the code instantly.
    enabled: true

    # Permission Settings [Requires a permission plugin like LuckPerms]
    # If required is true, the player must have one of the listed permissions.
    permisson:
      required: false
      list:
        - code.redeem.welcome

    # Redemption Limits
    # Type:
    #   PLAYER -> Limits how many times a single player can redeem.
    #   CODE   -> Limits the total global uses of the code (e.g., first 10 people).
    redeem-limit:
      Type: PLAYER
      Count: 1 # Number of times allowed (Set to -1 for infinite).
      Cooldown: 0 # Cooldown in minutes between uses (0 to disable).
      Cooldown-message: "&cYou must wait %Cooldown% before redeeming again!"

    # Expiration time in seconds. -1 means it never expires.
    expire-time: -1

    # Player Data & Blacklisting
    Playerlist:
      Used: [] # Do not edit manually. Stores UUIDs of players who used the code.

      # Blacklist Control
      # Type:
      #   ENABLED  -> Players in the list CANNOT use the code.
      #   REVERSE  -> Only players in the list CAN use the code (Whitelist mode).
      #   DISABLED -> The list is ignored.
      Blacklist:
        Type: ENABLED
        List:
          - notch
          - herobrine

    # ==========================================================================
    #                                 REWARDS
    # ==========================================================================
    # The reward system allows you to mix and match different types of rewards.
    #
    # Distribution Types (rewards.type):
    #   ALL    -> The player receives EVERY reward defined below.
    #   RANDOM -> The player receives ONE reward selected randomly from all defined packs.
    #   DRAW   -> The player receives ONE reward based on a weighted chance system.
    #
    # Reward Categories:
    #   1. Commands: A list of console commands to execute.
    #   2. Sacks: A collection of items given directly to the inventory (defined in /sacks/).
    #   3. Premades: Reusable command lists defined in premades.yml.
    #   4. Events: Special visual/audio effects defined in /events/.
    #
    # Placeholders for commands:
    #   %player%      -> Player Name
    #   %uuid%        -> Player UUID
    #   %world%       -> World Name
    #   %displayname% -> Display Name
    #   %random-x-y%  -> Random number between x and y
    # ==========================================================================

    rewards:
      type: ALL

      # --- Events ---
      # Trigger visual/sound effects from files in the 'events' folder.
      events:
        - celebration # Plays 'events/celebration.yml'

      # --- Command Packs ---
      # Custom groups of commands specific to this code.
      commands:
        basic_stuff:
          - "say Welcome %player%!"
          - "give %player% apple 5"
          - "weight: 10" # Used if type is DRAW (higher weight = higher chance)

        lucky_roll:
          - "eco give %player% %random-50-100%"
          - "msg %player% &aYou got some lucky cash!"
          - "weight: 5"

      # --- Sacks ---
      # Items defined in the 'sacks' folder. Format: "sackname:weight"
      # If type is ALL, weight is ignored.
      sacks:
        - starter: 1
        - miner: 1

      # --- Premades ---
      # Reusable rewards defined in 'premades.yml'. Format: "premadename:weight"
      premades:
        - vip_rank: 1
        - money_small: 2

🔊 Configurable Sounds

sounds:
  success: ENTITY_PLAYER_LEVELUP
  failure: BLOCK_ANVIL_LAND

💬 Fully Customizable Messages

messages:
  usage: "&cUsage: /redeem <code>"
  not-exist: "&cThis code doesn't exist!"
  blacklisted: "&cYou are not allowed to redeem this code."
  already-used: "&eYou have already redeemed this code."
  redeem-success: "&aSuccessfully redeemed the code!"
  reload-success: "&aAll configuration files reloaded!"
  no-permission: "&cYou don't have permission to use this."
  code-exists: "&cCode already exists!"
  code-created: "&aCreated new code: %code%"
  code-removed: "&aRemoved code: %code%"
  reward-added: "&aAdded reward to %code% with ID %id%"
  reward-removed: "&aRemoved reward ID %id%"
  reward-not-found: "&cThat reward ID doesn't exist!"
  invalid-reward-id: "&cInvalid reward ID!"
  command-usage: "&cUsage: /redeemcodes <command> [arguments]"
  unknown-action: "&cUnknown action: %action%"
  code-disabled: "&cThis code is currently disabled."
  out-of-stock: "&cThis code is out of stock!"
  code-expired: "&cThis code has expired." 

📚 Requirements

• Minecraft 1.16.5 - 1.21.x
• Paper / Purpur

📌 Why Use RedeemCodes?

Whether you’re organizing events, giveaways, loyalty programs, or simple player rewards, RedeemCodes offers a seamless, lightweight, and customizable way to engage your server community.