BeastMcMMORedeem

What Is BeastMcMMORedeem?

BeastMcMMORedeem is a modern Spigot/Paper credit redemption plugin built for mcMMO progression. Administrators and reward systems can give players redeem credits, while players decide which enabled mcMMO skills receive them through a polished skill menu and configurable transaction selector.

Credits can add full mcMMO levels or a configurable amount of mcMMO experience. The plugin tracks each player's available balance and lifetime credits spent, protects level-based redemption from exceeding mcMMO skill caps, supports player-to-player credit transfers, and includes File, SQLite, and MySQL storage.

Required Dependencies

• ❗ This plugin REQUIRES BeastLib 1.6.22 or newer to work. Download: BeastLib. Spigot mirror: BeastLib.
• ❗ mcMMO is required for skill redemption. BeastMcMMORedeem can start without mcMMO, but credits cannot be applied to skills until mcMMO is installed and enabled.

Main Features

• ✅ Complete redeem-credit system with current balance and lifetime credits-spent tracking.
• ✅ Modern 6-row skill selection GUI with configurable items, layout, fillers, sounds, and open animation.
• ✅ Dedicated transaction selector with positive and negative controls, reset, maximum, back, cancel, and confirmation actions.
• ✅ Configurable transaction adjustment values. The defaults are 1, 8, and 16.
• ✅ Level mode: one credit adds exactly one mcMMO skill level.
• ✅ Experience mode: one credit adds a configurable amount of mcMMO XP.
• ✅ mcMMO skill-cap protection for level-based redemption before credits are deducted.
• ✅ Configurable enabled skill list and a separate disabled-skill system.
• ✅ Direct skill commands that can open the transaction selector with a chosen starting amount.
• ✅ Optional chat amount entry when the transaction selector is disabled.
• ✅ Player-to-player credit transfers.
• ✅ Configurable starting balance and maximum balance.
• ✅ Per-player File storage, local SQLite storage, remote MySQL storage, and legacy single-file YAML support.
• ✅ Built-in asynchronous YAML-to-MySQL migration command.
• ✅ Online balance cache with asynchronous join loading and queued saves.
• ✅ Safe synchronous final saves during reload and shutdown.
• ✅ Offline-player support for administrative balance commands.
• ✅ Configurable command aliases, amount tab suggestions, silent flag, and confirmation flag.
• ✅ Large-change confirmation gate for give, take, set, and reset operations.
• ✅ Configurable audit log for administrative balance changes, migrations, and BeastWithdraw exchanges.
• ✅ PlaceholderAPI balance and lifetime-spent placeholders.
• ✅ Optional BeastWithdraw integration for physical credit notes and skill-bound notes.
• ✅ Legacy & colors, hex &#RRGGBB colors, and MiniMessage-style formatting.
• ✅ Java 8 compatible.

How Redemption Works

1. ➤ Give a player credits with an admin command or another plugin's command reward.
2. ➤ The player opens /mcmmoredeem.
3. ➤ The player selects an enabled mcMMO skill.
4. ➤ The transaction menu lets the player raise, lower, reset, or maximize the redeem amount.
5. ➤ BeastMcMMORedeem checks the balance, skill status, installed mcMMO skill, and the applicable level-mode skill cap.
6. ✅ After confirmation, the skill progress is applied, credits are deducted, and lifetime credits spent is updated.

Redeem GUI & Transaction Menu

• ♦ Configurable menu titles, row counts, item slots, skill items, information items, and filler layouts.
• ♦ The main menu can show available credits, lifetime credits spent, plugin information, and every configured skill.
• ♦ The transaction menu shows the selected skill, current level, target level, level cap, balance, remaining credits, and maximum redeemable amount.
• ♦ Configurable +amount and -amount controls.
• ♦ Configurable Use Maximum, Reset Amount, Back, Cancel, and Confirm Redeem actions.
• ♦ Separate click, confirm, success, failure, and no-credit sounds with configurable volume and pitch.
• ♦ Individual menu items can override their action sound.
• ♦ Duplicate-click protection helps prevent accidental repeated GUI actions.
• ♦ The transaction menu can close automatically after a successful confirmation.

GUI Open Animations

• ✨ SLIDE_LEFT_TO_RIGHT
• ✨ SLIDE_RIGHT_TO_LEFT
• ✨ SNAKE
• ✨ DIAGONAL_WAVE
• ✨ CENTER_OUT
• ✨ SPIRAL
• ✨ RANDOM_POP
• ✨ RAIN

Animation speed, start delay, items per tick, row pauses, placeholder item, click locking, and start/item/row/finish sounds are configurable in Menus/redeem-menu.yml.

Advanced GUI Item Customization

• ⚙ Material, Amount, Slot, and Slots.
• ⚙ DisplayName, DisplayLores, Lores, and shared skill lore.
• ⚙ CustomModelData and supported-version ItemModelData.
• ⚙ Item Flags, Enchants, Glow, and Unbreakable.
• ⚙ Durability/Data and leather armor colors.
• ⚙ Item attributes with amount, operation, and equipment slot.
• ⚙ Player skull owners, custom skull textures, and custom item data.
• ⚙ Per-item sounds, volume, and pitch.

Supported mcMMO Skills

The default configuration includes the following skills. A skill must also exist in the installed mcMMO version before it can be redeemed.

• ⚔ Acrobatics
• ⚗ Alchemy
• Archery
• Axes
• Crossbows
• ⛏️ Excavation
• Fishing
• Herbalism
• ⚒️ Maces
• ⛏️ Mining
• ⚒️ Repair
• ⚔ Swords
• Taming
• Tridents
• ✊ Unarmed
• Woodcutting

Remove skills from Settings.Redeem.Skills to exclude them from the redeem system, or use Settings.DisabledSkills to temporarily block selected skills.

Storage Options

• ♦ File - one player file at plugins/BeastMcMMORedeem/Players/<uuid>.yml.
• ♦ SQL / SQLite - one local database at plugins/BeastMcMMORedeem/data/credits.db by default.
• ♦ MySQL - remote database storage with configurable table and pooled connections.
• ♦ Legacy_YAML / YAML - older single-file storage support for existing data and migration.
• ⚡ Online data is cached and loaded asynchronously.
• ⚡ Balance changes are queued for storage without blocking normal gameplay.
• ✅ Reload and shutdown wait for queued writes and perform a final synchronous save before closing storage.
• /beastmcmmoredeem migrate yaml mysql copies legacy YAML credit and spent data into MySQL.

Safety & Administration

• ⚠ Large administrative credit changes require the configured --confirm flag by default.
• ⚠ The confirmation threshold and protected actions are fully configurable.
• Add -s to a supported administrative command to prevent the target notification.
• ✅ Give, take, set, reset, migration, and BeastWithdraw exchange actions can be written to the audit log.
• ✅ Audit entries include actor, action, target, UUID, amount, previous balance, new balance, silent state, confirmation state, and command source where applicable.
• ✅ Balances cannot fall below zero.
• ✅ Settings.Credits.MaxBalance can cap stored credit balances. Set it to 0 for no cap.
• ✅ Level-mode skill cap validation occurs before a normal redemption removes credits.

Supported Plugins & Hooks

• ✅ BeastLib - required dependency.
• ✅ mcMMO - provides the skills, levels, experience, and level caps used by redemption.
• ✅ PlaceholderAPI - optional public balance and spent placeholders.
• ✅ BeastWithdraw - optional physical credit notes and skill-bound mcMMO progress notes.

BeastWithdraw Integration

When a compatible BeastWithdraw version is installed, players can move BeastMcMMORedeem credits into physical notes and redeem those notes safely. The integration checks the player's remaining credit capacity so a note is not consumed when the configured maximum balance would block its full value.

Skill-bound notes can also move progress that is already stored in an mcMMO skill into a physical note and restore it to the same skill later.

• ★ Main BeastMcMMORedeem credit withdraw command: /mcmmocreditwithdraw.
• ★ Skill-note syntax: /mcmmocreditwithdraw <skill> <amount|all> [stack].
• ★ AUTO skill-note mode follows the normal BeastMcMMORedeem level/experience mode.
• ★ LEVELS mode stores full skill levels.
• ★ EXPERIENCE mode stores XP units converted through Settings.Redeem.XPPerCredit.
• ★ Enabled and disabled BeastMcMMORedeem skills are respected.
• ★ Skill caps are checked when skill progress is restored.
• ★ Credit-note and skill-note exchanges can be recorded in the BeastMcMMORedeem audit log.

Installation

1. ➤ Install BeastLib 1.6.22 or newer in your server /plugins folder.
2. ➤ Install mcMMO.
3. ➤ Put the BeastMcMMORedeem jar in your server /plugins folder.
4. ★ Install optional PlaceholderAPI or BeastWithdraw only if you use those integrations.
5. ➤ Restart the server.
6. ⚙ Configure plugins/BeastMcMMORedeem/config.yml.
7. ⚙ Customize both menus in plugins/BeastMcMMORedeem/Menus/redeem-menu.yml.
8. ⚙ Customize messages in plugins/BeastMcMMORedeem/Lang/en-US.yml.

Important Config Paths

• ⚙ plugins/BeastMcMMORedeem/config.yml - language, credits, storage, MySQL, SQLite, aliases, safety confirmations, audit logging, BeastWithdraw skill notes, redeem mode, and skill settings.
• ⚙ plugins/BeastMcMMORedeem/Menus/redeem-menu.yml - skill menu, transaction menu, items, slots, fillers, animations, sounds, adjustment values, and menu behavior.
• ⚙ plugins/BeastMcMMORedeem/Lang/en-US.yml - default messages, help pages, command usage, prefixes, and redemption feedback.
• ♦ plugins/BeastMcMMORedeem/Players/<uuid>.yml - default File storage player data.
• ♦ plugins/BeastMcMMORedeem/data/credits.db - default SQLite database path.
• ✅ plugins/BeastMcMMORedeem/logs/credits-audit.log - default audit log path.
• ★ plugins/BeastWithdraw/Withdraws/BeastMcMMORedeem/Withdraw-Skill.yml - BeastWithdraw skill-note item and withdraw settings.
• ★ plugins/BeastWithdraw/Withdraws/BeastMcMMORedeem/Depositer-Skills.yml - BeastWithdraw skill-note deposit settings.

Default Commands & Aliases

Redeem command

• ⌨ Main command: /mcmmoredeem
• ⌨ Default aliases: /redeem, /bmr, and /skillredeem

Credits command

• ⌨ Main command: /mcmmocredits
• ⌨ Default aliases: /mcredits, /skillcredits, and /credits

Administration command

• ⚒️ Main command: /beastmcmmoredeem
• ⚒️ Default aliases: /bmcmmo, /bmcmmor, and /bmradmin

All alias lists are configurable under Settings.Commands.

Player Commands

• ⌨ /mcmmoredeem - open the skill redeem menu.
• ⌨ /mcmmoredeem help - show the redeem command help.
• ⌨ /mcmmoredeem <skill> - open the selected skill's transaction menu.
• ⌨ /mcmmoredeem <skill> <amount> - open the selected skill transaction with that starting amount, or redeem directly when direct-menu mode is disabled.
• ⌨ /mcmmoredeem credits - view your current redeem-credit balance.
• ⌨ /mcmmoredeem send <player> <amount> - send credits to another player.
• ⌨ /mcmmocredits - view your current redeem-credit balance.

Admin Commands

Dedicated administration command

• ⚒️ /beastmcmmoredeem help
• ⚒️ /beastmcmmoredeem reload
• ⚒️ /beastmcmmoredeem version
• ⚒️ /beastmcmmoredeem balance <player>
• ⚒️ /beastmcmmoredeem give <player> <amount> [-s] [--confirm]
• ⚒️ /beastmcmmoredeem take <player> <amount> [-s] [--confirm]
• ⚒️ /beastmcmmoredeem set <player> <amount> [-s] [--confirm]
• /beastmcmmoredeem migrate yaml mysql

Administration through the redeem command

• ⚒️ /mcmmoredeem credits <player>
• ⚒️ /mcmmoredeem add <player> <amount> [-s] [--confirm]
• ⚒️ /mcmmoredeem remove <player> <amount> [-s] [--confirm]
• ⚒️ /mcmmoredeem take <player> <amount> [-s] [--confirm]
• ⚒️ /mcmmoredeem set <player> <amount> [-s] [--confirm]
• ⚒️ /mcmmoredeem reset <player> [-s] [--confirm]
• ⚒️ /mcmmoredeem reload
• ⚒️ /mcmmocredits <player>

Permissions

Player permissions

• ⚔ BeastMcMMORedeem.Redeem - open the main redeem GUI.
• ⚔ BeastMcMMORedeem.Redeem.SkillCommand - use direct skill redemption commands.
• ⚔ BeastMcMMORedeem.Credits.Balance - view your own balance.
• ⚔ BeastMcMMORedeem.Credits.Send - send credits to another player.
• ⚔ BeastMcMMORedeem.Help - view the redeem help menu.

Admin permissions

• ⚒️ BeastMcMMORedeem.Admin - parent permission for all BeastMcMMORedeem administration commands.
• ⚒️ BeastMcMMORedeem.Admin.Reload
• ⚒️ BeastMcMMORedeem.Admin.Version
• ⚒️ BeastMcMMORedeem.Admin.Credits.ViewOthers
• ⚒️ BeastMcMMORedeem.Admin.Credits.Give
• ⚒️ BeastMcMMORedeem.Admin.Credits.Take
• ⚒️ BeastMcMMORedeem.Admin.Credits.Set
• ⚒️ BeastMcMMORedeem.Admin.Credits.Reset
• BeastMcMMORedeem.Admin.Migrate

PlaceholderAPI Placeholders

• ✦ %beastmcmmoredeem_credits% - player's current redeem-credit balance.
• ✦ %beastmcmmoredeem_creditsspent% - player's lifetime redeemed credits.
• ✦ %beastmcmmoredeem_credits_spent% - alternate lifetime-spent placeholder.

Local Menu Placeholders

The lowercase and uppercase forms provided by BeastMcMMORedeem can be used in supported menu text.

• ✧ %player%, %version%
• ✧ %mcmmocredits%, %credits%, %creditsspent%
• ✧ %skill%, %skill_material%
• ✧ %skilllevel%, %levelcap%
• ✧ %skillxp%, %skillxp_needed%
• ✧ %amount%, %selected_amount%
• ✧ %balance%, %remaining%, %max%
• ✧ %targetlevel%, %xp_per_credit%

Customization

• ⚙ Change the storage backend at Settings.Credits.Storage.Type.
• ⚙ Configure first-time credits at Settings.Credits.StartingBalance.
• ⚙ Configure the balance cap at Settings.Credits.MaxBalance.
• ⚙ Switch between level and XP redemption with Settings.Redeem.UseExperienceMode.
• ⚙ Set XP granted per credit at Settings.Redeem.XPPerCredit.
• ⚙ Select available skills under Settings.Redeem.Skills.
• ⚙ Temporarily block skills through Settings.DisabledSkills.
• ⚙ Change every public command alias under Settings.Commands.*.Aliases.
• ⚙ Change tab-completion amounts through Settings.Commands.AmountSuggestions.
• ⚙ Configure safety confirmations through Settings.Commands.Confirmations.
• ⚙ Configure the silent flag at Settings.Commands.SilentFlag.
• ⚙ Configure audit logging under Settings.Audit.
• ⚙ Configure BeastWithdraw skill-note behavior under Settings.BeastWithdraw.SkillNotes.
• ⚙ Customize messages and prefixes in Lang/en-US.yml.
• ⚙ Customize both GUI menus, animations, item models, sounds, and selector values in Menus/redeem-menu.yml.

Developer API

BeastMcMMORedeem exposes a public static API at:
me.mraxetv.beastmcmmoiredeem.api.BeastMcMMORedeemAPI

• ✦ Check whether the credit system is available.
• ✦ Read, add, and take player credits.
• ✦ Preview an added balance before applying it.
• ✦ Read a player's remaining redeemable capacity.
• ✦ Read enabled skill names and validate skills.
• ✦ Integrate credit-note and skill-note exchanges.