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.

Delivery Types

Pixlpay supports two main delivery methods:

Discord Role Delivery

For Discord-based communities, run your own Discord Agent to handle role assignment:

• Self-hosted - You control the bot and its permissions
• Role assignment within 30 seconds of purchase
• Automatic role removal when subscriptions expire
• Works with any Discord server
• Full control over your customer data

Discord Integration Guide

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 (Rust, Valheim, Project Zomboid, etc.)
• Queue-based delivery ensures reliability

Delivery Architecture

Pixlpay uses a pull-based delivery model for security:

1. Customer makes a purchase on your store
2. Order is queued for delivery on Pixlpay servers
3. Your game server plugin polls for pending deliveries
4. Plugin executes commands on your server
5. 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
Minecraft	Planned
ARK: Survival Evolved	Planned

Learn more about the Go Agent

Native Game Plugins

Direct plugin integrations for popular game platforms:

Plugin	Platform	Status
Rust Plugin	Oxide/uMod	Fully Supported
Valheim Plugin	BepInEx	Fully Supported

Choosing the Right Integration

If you run...	Use...	Why
Discord community	Discord Integration	Built-in bot, no installation needed
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 bot at Discord Developer Portal
2. Download and configure the Pixlpay Discord Agent
3. Create an API token with discord:agent scope
4. Run the agent on your server/VPS
5. Configure products to assign Discord roles

Full Discord Setup Guide

For Rust Servers

# 1. Download the plugin
# 2. Place in oxide/plugins/
# 3. Configure in oxide/config/PixlPay.json

Full Rust Setup Guide

For Valheim Servers

# 1. Install BepInEx + Server devcommands
# 2. Place PixlPay.dll in BepInEx/plugins/
# 3. Configure in BepInEx/config/

Full Valheim Setup Guide

For Project Zomboid

# 1. Download the Go Agent
# 2. Create pixlpay-config.json
# 3. Run the agent alongside your server

Full Project Zomboid Setup Guide

Getting Your Credentials

All plugins require two secret keys from your Pixlpay dashboard:

1. Store Secret - Identifies your store (shared across all servers)
2. Server Secret - Identifies this specific game server (unique per server)

To get your credentials:

1. Log in to your Pixlpay Dashboard
2. Go to Settings > Game Servers
3. Add your server or select an existing one
4. 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