Getting Started

This page takes you from an empty server to a working voucher in a few minutes.

1. Install ProVouchers

Download provouchers-<version>.jar from the ProVouchers releases, drop it into plugins/, and restart. ProVouchers fetches its runtime libraries (the database drivers and connection pool) through Paper's library loader on first start, so you install nothing else.

2. Find the files

After the first start, ProVouchers creates this folder:

plugins/ProVouchers/
├── config.yml            # storage, anti-dupe, and metrics settings
├── vouchers/
│   └── example.yml       # one voucher per file
└── codes/
    └── example.yml       # one code per file

Every vouchers/*.yml file is one voucher; every codes/*.yml file is one code. The file name (without .yml) is the default id.

3. Create a voucher

Make plugins/ProVouchers/vouchers/starter.yml:

vouchers/starter.yml

id: starter
display-name: "<gradient:#FFD700:#FF4500>Starter Kit</gradient>"
item:
  material: PAPER
  glow: true
lore:
  - "<gray>Right-click to claim your starter kit"
conditions:
  - type: permission
    permission: "provouchers.use.starter"
rewards:
  - "item: IRON_SWORD 1"
  - "item: COOKED_BEEF 16"
  - "message: <gold>Welcome! Your starter kit has been delivered."

Then reload:

/voucher reload

/voucher reload reports any mistakes per file (with the key and reason), so if something is wrong it tells you exactly where.

4. Give and redeem it

/voucher give starter 1 Steve

Steve holds the item and right-clicks to redeem. (Steve needs the provouchers.use.starter permission, since the voucher requires it.)

5. Try a code

Make plugins/ProVouchers/codes/welcome.yml:

codes/welcome.yml

code: WELCOME
case-sensitive: false
uses-per-player: 1
rewards:
  - "currency: give 500"
  - "message: <green>Welcome aboard!"

Reload, then any player runs:

/voucher redeem WELCOME

Where to go next

Core Concepts explains vouchers vs codes and how a redemption flows.
Rewards and Conditions are the two pages you will reference most.
Items covers custom textures and items from ItemsAdder, Oraxen, and Nexo.