READ THE TOS BEFORE YOU PURCHASE THIS PLUGIN!
- Once you purchase the plugin there are absolutely no refunds at all, no matter the case, excuse, whatsoever.
- I am not obligated to keep updating this plugin, doesn't mean I will not.
- I am not obligated to assist you, accept your suggestion, set the plugin up for you whatsoever.
- You are not allowed to decompile the plugin under any circumstance.
- You may use 1 copy per server ONLY.
- You may NOT share this plugin with others.
Commands & Permissions:
To use X Coupons (not /redeem) the permissions xcoupons.use is required!
Player Commands:
/redeem [COUPON ID]
Admin Commands:
/xcp new [integer]
/xcp delete [coupon id]
/xcp addmcd [coupon id] [command]
/xcp delcmd [coupon id] [command id]
/xcp inspect [coupon id]
/xcp secure [coupon id] [player name]
/xcp amount [coupon id] [integer]
/xcp bulk [coupon id] [integer] [extra parameter]
/xcp purge
/xcp reload
/xcp version
- /redeem [COUPON ID] - Redeem a coupon code!
Permission: None, everyone can redeem a coupon!
Usage: /redeem [COUPON ID]
Details: This is the command you'll be using to redeem a coupon code. Note that all commands are being run via console!
- /xcp new [INTEGER] - Create a new coupon code!
Permission: xcoupons.new
Usage: /xcp new 5 - Will create a new coupon code with 5 characters!
Details: This is the main command you'll be using, it creates a new coupon code whenever executed. You can change min-max length inside the config.yml!
- /xcp delete [ID] - Delete an existing coupon code!
Permission: xcoupons.del
Usage: /xcp delete [COUPON ID]
Details: This command will delete an already existing coupon code!
- /xcp addcmd [COUPON ID] [CMD] - Add a command to an existing coupon code
Permission: xcoupons.addcmd
Usage:
- /xcp addcmd [COUPON ID] broadcast %p won the lottery!
- /xcp addcmd [COUPON ID] eco give %p 1000000
- /xcp delcmd [COUPON ID] [COMMAND ID] - Unbind a command!
Permission: xcoupons.delcmd
Usage: /xcp delcmd [COUPON ID] 1 (Will delete the first command)
Details: This is the command you'll be using to remove specific commands from a coupon (in-game). To find the COMMAND ID, just use the inspect feature and replace COMMAND ID with the number to the left of the command you want to remove!
- /xcp inspect [COUPON ID] - Inspect a coupon code!
Permission: xcoupons.inspect
Usage: /xcp inspect [COUPON ID]
Details: This is the command you'll be using to inspect a coupon, more specifically view what commands are being run when it's redeemed and if the coupon is secured to any users!
- /xcp secure [COUPON ID] [IGN] - Secure a coupon to a user(s)!
Permission: xcoupons.secure
Usage: /xcp secure [COUPON ID] N0RSKA
Details: This command will secure the selected user(s) to the coupon, meaning only that specific user will be able to redeem the coupon!
- /xcp amount [COUPON ID] [INTEGER] - The amount of uses in total!
Permission: xcoupons.amount
Usage: /xcp amount [COUPON ID] 50
Details: This command will add total uses to a coupon, meaning it can be
redeemed by players x times. Players can redeem the coupon once!
- /xcp copy [COUPON ID] [INTEGER] [PARAMETER] - Create coupons in bulk!
Permission: xcoupons.bulk
Usage: /xcp amount [COUPON ID] 10 [Pastebin or Console]
Details: Use this command to easily create coupons in bulk! Coupons generated will have the data (commands only) from the target coupon!
- /xcp purge - Deletes all existing coupon codes! (Console only)
Permission: Console only
Usage: /xcp purge (Console only)
Details: With this command you can directly and quickly delete all of the existing coupon codes, this command is only executable via console!
- /xcp reload - Reload the plugin (config.yml , messages.yml)
Permission: xcoupons.reload
Usage: /xcp reload
Details: With this command you can directly reload X Coupons from in-game!
- /xcp version - View the version of the plugin
Permission: xcoupons.version
Usage: /xcp version
Details: View the version of X Coupons as well as if it's updated or not!
Installation Process & How to create your first coupon:
Installation Proccess:
Download the plugin and drag it into your plugins folder & restart your server. After that... it's done, works perfectly out of the box. To get started. locate the "X Coupons" folder and edit the plugin to your preferences!
How to create your first coupon:
Step 1: Create a new coupon code by using /xcp new [length]. The length argument must be an integer (you can define the min and max length inside of config.yml).
Step 2: After you've created your coupon code with the command above, you should add commands to be executed upon redemption. To add a command to the coupon just use /xcp addcmd [ID of created coupon] [your commands]. Note that all commands are being run via the console!
Example: /xcp addcmd SK20A2 give %p diamond_sword 1
Step 3: Do you want to secure the coupon to a specific player(s)? Just use /xcp secure [IGN]. After you've secured a coupon only specific player(s) you've set will be able to redeem it.
Step 4: Use /redeem [ID of coupon] to redeem the coupon code you've created!
Placeholders:
Placeholders for messages.yml:
%ID = Returns coupon ID
%p = Returns player name
%dp = Returns player display name
Placeholders to be used in coupons:
%p = Returns player name
%dp = Returns player display name
%x = Returns X value of the player
%y = Returns Y value of the player
%z = Returns Z value of the player
Configurations:
# TOGGLE WHETHER TO RECEIVE
# UPDATE NOTIFIACTION MESSAGES
# WHEN A NEW DOWNLOAD IS AVAILABLE!
# ONLY OPS WILL GET THIS MESSGAE.
Update Notifications: true
# SET THE MAX LENGTH A COUPON CAN HAVE
# THIS VALUE MUST BE ABOVE 0!
Max Length: 10
# SET THE COOLDOWN FOR THE /REDEEM COMMAND
# THIS SHOULD BE SET TO SOMETHING FAIRLY
# HIGH, TO AVOID UNWANTED & RANDOM REDEEMALS!
# COOLDOWN IS IN SECONDS ONLY!
Redeem Command Cooldown: 30
NO PERMISSION:
- '&8&m----------------------------------------------+'
- ' &e&l&oX COUPONS &7Error:'
- ' &fYou do not have permission!'
- '&8&m----------------------------------------------+'
REDEEM MENU:
- '&8&m----------------------------------------------+'
- ' &e&l&oREDEEM &7Options:'
- ' &f/redeem [COUPON CODE] &8- &6Redeem a coupon code!'
- '&8&m----------------------------------------------+'
COUPON REDEEMED (Redeem Command):
- '&8&m----------------------------------------------+'
- ' &e&l&oX COUPONS &7Success:'
- ' &fYou redeem a coupon code with ID &6&l%ID&f!'
- '&8&m----------------------------------------------+'
COUPON DOES NOT EXIST (Redeem Command):
- '&8&m----------------------------------------------+'
- ' &e&l&oX COUPONS &7Error:'
- ' &fThat coupon does not exist!'
- '&8&m----------------------------------------------+'
CANT REDEEM DUE TO SECURED:
- '&8&m----------------------------------------------+'
- ' &e&l&oX COUPONS &7Error:'
- ' &fThat coupon is secured to another user!'
- '&8&m----------------------------------------------+'
ON COOLDOWN MESSAGE:
- '&8&m----------------------------------------------+'
- ' &e&l&oX COUPONS &7Error:'
- ' &fYou can redeem a coupon again in &e%cooldown sec&f!'
- '&8&m----------------------------------------------+'