Skip to content

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:

PlaceholderDescriptionExample Value
{player}Player's game usernameSurvivorSteve
{username}Same as {player}SurvivorSteve
{steam_id}Player's Steam ID (64-bit)76561198012345678
{quantity}Quantity purchased5
{product_name}Name of the productVIP Kit
{order_id}Internal order ID12345
{order_number}Display order numberORD-2025-0001
{customer_email}Customer's emailplayer@example.com
{customer_name}Customer's nameJohn Doe

Using Placeholders

Place placeholders directly in your command text:

give {player} diamond_sword 1

When executed, this becomes:

give SurvivorSteve diamond_sword 1

Multiple 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 chargeback

Game-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 1000

Set Access Level:

setaccesslevel {player} admin
setaccesslevel {player} moderator
setaccesslevel {player} none

Server Messages:

servermsg "Welcome VIP member {player}!"
servermsg "{player} just purchased {product_name}!"

Teleport:

teleport {player} 1000 1000 0

Common Item IDs:

CategoryItems
WeaponsBase.Axe, Base.BaseballBat, Base.RifleHunting, Base.Shotgun, Base.Pistol
AmmoBase.Bullets9mmBox, Base.ShotgunShellsBox, Base.223Box
MedicalBase.FirstAidKit, Base.Bandage, Base.Pills
ToolsBase.Hammer, Base.Saw, Base.Wrench
StorageBase.Bag_BigHikingBag, Base.Bag_DuffleBag
BuildingBase.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 500

Give Weapons:

inventory.giveto {steam_id} rifle.ak 1
inventory.giveto {steam_id} ammo.rifle 128

Grant Permissions:

oxide.grant user {steam_id} vip.kit
oxide.grant user {steam_id} autoauth.use

Revoke Permissions:

oxide.revoke user {steam_id} vip.kit

Server Messages:

say {player} just purchased VIP status!

Common Item Shortnames:

CategoryItems
Resourceswood, stones, metal.fragments, metal.refined, sulfur
Weaponsrifle.ak, rifle.bolt, smg.thompson, pistol.semiauto
Explosivesexplosive.timed, rocket.launcher, ammo.rocket.basic
Buildingwall.external.high, gates.external.high
Toolspickaxe, hatchet, chainsaw
Medicalsyringe.medical, largemedkit

Valheim

Spawn Items:

spawn Coins 100
spawn SwordIron 1
spawn ArmorBronzeChest 1

Spawn Multiple Items:

spawn SwordBlackmetal 1
spawn ShieldBlackmetal 1
spawn ArmorPaddedCuirass 1
spawn ArmorPaddedGreaves 1
spawn Coins 500

Common Item IDs:

CategoryItems
CurrencyCoins
SwordsSwordIron, SwordSilver, SwordBlackmetal
AxesAxeIron, AxeBlackMetal
BowsBowHuntsman, BowDraugrFang
Armor (Chest)ArmorIronChest, ArmorWolfChest, ArmorPaddedCuirass
Armor (Legs)ArmorIronLegs, ArmorWolfLegs, ArmorPaddedGreaves
HelmetsHelmetIron, HelmetDrake, HelmetPadded
FoodSerpentStew, LoxMeatPie, MeadHealthMajor
ResourcesIron, BlackMetal, DragonTear

Admin Commands

Rust Plugin

In-game commands (requires pixlpay.admin permission):

CommandDescription
/pixlpay statusShow plugin status and connection info
/pixlpay pollForce poll for pending commands
/pixlpay queueShow pending deliveries
/pixlpay history [count]Show command history
/pixlpay testTest API connection
/pixlpay debugToggle debug mode
/pixlpay heartbeatSend heartbeat to API

Valheim Plugin

No in-game commands. Configure via BepInEx config file.

Go Agent

Interactive mode commands (run with -interactive flag):

CommandDescription
statusShow agent status and configuration
pollForce immediate poll
queueShow pending deliveries
history [count]Show last N executed commands
testTest API connection
debugToggle debug mode
heartbeatSend heartbeat
helpShow all commands
quitStop the agent

Best Practices

Testing Commands

Always test commands before adding to products:

  1. Test manually first - Run the exact command in your game console
  2. Verify item IDs - Item IDs are case-sensitive in most games
  3. Check placeholders - Make sure placeholder format is correct
  4. 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 1

Refund/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

  1. Test the exact command in game console
  2. Check for typos in item IDs
  3. Verify placeholder syntax
  4. Enable debug mode and check logs

Player Not Receiving Items

  1. Check if player needs to be online
  2. Verify player identifier is correct
  3. Check inventory space
  4. Look for error messages in logs

Multiple Commands Failing

  1. Check if earlier command failed
  2. Commands run sequentially - earlier failure may affect later ones
  3. Test each command individually

Resources

Built for game developers, by game developers.