Mint

A MyBB extension that establishes a platform for virtual currency and inventory items held by users.

Dependencies

• MyBB 1.8.x
• https://github.com/frostschutz/MyBB-PluginLibrary
• PHP >= 7.1

Currency

The Currency platform allows units to enter and exit the circulation by applying user-specific Balance Operations with delta values assigned to traceable Termination Points designating functional origin or destination of currency units.

Manual Balance Transfers allow users to transfer currency units — using public and private transfers — between accounts with attached messages.

Transfer form fields can be pre-filled using GET parameters:

misc.php?action=economy_balance_transfer&user_name=aloeblacc&amount=1&note=for+your+story

The plugin's Content Entity Rewards handling allows modules to grant, void, and trace rewards for Entities of specified Content Types.

Selected user groups are able to mint and burn amounts assigned to individual accounts, inserting and removing currency from circulation, respectively.

Items

The Items platform handles Item Types assigned to Categories, providing blueprints for invididual user-owned Items. Inventory Types and size bonuses allow to specify how many slots are available to hold Items.

Selected user groups are able to forge amounts of an Item Type to be assigned to individual accounts, inserting it into the economy.

Item Actions allow developers to create custom scripts to be executed upon request by item owners.

Manual Item Transactions allow users to exchange currency units and items. Individual Transactions can be represented in MyCode-enabled content using [item_transaction=ID] tags.

Widgets & Variables

Global

• {$mintBalance} - formatted balance of the currently logged in user; empty if guest (global_start hook)
• {$mintInventoryStatus} - number of occupied slots in inventory of the currently logged in user; empty if guest (global_start hook)

User Profiles

• {$mintContextUserBalance} - formatted balance of the user (member_profile_end hook)
• {$mintContextUserInventoryStatus} - number of occupied slots in inventory of the user (member_profile_end hook)
• {$mintRecentBalanceOperations} - recent Balance Operations widget on user profiles (member_profile_end hook)
• {$mintInventoryPreview} - Inventory preview widget on user profiles (member_profile_end hook)

Postbit

• {$post['mintBalance']} - formatted balance of the author (postbit, postbit_prev, postbit_pm, postbit_announcement hooks)
• {$post['mintInventoryStatus']} - number of occupied slots in inventory of the author (postbit, postbit_prev, postbit_pm, postbit_announcement hooks)

Hooks

• mint_activate
• mint_deactivate
• mint_admin_config_mint_tabs
• mint_admin_config_mint_begin
• mint_admin_tools_mint_logs_tabs
• mint_admin_tools_mint_logs_begin
• mint_misc_pages
• mint_economy_hub_balance_service_links
• mint_economy_hub_items_service_links
• mint_get_user_reward_multiplier

Plugin Management Events

• Install:
  • Database structure created/altered
  • Cache entries created
  • Tasks registered
• Uninstall:
  • Database structure & data deleted/restored
  • Settings deleted
  • Cache entries removed
  • Tasks removed
• Activate:
  • Modules detected
  • Settings populated/updated
  • Templates & stylesheets inserted/altered
• Deactivate:
  • Templates & stylesheets removed/restored

Development Mode

The plugin can operate in development mode, where plugin templates are being fetched directly from the templates/ directory - set mint\DEVELOPMENT_MODE to true in inc/plugins/mint.php.