Plugin Documentation
Welcome to the Pixlpay Plugin documentation. This section covers everything you need to know about delivering purchases to your players - whether through Discord roles, game server commands, or both.
Downloads
Download the latest plugins and agents directly:
| Plugin/Agent | Platform | Download |
|---|---|---|
| Hytale Plugin | Hytale Server | pixlpay-hytale.jar |
| Minecraft Bedrock Plugin | PocketMine-MP | PixlPay.phar |
| Rust Plugin | Oxide/uMod | PixlPay.cs |
| Valheim Plugin | BepInEx | PixlPay.cs |
| Go Agent | Windows | pixlpay-agent.exe |
| Go Agent | Linux | pixlpay-agent |
| Go Agent | macOS (Intel) | pixlpay-agent |
| Go Agent | macOS (Apple Silicon) | pixlpay-agent |
TIP
Downloads are also available from your Pixlpay Dashboard under Settings > Game Servers > Downloads.
Delivery Types
Pixlpay supports two main delivery methods:
Discord Role Delivery
For Discord-based communities, use the Custom Discord Bot for role assignment:
- Zero Hosting - No server or VPS required
- Instant role delivery when customers run
/claim - Automatic role removal when subscriptions expire
- Works with any Discord server
- Secure - Bot token encrypted, Ed25519 signature verification
Game Server Delivery
For game servers, install a plugin or agent that delivers items in-game:
- Commands executed directly on your server
- Support for multiple games (Hytale, Minecraft, Rust, Valheim, etc.)
- Queue-based delivery ensures reliability
Delivery Architecture
Pixlpay uses a pull-based delivery model for security:
- Customer makes a purchase on your store
- Order is queued for delivery on Pixlpay servers
- Your game server plugin polls for pending deliveries
- Plugin executes commands on your server
- Delivery status is reported back to Pixlpay
This approach ensures:
- Security - Pixlpay never connects directly to your servers
- Reliability - Commands queue until your server is ready
- Control - You maintain full control of your infrastructure
Available Integrations
Go Agent (Recommended for New Setups)
A standalone delivery agent that works with any game supporting RCON:
| Game | Status |
|---|---|
| Project Zomboid | Fully Supported |
| ARK: Survival Evolved | Planned |
Native Game Plugins
Direct plugin integrations for popular game platforms:
| Plugin | Platform | Status |
|---|---|---|
| Hytale Plugin | Hytale Server | Fully Supported |
| Minecraft Bedrock Plugin | PocketMine-MP | Fully Supported |
| Rust Plugin | Oxide/uMod | Fully Supported |
| Valheim Plugin | BepInEx | Fully Supported |
Choosing the Right Integration
| If you run... | Use... | Why |
|---|---|---|
| Discord community | Discord Integration | Zero hosting, instant role delivery via /claim |
| Hytale server | Hytale Plugin | Native Hytale Server integration |
| Minecraft Bedrock server | Minecraft Bedrock Plugin | Native PocketMine-MP integration |
| Rust server | Rust Plugin | Native Oxide integration, no external dependencies |
| Valheim server | Valheim Plugin | Native BepInEx integration |
| Project Zomboid | Go Agent | RCON-based delivery via standalone agent |
| Multiple games | Go Agent | Single agent supports multiple game types |
| Discord + Game server | Both | Use Discord for perks, game server for items |
Quick Start
For Discord
1. Create a Discord Application at Discord Developer Portal
2. Add a Bot and copy the Bot Token
3. Configure credentials in Pixlpay dashboard
4. Set the Interactions Endpoint URL in Discord
5. Invite the bot to your server and configure productsFor Hytale Servers
# 1. Download pixlpay-hytale.jar
# 2. Place in plugins/
# 3. Configure in plugins/PixlPay/config.jsonFor Minecraft Bedrock Servers
# 1. Download PixlPay.phar
# 2. Place in plugins/
# 3. Configure in plugin_data/PixlPay/config.ymlFull Minecraft Bedrock Setup Guide
For Rust Servers
# 1. Download the plugin
# 2. Place in oxide/plugins/
# 3. Configure in oxide/config/PixlPay.jsonFor Valheim Servers
# 1. Install BepInEx + Server devcommands
# 2. Place PixlPay.dll in BepInEx/plugins/
# 3. Configure in BepInEx/config/For Project Zomboid
# 1. Download the Go Agent
# 2. Create pixlpay-config.json
# 3. Run the agent alongside your serverFull Project Zomboid Setup Guide
Getting Your Credentials
All plugins require two secret keys from your Pixlpay dashboard:
- Store Secret - Identifies your store (shared across all servers)
- Server Secret - Identifies this specific game server (unique per server)
To get your credentials:
- Log in to your Pixlpay Dashboard
- Go to Settings > Game Servers
- Add your server or select an existing one
- Copy the Store Secret and Server Secret
Support
- Troubleshooting Guide - Common issues and solutions
- Command Reference - Available placeholders and command formats
- Discord Support - Get help from the community
- Contact Support - Open a support ticket
