Skip to main content

FioVoucher

FioVoucher is a Minecraft voucher plugin focused on YAML-defined voucher files, player redemption, admin voucher distribution, trial vouchers, confirmation menus, history tracking, and configurable storage.

The current 1.8 source registers the Bukkit plugin as FioVouchers and loads voucher definitions from bundled and server-side YAML files.

What the plugin actually includes

Player flow

FioVoucher currently ships with these player-facing flows:

  • /voucher redeem <code>
  • /voucher trials
  • /voucher pause <code>
  • voucher item redemption through the item listener
  • confirmation menu before claim execution
  • active trial and player history views

Voucher definitions

File-based vouchers live in plugins/FioVoucher/vouchers/*.yml. Each voucher file is identified by voucher.id and may define:

  • voucher display name and enabled state
  • voucher item material, name, lore, flags, and behavior
  • claimed, failed, max-claim, and random-claimed action groups
  • trial settings
  • max claim limits
  • world, region, and permission gates

The bundled source contains 26 voucher YAML files. See Voucher YAML List for the full list and usage notes.

Reward actions

Voucher rewards are executed from YAML action strings. Supported action prefixes include:

  • [MESSAGE]
  • [SOUND]
  • [CONSOLE]
  • [ITEM]
  • [EXP_LEVELS]
  • [EXP_POINTS]
  • [ACTIONBAR]
  • [TITLE]
  • [SUBTITLE]
  • [TOAST:<material>]

Voucher behavior

The current build supports:

  • one-time, limited-use, and unlimited-use vouchers through settings.redeem.max-claim
  • fixed reward actions
  • weighted random reward groups through commands.random-claimed
  • trial vouchers
  • frozen vouchers
  • disabled vouchers
  • per-voucher world and region restrictions
  • permission whitelist and blacklist checks
  • duplicate voucher item protection
  • voucher item protection rules for configured inventories, containers, item frames, armor slots, and environment damage cases
  • item metadata examples for custom model data, armor trims, leather colors, potion metadata, banner or shield patterns, bundle contents, glow, unbreakable items, flags, names, and lore

Major systems

Commands

The main command is:

/voucher

The aliases from plugin.yml are:

/vouchers
/fiovoucher
/fvoucher

Additional aliases can be configured through settings.command-aliases.

Common command usage includes:

  • /voucher redeem <code>
  • /voucher trials
  • /voucher pause <code>
  • /voucher list
  • /voucher info <code>
  • /voucher admin give <player> <voucherid> [amount]
  • /voucher admin giveall <voucherid> [amount]
  • /voucher admin history <player>
  • /voucher admin freeze <voucherid>
  • /voucher admin unfreeze <voucherid>

Full permissions and command details are documented in Commands & Permissions.

Redeem validation

Players redeem a voucher code through /voucher redeem <code> or by using a voucher item. Before executing rewards, FioVoucher validates plugin readiness, Bedrock access, voucher existence, disabled state, frozen state, global blacklist rules, world restrictions, region restrictions, remaining uses, max-claim history, trial settings, and permission gates.

When validation succeeds, the plugin executes the configured voucher actions, records player history, decrements remaining uses when applicable, and saves voucher state.

Storage and history

FioVoucher supports two storage modes:

  • YAML
  • MYSQL

The storage type is configured through storage.type. If MySQL initialization fails, the current storage implementation attempts to fall back to YAML storage.

History storage tracks successful claims and paused trial players so player state can survive reloads and server restarts.

Runtime behavior includes:

  • confirmation GUI loaded from menu/confirmation.yml
  • voucher history GUI loaded from menu/voucherhistory.yml
  • player history and trial GUI loaded from menu/playerhistory.yml
  • language files loaded from lang/*.yml
  • Bedrock redeem control and optional confirmation bypass
  • hibernation and idle wake handling
  • update checker notifications for permitted admins
  • optional PlaceholderAPI support

Developer API

The public FioVoucherAPI exposes:

  • plugin readiness checks
  • voucher lookup by code
  • voucher list and voucher code access
  • voucher item creation
  • give voucher helpers for one player or all online players
  • redeem validation through canRedeem
  • redeem execution through redeem
  • formatted player history access

Documentation map

Use these pages next:

Page note

This page is source-backed and follows the same overview style as the other plugin About pages.