[1.8.8 - 1.21.4] RedeemableCodes - Create codes your users can "/redeem"!

[1.8.8 - 1.21.4] RedeemableCodes - Create codes your users can "/redeem"! -----

Easily create custom redeemable codes this powerful & feature-packed resource!

UPDATE: 2024.12

• Addition: Support for version 1.21.4, all versions of 1.21.1.

If you are enjoying the plugin, please take some time to leave a review. They are greatly appreciated! ❤

----------, Dec 9, 2024

UPDATE: 2024.11

• Addition: Support for version 1.21.3.

If you are enjoying the plugin, please take some time to leave a review. They are greatly appreciated! ❤

----------, Nov 26, 2024

UPDATE: 2023.12

• Addition: Support for version 1.20.4.

If you are enjoying the plugin, please take some time to leave a review. They are greatly appreciated! ❤

----------, Dec 12, 2023

UPDATE: 2023.11

• Addition: Support for 1.20.2

If you are enjoying the plugin, please take some time to leave a review. They are greatly appreciated! ❤

----------, Nov 11, 2023

UPDATE: Build 38

• Addition: Support for 1.20

If you are enjoying the plugin, please take some time to leave a review. They are greatly appreciated! ❤

----------, Jun 12, 2023

UPDATE: Build 37c

• Addition: 1.19.4 Support.

----------, Mar 20, 2023

UPDATE: Build 37b

• Fix: Invalid behavior when creating a code with integers only and (or) inspecting such codes.
• Fix: Max code limit configuration key not working.

If you are enjoying the plugin, please take some time to leave a review. They are greatly appreciated! ❤

----------, Dec 11, 2022

UPDATE: Build 37a

• Fix: Perm-based codes not functioning correctly.
• Addition: Support for 1.19.1,2.

If you are enjoying the plugin, please take some time to leave a review. They are greatly appreciated! ❤

----------, Oct 2, 2022

UPDATE: Build 37

• Fix: Bulk command not showing in tab completion.
• Addition: 1.19 support.

If you are enjoying the plugin, please take some time to leave a review. They are greatly appreciated! ❤

----------, Jun 11, 2022

UPDATE: Build 36b

• Fix: Not properly reading from database the key for "enabled", causing coupons to always load in disabled.

If you are enjoying the plugin, please take some time to leave a review. They are greatly appreciated! ❤

----------, May 14, 2022

UPDATE: Build 36a

• Fix: Weird formatting for console messages.
• Fix: Error with expiration feature.
• Fix: Removed invalid uses command sound.
• Addition: Bulk command, easily create copies of existing codes and find them neatly packaged in a txt file.

If you are enjoying the plugin, please take some time to leave a review. They are greatly appreciated! ❤

----------, Apr 1, 2022

UPDATE: Build 36

• Addition: Support for 1.18.2.
• Addition: Option to strip colors from console messages.
• Change: Changed license command to debuginfo.

If you are enjoying the plugin, please take some time to leave a review. They are greatly appreciated! ❤

----------, Mar 11, 2022

UPDATE: Build 35d

• Addition: New command (/rc expiry), set expiration dates for codes.
• Addition: New command (/rc enabled), enable or disable codes.
• Addition: New command (/rc debug), enter debug mode, which ignores requisites for redemption and doesn't deplete uses.
• Addition: New placeholders for info command. {6} = enabled, {7} = used by x users, {8} = expiration date.
• Change: Codes will no longer be removed when reaching 0 uses but will be disabled instead.

If you are enjoying the plugin, please take some time to leave a review. They are greatly appreciated! ❤

----------, Mar 7, 2022

UPDATE: Build 35c

• Fix: Patch to fix Spigot's SnakeYAML comment spam issue.

If you are enjoying the plugin, please take some time to leave a review. They are greatly appreciated! ❤

----------, Feb 24, 2022

UPDATE: Build 35b

• Change: The configurable commands are now being registered as actual commands, which also makes them work with tab completion.

If you are enjoying the plugin, please take some time to leave a review. They are greatly appreciated! ❤

----------, Feb 17, 2022

UPDATE: Build 35a

• Addition: Populated plugins.yml with permissions, which allows for plugins like LuckPerms to properly tab-complete permissions. If you are updating from Build 34 or prior, find new commands/permissions here.

If you are enjoying the plugin, please take some time to leave a review. They are greatly appreciated! ❤

----------, Feb 8, 2022

UPDATE: Build 35

• Fix: Users without permission being able to view tab-completion.
• Addition: New command - "rc search [keyword]". Refer to the wiki for more information.
• Addition: The redeem logs will now contain the UUID of the user as well.

If you are enjoying the plugin, please take some time to leave a review. They are greatly appreciated! ❤

----------, Jan 30, 2022

UPDATE: Build 34 (Read Changelog)

READ ME:
I finally decided to sit down and just finish the full recode of the plugin. There won't be any changes mentioned here because there are too many. If you are going to be updating, treat this update like an entirely new plugin. You can find all the information on the main thread and on the wiki. It goes without say that you need to let a new RedeemableCodes folder generate and that you can't use your old data with this new update.

----------, Jan 25, 2022

UPDATE: Command fix

Build 33a changelog:
Fix: Fixes an issue that would display any command used, sorry for any inconvenience caused.

----------, May 6, 2020

UPDATE: Customizable redeem command

Build 33 changelog (config.yml additions required):
Addition: You can now edit the /redeem command to whatever custom command (+aliases) you want. This change has been made because it was brought to my attention that it may conflict with other commands such as MCMMO's.

Config additions: (Careful not to overwrite existing settings)

Code (Text):

settings:
# REDEEM COMMANDS MUST BE IN CAPS!
redeemCommand:
- '/REDEEM'
- '/CODEREDEEM'

----------, May 5, 2020

UPDATE: Redeem Permission, Usage Fix

Build 32 Changelog:

Addition: Added a permission for "/redeem", rc.redeem
Fix: Fixed a file separator issue that would occur on some operating systems.

----------, Feb 24, 2020

UPDATE: Small Fix

Build 32c Changelog:

Fix: Fixes an NPE error (doesn't affect usage of the command) with the force redeem command.

----------, Feb 21, 2020

UPDATE: Force Redeem Addition

Build 32b Changelog (config.yml additions required):

Addition: There is now an extra argument for the force redeem command (true/false), whether or not to respect uses per player.

e.g /forceredeem [ID] [PLAYER] [TRUE] will respect the uses per player and will not redeem the code for the player if they have already redeemed it before. (False will not respect that flag and redeem the code either way).

Add to configuration:

Code (Text):

forceRedeemCodeAlreadyRedeemed:

- '&8&m----------------------------------------------+'
- ' &e&l&oRedeemable Codes &7Error:'
- ' &8» &fYou have already redeemed this code once! (Forced Redeem)'
- '&8&m----------------------------------------------+'
forceRedeemCodeAlreadyRedeemedAdmin:
- '&8&m----------------------------------------------+'
- ' &e&l&oRedeemable Codes &7Error:'
- ' &8» &f$player has already redeemed this code!'
- ' &f(To bypass this set respectUsagePerPlayer to false)'
- '&8&m----------------------------------------------+'

----------, Feb 20, 2020

UPDATE: Bug Fixes, Forceredeem & more!

Build 32 Changelog (config.yml additions at the bottom):

Addition: You can now use "forceredeem [ID] [player]" to forcefully (bypasses all traits) run the code's commands for the user (Permission: rc.forceredeem)
Addition: You can now choose to output bulk created coupons in a .txt file. (e.g /rc copy [ID] [LENGTH] [AMOUNT] [TRUE/FALSE])
Fix: Fixed copy command's error message not including all available arguments.
Fix: Fixed duplicate messages showing when using the copy command via console.
Fix: [API] Fixed CodeRedeemEvent.java not being called.

Configuration Additions (careful not to overwrite existing settings):

Code (Text):

messages:
forceRedeemNotOnline:
- '&8&m----------------------------------------------+'
- ' &e&l&oRedeemable Codes &7Error:'
- ' &8» &fThe player $player is not online!'
- '&8&m----------------------------------------------+'
forceRedeemUsage:
- '&8&m----------------------------------------------+'
- ' &e&l&oRedeem &7Options:'
- ' &8» &f/forceredeem [code] [player]'
- ' &7(Run the codes command for a player,'
- ' &7bypasses uses, permissions etc.)'
- '&8&m----------------------------------------------+'
forceRedeem:
- '&8&m----------------------------------------------+'
- ' &e&l&oRedeemable Codes &7Success:'
- ' &8» &fYou redeemed &e$code&f! (Forced Redeem)'
- '&8&m----------------------------------------------+'
forceRedeemAdmin:
- '&8&m----------------------------------------------+'
- ' &e&l&oRedeemable Codes &7Success:'
- ' &8» &fYou forced $code''s rewards for $player!'
- '&8&m----------------------------------------------+'

----------, Feb 13, 2020

UPDATE: Plugin rebrand/recode

XCoupons has been rebranded to RedeemableCodes (Do not update if you have active servers running with an older version of this plugin).

Build 31 Changelog:

Addition: RedeemableCodesAPI.java is now available.
Addition: CodeRedeemEvent.java is now available.
Addition: New command (xcodes.setperm) that allows to set permission for code redemption (/rc setperm [ID] [PERMISSION]).
Change: Messages have been moved to config.yml.
Change: Usage logger will now also monitor: CODE CREATION/DELETION/SECURE/PERM-BASED/PERM/USES/BULK, COMMAND ADDITION/REMOVAL.
Change: The usage logger now has its own folder & creates daily logs instead of one big log.
Change: Bulk creation command now requires an extra length parameter (length of bulk codes generated).
Change: The bulk creation system now displays codes in a cleaner format and not just in the console.
Fix: Bulk creation only mirroring commands and not other attributes (uses, permissions, etc.).
Fix: Inspect command not showing uses/permission-based & permission.
Fix: List command not working through the console.
Fix: List command not working after a codes purge.
Fix: Copy command not working for non-capital codes.
Fix: Perm-Based command not working for non-capital codes.

----------, Jan 24, 2020

Custom coupon codes

Build 30 changelog:

Some saving/reloading changes have been reverted. In order to create custom coupons (e.g "/redeem santa"), your server must not be running when you are editing the coupons file. To tackle this issue, you can now input a string as the argument when creating a new coupon (e.g "/xcp new santa").
Fixed an issue with "/xcp list" sometimes showing up as empty instead of displaying the no coupons available message.

----------, Dec 12, 2019

Autosave mute option

Build 29 changelog:

Per request, I have added a new option that lets you disable autosave messages from being sent to the console as it can get spammy.
Add this to your configuration:
Code (Text):

saveToFile:
time: 5
informOP: true
informConsole: false

----------, Dec 12, 2019

Bug fixes, placeholders & more

Build 28 changelog:

Fixed an issue that would cause "/xcp reload" not to load in manually-created codes.
Fixed an issue that would sometimes not load in new codes when the autosave happens.
Placeholders that can be used in commands have been changed (look at the resource page).
You can no longer edit the message that's being sent when using "/xcp version", instead you will get a more informative message about the version and if any update is out.

----------, Dec 7, 2019

Update checker

Build 27 Changelog:

If there is an update available it'll send a message to the console as well as a message to opped players when they join the server.
Add the following code to your messages.yml
Code (Text):

versionCheck:
- ''
- '&eXCoupons is running on &a&n%version%&r&e!'
- ''

----------, Dec 3, 2019

Update: Performance Update

- The whole configurations system has been recoded.
- A massive optimization patch has been applied.
- Pastebin and MySQL have been completely removed.
- JSON from update messages has been removed.

For this update to work add the following to your config.yml:

Code (Text):

saveToFile:
time: 5
informOP: true

----------, Jul 21, 2019

UPDATE: Checksum Fix

fixes a small issue

----------, Mar 4, 2019

UPDATE: Message Fix

v2.5-b2

Code (Text):

- FIX: Fixes some minor typos.

----------, Feb 13, 2019

UPDATE: Parsing Fix

v2.5 - v2

- Fixed a parsing error some users would experience

----------, Jan 19, 2019

UPDATE: Infinite Uses, Perm-Based Tag, Permission Tag (Designed for XF/MineSync)

v2.5 (Read update notes)

Code (Text):

- ADDITION: You can now use "infinite" when setting the max coupon usages.
- ADDITION: You can now enable the "perm-based" functionality per coupon.
INFO: This system was designed to work with Xenforo/MineSync in order to allow
forum donors to claim a special (manually created) coupon. Don't forget to set
the last coupon reward (command) to a permission removal one.
- ADDITION: You can now add a "Permission: 'permission.node'" tag to coupons.
INFO: This can only be manually done by directly editing the coupons file.

Here you could view an example of this system working:

Scenario: You are syncing permissions with Xenforo and whenever
someone donates on your forum they get access to (for example): "xcoupons.donator".
You want those users to redeem their in-game perks via a coupon created by XCP.

Step 1: Manually create a new coupon including the new tags.

Example:

Coupons:
donator:
Quantity: -999 # -999 is the code for infinite amount of uses
Perm-Based: true # Perm-Based must be set to true
Permission: xcoupons.donator # Only users with this perm. node can redeem the coupon
Commands:
- 'group set %p donator'
- 'broadcast %p just redeemed donator'
- 'give %p diamond_block 16'
- 'give %p emerald_block 16'
- 'permission remove %p xcoupons.donator' # Remove the perm. so the user redeems their rank/perks once.

Step 2: Assuming someone purchased a rank and gets permissions synced with MineSync -- now, all they'd have
to do is use /redeem donator and that's it.

Note: Don't forget to save the coupons and reload the plugin!

Reset your configuration before updating!

----------, Jan 16, 2019

UPDATE: Experimental Logger

v2.4

Code (Text):

- ADDITION: Added an experimental usage logger (will log coupons usage)

Add "usage: true" inside config.yml or reset your configuration file.

----------, Jan 13, 2019

UPDATE: Caching

Added an experimental caching mechanism

----------, Jan 1, 2019

UPDATE: Minor Optimization

Implemented some optimized methods

----------, Dec 28, 2018

UPDATE: Bulk Creation Fix