Welcome!

By registering with us, you'll be able to discuss, share and private message with other members of our community.

SignUp Now!

UltraPAY Plugin Documentation

๐€๐๐ฆ๐ข๐ง๐ข๐ฌ๐ญ๐ซ๐š๐ญ๐จ๐ซ๐ฌ
Jan
18
2
๐ƒ๐„๐•๐„๐‹๐Ž๐๐„๐‘ & ๐€๐ƒ๐Œ๐ˆ๐
๐…๐จ๐ฎ๐ง๐๐ž๐ซ
๐Œ๐ž๐ฆ๐›๐ž๐ซ

Advanced Payment System for Minecraft Servers​


Introduction​

UltraPAY is a powerful and feature-rich payment system plugin for Minecraft servers. With enhanced GUI interfaces, payment confirmation systems, and comprehensive transaction management, UltraPAY provides a seamless economy experience for your players with beautiful, modern interfaces and advanced security features.


Features​


  • ๐ŸŽจ Modern GUI Interface: Beautiful payment confirmation GUIs with customizable designs
  • ๐Ÿ’ฐ Advanced Payment System: Send money with confirmation dialogs and sound effects
  • ๐Ÿ“Š Balance Top System: Real-time leaderboard with player heads and formatted amounts
  • ๐Ÿ“ˆ Transaction History: Complete payment history tracking with search functionality
  • ๐Ÿ”’ Security Features: Account pausing, payment toggles, and anti-fraud protection
  • โšก Performance Optimized: Lightweight design with async processing and caching
  • ๐Ÿ—„๏ธ Database Support: SQLite and MySQL database options
  • ๐Ÿ”ง Admin Tools: Comprehensive admin commands for account management
  • ๐ŸŽต Sound Effects: Customizable sound notifications for payments
  • ๐ŸŒ Multi-Platform: Compatible with Paper, Spigot, and Purpur servers
  • ๐Ÿ“ฑ Folia Support: Full compatibility with Folia server software

Installation​


Step 1: Download and Install​

  1. Download the UltraPAY.jar file from BuiltByBit marketplace
  2. Upload the .jar file to your server's plugins folder
  3. Ensure Vault plugin is installed (required dependency)
  4. Restart your server

Step 2: License Activation​

  1. Purchase a license from BuiltByBit marketplace
  2. Join our Discord server: https://discord.gg/shyamstudio
  3. Get your license key from the Discord server
  4. Add your license key to the config.yml file:

YAML:
License: "YOUR-LICENSE-KEY-HERE"

  • Save the config file and restart your server
  • Check console for successful activation:

Code:
[UltraPAY] License verified successfully!
[UltraPAY] UltraPAY has been enabled!

Commands​


Player Commands​


CommandDescriptionUsagePermission
/paySend money to another player/pay <player> <amount>ultrapay.pay
/balanceCheck your or another player's balance/balance [player]ultrapay.balance
/baltopView the richest players leaderboard/baltopultrapay.baltop
/paytoggleToggle receiving payments/paytoggleultrapay.toggle
/payguitoggleToggle payment confirmation GUI/payguitoggleultrapay.toggle
/payhistoryView your payment history/payhistory [page]ultrapay.history

Admin Commands​


CommandDescriptionUsagePermission
/ultrapay reloadReload plugin configuration/ultrapay reloadultrapay.admin
/ultrapay pause <player>Pause a player's account/ultrapay pause <player>ultrapay.admin
/ultrapay unpause <player>Unpause a player's account/ultrapay unpause <player>ultrapay.admin
/ultrapay history <player>View another player's payment history/ultrapay history <player>ultrapay.admin

Command Aliases​

  • /balance โ†’ /bal
  • /baltop โ†’ /btop
  • /payhistory โ†’ /transaction
  • /ultrapay โ†’ /upay

Permissions​


Player Permissions​

YAML:
ultrapay.pay: true          # Allow sending payments
ultrapay.balance: true      # Allow checking balances
ultrapay.baltop: true       # Allow viewing baltop
ultrapay.toggle: true       # Allow toggling payments/GUI
ultrapay.history: true      # Allow viewing own payment history

Admin Permissions​

YAML:
ultrapay.admin: op          # Full admin access
ultrapay.reload: op         # Reload configuration
ultrapay.pause: op          # Pause/unpause accounts
ultrapay.history.others: op # View other players' history

Configuration​


Main Configuration (config.yml)​


YAML:
# License key from Discord server
License: "YOUR-LICENSE-KEY-HERE"

# Database settings
database:
  type: sqlite  # Options: sqlite, mysql
  # MySQL settings (only used if type is mysql)
  host: localhost
  port: 3306
  database: ultrapay
  username: root
  password: password

# Payment Confirmation GUI
payment_confirmation:
  enabled: true  # Enable/disable GUI confirmation

# Display options
display:
  use_chat: true
  use_action_bar: false
  use_formatted_amounts: true  # Format amounts (1k instead of 1000)

# Economy settings
minimum_payment: 0.01

# Sound effects
sounds:
  payment_success: "ENTITY_PLAYER_LEVELUP"
  payment_failed: "ENTITY_VILLAGER_NO"

# Baltop refresh interval (seconds)
REFRESH_BALTOP: 300

Message Configuration (messages.yml)​


The plugin includes a comprehensive message system with hex color support and custom formatting. All messages can be customized including:

  • Payment success/failure messages
  • Balance display messages
  • Admin command responses
  • Error messages
  • GUI toggle messages

Example message format:
YAML:
payment:
  sent: "%prefix%&#a8e6cfโœ“ &#ffffff๐๐š๐ฒ๐ฆ๐ž๐ง๐ญ ๐’๐ž๐ง๐ญ &#34eb9bโžค &#ffffff$&#a8e6cf%amount% &#ffffffโ†’ &#34eb9b%receiver%"

Features in Detail​


Payment System​

  • Amount Formatting: Supports K, M, B, T suffixes (e.g., 1k = 1000)
  • Confirmation GUI: Optional GUI confirmation for payments
  • Sound Effects: Customizable success/failure sounds
  • Anti-Self Payment: Prevents players from paying themselves
  • Minimum Amount: Configurable minimum payment threshold

Balance Top (Baltop)​

  • Real-time Updates: Automatic refresh every 5 minutes (configurable)
  • Player Heads: Shows actual player skins in the GUI
  • Pagination: Navigate through multiple pages of top players
  • Player Position: Shows your current position in the leaderboard
  • Refresh Button: Manual refresh option

Transaction History​

  • Complete Tracking: Records all payments sent and received
  • Search Function: Filter transactions by player name
  • Pagination: Browse through transaction history
  • Admin Access: Admins can view any player's history

Security Features​

  • Account Pausing: Admins can temporarily suspend player accounts
  • Payment Toggle: Players can disable receiving payments
  • GUI Toggle: Players can disable confirmation GUI
  • License Protection: Secure license verification system

Database Support​


SQLite (Default)​

  • File-based: Stores data in plugins/UltraPAY/database.db
  • No Setup Required: Works out of the box
  • Lightweight: Perfect for small to medium servers

MySQL (Optional)​

YAML:
database:
  type: mysql
  host: your-mysql-host
  port: 3306
  database: ultrapay_db
  username: your_username
  password: your_password

Compatibility​


ComponentCompatibility
Minecraft Version1.20.4 - 1.21.*
Server SoftwarePaper, Spigot, Purpur
Required PluginsVault
Optional PluginsEssentials (overrides /pay command)
Folia Supportโœ… Full Support

Troubleshooting​


Common Issues​


Plugin not loading:
  • Ensure Vault is installed and enabled
  • Check that you have the correct Minecraft version
  • Verify license key is correctly set

Payments not working:
  • Check if player has sufficient funds
  • Verify target player exists and has joined before
  • Ensure accounts are not paused

GUI not opening:
  • Check if GUI is enabled in config
  • Verify player has correct permissions
  • Try reloading the plugin

Database errors:
  • For MySQL: Check connection details
  • For SQLite: Ensure write permissions to plugin folder
  • Check server logs for detailed error messages

Getting Help​


Support Channels:

Before Requesting Support:
  • Check server console for errors
  • Verify all dependencies are installed
  • Test with default configuration
  • Provide server version and plugin version

Advanced Configuration​


Custom GUI Layouts​

The plugin supports extensive GUI customization through configuration files. You can modify:
  • Item materials and names
  • Lore text and formatting
  • Slot positions
  • Navigation buttons
  • Color schemes

Performance Optimization​

  • Async Processing: All database operations run asynchronously
  • Caching System: Player data and baltop cached for performance
  • Configurable Refresh: Adjust baltop refresh intervals
  • Memory Management: Automatic cleanup of old cache entries

Integration with Other Plugins​

  • Vault Economy: Full integration with any Vault-compatible economy plugin
  • Essentials Override: Automatically replaces Essentials /pay command
  • Permission Plugins: Works with any permission plugin (LuckPerms, etc.)

Thank you for using UltraPAY!

Created by ShyamStudio
Support:
https://discord.gg/shyamstudio

UltraPAY - The Ultimate Payment Solution for Minecraft Servers
 
Top