mirror of
https://github.com/songoda/EpicVouchers.git
synced 2024-11-22 10:05:15 +01:00
98 lines
5.3 KiB
Markdown
98 lines
5.3 KiB
Markdown
<p align="center">
|
||
<img src="https://proxy.songoda.com/200/https://cdn2.songoda.com/products/epicvouchers/5EJsLZfmeHcwy9rIY0dAgnzqR4rL4iCKAEyjgjIk.png" alt="EpicVouchers" />
|
||
</p>
|
||
<h1 align="center">EpicVouchers</h1>
|
||
|
||
<p align="center">
|
||
<b>Create vouchers that players can claim for rewards with seemingly infinite possibilities. Customize your server’s vouchers through an intuitive in-game editor.</b>
|
||
|
||
<p align="center">
|
||
<img alt="Discord" src="https://img.shields.io/discord/293212540723396608?color=7289DA&label=Discord&logo=discord&logoColor=7289DA&link=https://discord.gg/songoda"> <img alt="Patreon" src="https://img.shields.io/badge/-Support_on_Patreon-F96854.svg?logo=patreon&style=flat&logoColor=white&link=https://wwww.patreon.com/join/songoda"> <br/> <img alt="Latest" src="https://img.shields.io/badge/-ver_2.1.18-4078C0.svg?logo=github&style=flat&logoColor-white&color=blue&label=Latest&labelColor=black"> <img alt="quality" src="https://img.shields.io/codacy/grade/4123a753597e43c89a93df5bbfb353ee"> <img alt="Last Updated" src="https://img.shields.io/github/last-commit/songoda/EpicVouchers"> <br/> <img alt="Servers" src="https://img.shields.io/bstats/servers/4209"> <img alt="Maintained" src="https://img.shields.io/maintenance/yes/2020">
|
||
|
||
<br />
|
||
|
||
## Table of Contents
|
||
|
||
* [Introduction](#introduction)
|
||
* [Marketplace](#marketplace)
|
||
* [Documentation](#documentation)
|
||
* [Developers API](#developers-api)
|
||
* [Support](#support)
|
||
* [Suggestions](#suggestions)
|
||
|
||
## Introduction
|
||
EpicVouchers is simple to use voucher plugin, that gives you the ability to reward players automatically without needing to give them permission to a command or manually run a command on a player yourself. This plugin is perfect for cosmetic rewards, selling in-game ranks, crate and kit rewards, unique shop designs, etc. The plugin also features an in-game GUI that allows you to create, edit and delete vouchers without needing to configurate the files, or restart/reload the server to apply the changes. It's a perfect plugin for production servers, and gives you unlimited ways to reward your loyal players easily.
|
||
|
||
## Marketplace
|
||
You can visit [our marketplace](https://songoda.com/marketplace/product/epicvouchers-advanced-vouchers-by-gui.25) to download EpicVouchers as well as take a look at many other fantastic plugins which are sure to catch your eye.
|
||
|
||
## Documentation
|
||
You can find all the information about the plugin, including dependencies, commands, permissions, incompatible plugins on [our wiki](https://wiki.songoda.com/Epic_Vouchers). Feel free to also contribute to the wiki as a way to help others in the community with using the plugin.
|
||
|
||
## Developers API
|
||
Here is an example with built-in methods for developers that want to use the EpicVouchers API for their own resources. This is a pretty long example, so take that into consideration when looking at the example, but I am sure that you will understand the usage of it quickly.
|
||
|
||
```ruby
|
||
@EventHandler
|
||
public void redeemListener(VoucherRedeemEvent event) {
|
||
# Returns the player that redeemed the voucher.
|
||
Player player = event.getPlayer();
|
||
# Returns the name of the redeemed voucher.
|
||
String voucher = event.getVoucher();
|
||
# Returns the ItemStack of the redeemed voucher.
|
||
ItemStack item = event.getItem();
|
||
# Returns if the voucher was redeemed manual or not.
|
||
boolean manual = event.getManual();
|
||
# Returns if the event is cancelled or not.
|
||
boolean cancelled = event.isCancelled();
|
||
# Get a list of handlers for this event.
|
||
HandlerList handlers = event.getHandlers();
|
||
# Cancel the event with a boolean.
|
||
event.isCancelled(true);
|
||
}
|
||
|
||
@EventHandler
|
||
public void forceListener(ForceRedeemEvent event) {
|
||
# Returns the player that redeemed the voucher.
|
||
Player player = event.getPlayer();
|
||
# Returns the name of the redeemed voucher.
|
||
String voucher = event.getVoucher();
|
||
# Returns the amount of vouchers that were redeemed.
|
||
int amount = event.getAmount();
|
||
# Returns the sender that forced the players.
|
||
CommandSender sender = event.getSender();
|
||
# Returns if the event is cancelled or not.
|
||
boolean cancelled = event.isCancelled();
|
||
# Get a list of handlers for this event.
|
||
HandlerList handlers = event.getHandlers();
|
||
# Cancel the event with a boolean.
|
||
event.isCancelled(true);
|
||
}
|
||
|
||
@EventHandler
|
||
public void receiveListener(VoucherReceiveEvent event) {
|
||
# Returns the player that received the voucher.
|
||
Player player = event.getPlayer();
|
||
# Returns the name of the received voucher.
|
||
String voucher = event.getVoucher();
|
||
# Returns the ItemStack of the received voucher.
|
||
ItemStack item = event.getItem();
|
||
# Returns the amount of vouchers that were received.
|
||
int amount = event.getAmount();
|
||
# Returns the sender that gave the vouchers.
|
||
CommandSender sender = event.getSender();
|
||
# Returns if the event is cancelled or not.
|
||
boolean cancelled = event.isCancelled();
|
||
# Get a list of handlers for this event.
|
||
HandlerList handlers = event.getHandlers();
|
||
# Cancel the event with a boolean.
|
||
event.isCancelled(true);
|
||
}
|
||
```
|
||
|
||
## Support
|
||
If you encounter any issues while using the plugin, feel free to create a ticket on [our support desk](https://support.songoda.com).
|
||
|
||
## Suggestions
|
||
For suggestions about features you think should be added to the plugin to increase its functionality, feel free to create a thread over on [our feedback site](https://feedback.songoda.com).
|