Command Reference
This page covers command formats, placeholders, and examples for all supported games.
Placeholders
Placeholders are replaced with actual values when commands are executed. Use them in your product delivery commands.
Universal Placeholders
These placeholders work across all games and plugins:
| Placeholder | Description | Example Value |
|---|---|---|
{player} | Player's game username | SurvivorSteve |
{username} | Same as {player} | SurvivorSteve |
{steam_id} | Player's Steam ID (64-bit) | 76561198012345678 |
{quantity} | Quantity purchased | 5 |
{product_name} | Name of the product | VIP Kit |
{order_id} | Internal order ID | 12345 |
{order_number} | Display order number | ORD-2025-0001 |
{customer_email} | Customer's email | player@example.com |
{customer_name} | Customer's name | John Doe |
Using Placeholders
Place placeholders directly in your command text:
give {player} diamond_sword 1When executed, this becomes:
give SurvivorSteve diamond_sword 1Multiple Commands
Add multiple commands, one per line:
give {player} vip_sword 1
give {player} vip_armor 1
broadcast {player} just became a VIP!Each command executes sequentially.
Command Types
Purchase Commands
Executed when a customer completes a purchase. Configure in product settings under Delivery > Commands.
give {player} purchased_item {quantity}Refund Commands
Executed when you issue a refund. Configure in product settings under Delivery > Refund Commands.
take {player} purchased_item {quantity}Chargeback Commands
Executed when a customer disputes the payment. Configure in product settings under Delivery > Chargeback Commands.
take {player} purchased_item {quantity}
ban {player} Payment chargebackGame-Specific Commands
Project Zomboid
Give Items:
additem {player} Base.Axe 1
additem {player} Base.RifleHunting 1
additem {player} Base.Bullets9mmBox {quantity}Add Experience:
addxp {player} Strength 500
addxp {player} Fitness 500
addxp {player} Aiming 1000Set Access Level:
setaccesslevel {player} admin
setaccesslevel {player} moderator
setaccesslevel {player} noneServer Messages:
servermsg "Welcome VIP member {player}!"
servermsg "{player} just purchased {product_name}!"Teleport:
teleport {player} 1000 1000 0Common Item IDs:
| Category | Items |
|---|---|
| Weapons | Base.Axe, Base.BaseballBat, Base.RifleHunting, Base.Shotgun, Base.Pistol |
| Ammo | Base.Bullets9mmBox, Base.ShotgunShellsBox, Base.223Box |
| Medical | Base.FirstAidKit, Base.Bandage, Base.Pills |
| Tools | Base.Hammer, Base.Saw, Base.Wrench |
| Storage | Base.Bag_BigHikingBag, Base.Bag_DuffleBag |
| Building | Base.Plank, Base.NailsBox, Base.Generator |
Rust
Give Items:
inventory.giveto {steam_id} wood 1000
inventory.giveto {steam_id} stones 1000
inventory.giveto {steam_id} metal.fragments 500Give Weapons:
inventory.giveto {steam_id} rifle.ak 1
inventory.giveto {steam_id} ammo.rifle 128Grant Permissions:
oxide.grant user {steam_id} vip.kit
oxide.grant user {steam_id} autoauth.useRevoke Permissions:
oxide.revoke user {steam_id} vip.kitServer Messages:
say {player} just purchased VIP status!Common Item Shortnames:
| Category | Items |
|---|---|
| Resources | wood, stones, metal.fragments, metal.refined, sulfur |
| Weapons | rifle.ak, rifle.bolt, smg.thompson, pistol.semiauto |
| Explosives | explosive.timed, rocket.launcher, ammo.rocket.basic |
| Building | wall.external.high, gates.external.high |
| Tools | pickaxe, hatchet, chainsaw |
| Medical | syringe.medical, largemedkit |
Valheim
Spawn Items:
spawn Coins 100
spawn SwordIron 1
spawn ArmorBronzeChest 1Spawn Multiple Items:
spawn SwordBlackmetal 1
spawn ShieldBlackmetal 1
spawn ArmorPaddedCuirass 1
spawn ArmorPaddedGreaves 1
spawn Coins 500Common Item IDs:
| Category | Items |
|---|---|
| Currency | Coins |
| Swords | SwordIron, SwordSilver, SwordBlackmetal |
| Axes | AxeIron, AxeBlackMetal |
| Bows | BowHuntsman, BowDraugrFang |
| Armor (Chest) | ArmorIronChest, ArmorWolfChest, ArmorPaddedCuirass |
| Armor (Legs) | ArmorIronLegs, ArmorWolfLegs, ArmorPaddedGreaves |
| Helmets | HelmetIron, HelmetDrake, HelmetPadded |
| Food | SerpentStew, LoxMeatPie, MeadHealthMajor |
| Resources | Iron, BlackMetal, DragonTear |
Admin Commands
Rust Plugin
In-game commands (requires pixlpay.admin permission):
| Command | Description |
|---|---|
/pixlpay status | Show plugin status and connection info |
/pixlpay poll | Force poll for pending commands |
/pixlpay queue | Show pending deliveries |
/pixlpay history [count] | Show command history |
/pixlpay test | Test API connection |
/pixlpay debug | Toggle debug mode |
/pixlpay heartbeat | Send heartbeat to API |
Valheim Plugin
No in-game commands. Configure via BepInEx config file.
Go Agent
Interactive mode commands (run with -interactive flag):
| Command | Description |
|---|---|
status | Show agent status and configuration |
poll | Force immediate poll |
queue | Show pending deliveries |
history [count] | Show last N executed commands |
test | Test API connection |
debug | Toggle debug mode |
heartbeat | Send heartbeat |
help | Show all commands |
quit | Stop the agent |
Best Practices
Testing Commands
Always test commands before adding to products:
- Test manually first - Run the exact command in your game console
- Verify item IDs - Item IDs are case-sensitive in most games
- Check placeholders - Make sure placeholder format is correct
- Test with a real purchase - Do a test purchase to verify end-to-end
Command Design
Do:
- Keep commands simple and focused
- Test commands with different quantities
- Include error handling commands where possible
- Document what each command does
Don't:
- Use commands that might fail silently
- Assume player inventory has space
- Use admin-only commands that may break
- Chain too many commands together
Quantity Handling
The {quantity} placeholder is useful for stackable items:
give {player} diamonds {quantity}For single items, use a literal 1:
give {player} special_sword 1Refund/Chargeback Commands
Always configure refund and chargeback commands:
# Refund - remove items gently
take {player} purchased_item {quantity}
notify {player} "Your purchase has been refunded."
# Chargeback - remove items and potentially punish
take {player} purchased_item {quantity}
ban {player} "Payment disputed - contact support"Troubleshooting
Command Not Working
- Test the exact command in game console
- Check for typos in item IDs
- Verify placeholder syntax
- Enable debug mode and check logs
Player Not Receiving Items
- Check if player needs to be online
- Verify player identifier is correct
- Check inventory space
- Look for error messages in logs
Multiple Commands Failing
- Check if earlier command failed
- Commands run sequentially - earlier failure may affect later ones
- Test each command individually
