Hytale Plugin
The HytalePay plugin connects your game server to your store, enabling automatic item delivery when customers make purchases.
Requirements
- A running Hytale server
- HytalePay store with API key
- Server administrator access
Installation
Step 1: Download the Plugin
Download the HytalePay plugin from CurseForge.
Step 2: Install on Server
- Stop your server
- Copy the plugin file to your
plugins/folder - Start your server
- The plugin will create its configuration files
Step 3: Configure the Plugin
Edit plugins/HytalePay/config.yml:
# HytalePay Configuration
api-key: "your-api-key-here"
store-id: "your-store-id-here"
check-interval: 30
debug: false
Step 4: Reload
Run /hytalepay reload or restart your server.
Configuration UI
The plugin includes a built-in configuration GUI for server administrators. Access it with the /obconfig command.
The GUI displays:
- Status - API connection status
- Active Handlers - Number of registered order handlers
- API Configuration - Current settings (sensitive values masked)
- Polling Interval - How often the plugin checks for orders
Actions available:
- Manual Refresh - Trigger an immediate order check
- Reload Config - Reload configuration from disk without restarting
Commands
| Command | Permission | Description |
|---|---|---|
/orders | - | Manually fetch pending orders (30s cooldown) |
/obconfig | hytalepay.admin | Open configuration GUI |
/obitems | hytalepay.admin | Open item commands GUI |
Item Commands UI
The /obitems command opens a UI to configure what commands run when a player purchases each item.
Features:
- Category dropdown - Browse items by store category
- Search - Filter items by name
- Command editor - Add, remove, and reorder commands per item
- Placeholder buttons - Quick insert
{player},{item_name}variables - Visual status - See which items have commands configured
Items with commands configured show in green, unconfigured items show in gray.
How Delivery Works
- Customer completes purchase on your store
- Order is marked as completed
- Plugin polls for pending deliveries
- Items are given to the player
- Delivery marked as complete
Online Players
Items are delivered immediately when the player is online.
Offline Players
Items are queued and delivered when the player joins.
Setting Up Products
When creating products in your dashboard, configure what the player receives:
Rank Products
commands:
- "lp user {player} parent set vip"
- "broadcast &6{player} &7just purchased &6VIP&7!"
Item Products
commands:
- "give {player} diamond_sword 1"
- "give {player} diamond_pickaxe 1"
- "give {player} diamond 64"
Variables
| Variable | Description |
|---|---|
{player} | Player's username |
{uuid} | Player's UUID |
{product} | Product name |
{price} | Purchase price |
{order_id} | Order ID |
Troubleshooting
"Connection failed" error
- Check your API key is correct
- Verify your server can reach
api.hytalepay.com - Check firewall settings
Items not delivering
- Ensure the player username matches exactly
- Check the plugin has permission to run commands
- Enable debug mode and check logs
"Invalid store ID" error
- Double-check your store ID from the dashboard
- Make sure there are no extra spaces
Best Practices
- Test first: Use test mode to verify deliveries work
- Use exact usernames: Delivery requires exact username match
- Monitor logs: Check for errors regularly
- Keep updated: Update the plugin when new versions release
- Backup config: Save your configuration before updates
Support
If you encounter issues:
- Check the plugin logs in
plugins/HytalePay/logs/ - Enable debug mode for more details
- Contact support with your store ID and error messages