Voucher Configuration

Let's take a look at the voucher-specific configuration points in Vouchers+

Currently there are three primary settings within the voucher configuration section of the Config.yml file for Vouchers+ These settings will be broken down into detail below.

UseClick

This is the mouse-key (direction) that will need to be clicked in order to use a voucher. The two available options for this field are LEFT and RIGHT (corresponding with left-mouse-button and right-mouse-button respectively). By default, the use button for a voucher is set to right-mouse-button, the corresponding configuration section has been included below:

# The mouse-button which must be clicked to use/claim the voucher
# You may either enter: LEFT, RIGHT
# This should not be the same value as that used for the 'PreviewClick' setting
UseClick: 'RIGHT'

---

PreviewClick

This is the mouse-key (direction) that will need to be clicked in order to preview the contents of a voucher. The two available options for this field are LEFT and RIGHT (corresponding with left-mouse-button and right-mouse-button respectively). It is important to note: This entry should be the alternate of what was used for the UseClick field, for example, if RIGHT was assigned to UseClick, LEFT should be assigned to PreviewClick, and vice-versa. By default, the preview button for a voucher is set to left-mouse-button, the corresponding configuration section has been included below:

# The mouse-button which must be clicked to preview the contents of the voucher
# You may either enter: LEFT, RIGHT
# This should not be the same value as that used for the 'UseClick' setting
PreviewClick: 'LEFT'

---

VoucherActionText

Users may not be initially aware which key to click to redeem or preview a voucher. This section of the configuration aims to inform the user by including some configurable text, prompting which button to click to complete each action.

This text does not affect the functionality of the voucher, and can be changed at any time without invalidating any previous voucher. The default text has been included below:

# If included, this text will be appended to the bottom of any voucher lore
# This text prompts the users how to preview and use certain vouchers
VoucherActionText:
  enabled: true
  # Whether a gap should be included between the voucher standard lore and the action text
  linegap: true
  # The line of text representing the action to preview the voucher (this only shows if previews are enabled for the voucher)
  preview: "&6&lLEFT-CLICK &fto preview this voucher"
  # The line of text representing the action to use the voucher
  use: "&6&lRIGHT-CLICK &fto use this voucher"

The enabled field will allow you to determine whether the VoucherActionText should be present or not, if you wish for it to not be enabled, set this value to false.

The linegap field will allow you to determine whether an additional 'buffer' line should be included between the vouchers standard lore and the action text. This buffer will only ever be one line and can be disabled by setting the configuration value to false.

The preview field will allow you to define the line shown to hint which button to click to preview the contents of the voucher. This line will only be added to the action text if the voucher in question has its configuration value 'AllowPreview' set to true (the voucher can be previewed).

The use field will allow you to define the line shown to hint which button to click to use the voucher.