Last updated
Last updated
Vouchers+ has a large number of integrated plugin commands. A comprehensive list of all built-in commands has been included below.
Whilst all listed commands will be shown with the top-level command "vouchers", these may also be typed with the alternate top-level command "voucher". The plugin recognises these two terms synonymously.
Standard Commands
Administrative Commands
Used as top-level command: Refer to sub-command permission node
Used Solo: Requires permission node vouchers.help
This is the initial starting point (top-level command) for all sub-commands. However, it can also be used solo without any sub-commands.
When used solo, this command will present the user who ran it with the Vouchers+ help message.
This command may be ran (solo) through console, as well as ingame.
Requires permission node vouchers.help
This command will present the user with a supporting help menu when run. The core functionality of this command differs depending on the permission nodes present for the user.
This command is fundamentally dynamic, and will only present information to a user that is applicable to them. For example, if the user does not have permission to use the /vouchers list command, it will not be shown to them through the help menu.
This command may be ran through console, as well as ingame.
Requires permission node vouchers.list
To gain vouchers through the list, requires permission node vouchers.admin
This command will present a standard user with a list of all vouchers which are currently stored ingame. This is an interactive chat menu that displays 10 vouchers per page, the pages can then be traversed through by button click. The information provided to a standard user is the name of the voucher, as well as its stored ID.
If the user who has ran the command also has the permission node vouchers.admin, they will additionally see chat buttons next to each voucher, allowing them to get a copy of the voucher added to their inventory, this button is not visible to standard users.
This command should mostly be ran ingame. If ran through console, the information provided will be slightly different and a long (singular) list of voucher ID's will be displayed, along with command information on how to give the voucher to a player.
Requires permission node vouchers.admin
This command will present the user with a traversable GUI menu of all the vouchers within the game. Here the user can see the icons, and lores of the individual vouchers.
Through this menu, a user may traverse to different pages if there are more vouchers than what fits on one page. A theoretically infinite number of vouchers can be created, and thus a theoretically infinite number of pages may be traversed.
Each voucher icon can be left-clicked in order to obtain a copy of that voucher. Alternately, each voucher icon can be right-clicked in order to preview the contents of that voucher.
This command is only accessible ingame, due to the fact that GUI panels are not visible from within a console.
Requires permission node vouchers.admin
This command allows you to give a target player a target voucher in a set quantity. The correct full format of this command is:
/vouchers give <playername> <voucherID> [qty]
playername and voucherID are both mandatory fields in order to use this command correctly. qty is the number of vouchers to give to that player, if left blank it will default to 1.
The voucherID is the corresponding file name of the voucher, you should not used the configured name from within the actual voucher file.
This command may be ran through console, as well as ingame.
Requires permission node vouchers.admin
This command allows you to give all players currently online in the server a target voucher in a set quantity. The correct full format of this command is:
/vouchers giveall <voucherID> [qty]
voucherID is a mandatory field in order to use this command correctly. qty is the number of vouchers to give to each player, if left blank it will default to 1.
The voucherID is the corresponding file name of the voucher, you should not used the configured name from within the actual voucher file.
This command may be ran through console, as well as ingame.
Requires permission node vouchers.admin
The edit command is the pinnacle of modern plugins. This allows you to configure the majority of the voucher files from ingame as well as create completely new vouchers, without even having to enter the plugin folder!
This command will present you with a menu in chat, you can then interact with the buttons in the chat menu to navigate through the different voucher files and settings. From here, you can click buttons and type prompted commands to modify the functionality of the vouchers.
This command may appear complex, but in practice it's quite simple. As always, feel free to reach out if you require assistance.
Additionally, there's no need to use this command if you don't want to! If you prefer the old fashioned way of using the physical files, feel free to (I prefer them)!
This command may only be ran ingame, interactive chat menus do not function through console.
Although incredibly rare, if you have set up your voucher files manually, in a way that disobeys standard YML formatting, further using the edit command may result in unexpected data loss. It can be beneficial to ensure that you understand how to functionally use YML before touching the physical files. Alternately, it can be beneficial to make regular backups of your files in such data-loss events.
Requires permission node vouchers.admin
This command will bring any changes made in the Config.yml/Messages.yml into effect in game. It is important to note that this command is not needed to bring changes made in voucher files into effect ingame as these happen instantly (as soon as you save the file).
This command may be ran through console, as well as ingame.
Understand the different commands associated with Vouchers+