VoucherZ - A Minecraft Plugin for Creating Redeemable Vouchers
VoucherZ is a customizable plugin that allows server administrators to create redeemable vouchers for granting rewards like ranks, items, or permissions. It’s simple to set up and integrates seamlessly with your Minecraft server.
Features
- Create Custom Vouchers: Define names, descriptions, and rewards.
- Control Voucher Usage: Permissions-based system for restricting voucher usage.
- Varied Rewards: Redeem commands, items, or permissions.
- Simple Commands for Distribution: Easily distribute vouchers to players.
Small example showcase of VoucherZ
Commands & Permissions
Commands
- /voucher give <player> <voucher>: Give a voucher to a player.
- /voucher reload: Reload the plugin configuration.
Permissions
- voucher.use: Allows players to redeem vouchers.
- voucher.reload: Permission to reload the plugin configuration.
- voucher.give: Permission to give vouchers to other players.
Installation
- Download the latest version of VoucherZ from the releases page.
- Place the VoucherZ.jar file into your server’s plugins folder.
- Restart your server to load the plugin.
- Edit the config.yml file to configure your custom vouchers.
Example Configuration
Code (Text):
# VoucherZ Configuration File
vouchers:
# Unique key for the voucher
DragonLordVoucher:
# Display name of the voucher (supports color codes with &)
name: "&4&lDragon &6&lLord &7&lVoucher"
# Material used for the voucher item
material: "BLAZE_ROD"
# Description of the voucher (supports color codes with &)
lore:
- "&7Right-click to unleash the &4fire &7of the ancient dragons."
- " "
- "&6Grants you the &4&lDragon Lord &6Rank!"
- " "
- "&8&oThe ground trembles as your power awakens..."
# Command executed when the voucher is redeemed
# %player% will be replaced with the player's name
command: "lp user %player% parent set dragonlord"
# Permission required to use this voucher
# Leave blank ("") if no permission is required
permission: "voucher.use"
# Sound effect to be played when the voucher is redeemed
# Use valid Minecraft sound names
sound: "ENTITY_ENDER_DRAGON_GROWL"
# Particle effect displayed during redemption
# Use valid Minecraft particle names
particles: "FLAME"
# Animation type for the particle effects (choose from: circle, spiral, helix, burst, cloud)
animation: "helix"
# Messages sent to the player after redeeming the voucher
# %voucher% will be replaced with the voucher's name
redeem-message:
- "&8&m----------------------------"
- " "
- "&4&l✦ &6The ancient flames bow to you, &4&oDragon Lord."
- " "
- "&7You now wield the fiery strength of the dragons."
- "&7The skies tremble before your power."
- " "
- "&8&oThe flames whisper your legacy... &7&oWield it with honor."
- " "
- "&8&m----------------------------"
# =============================================================
# YOU CAN ADD MORE BELOW WITH THE ABOVE TEMPLATE
# =============================================================
This configuration example gives a player the
Dragon Lord rank using the
lp command. The voucher uses a Blaze Rod, plays the
ENDER_DRAGON_GROWL sound, and displays flame particles upon redemption.
Development & API
This is planned.
Contributing & License
VoucherZ is open-source and licensed under the
MIT License. Contributions are welcome through issues or pull requests on
GitHub.
Got Issues or Suggestions?
Join our community on Discord to share your thoughts or ask questions
Join the Discord