Game command reference
Configure purchase, renewal, and expiry commands, ID placeholders, multiple lines, previews, and retries.
Last updated:
Command fields
In the product's game-delivery settings, select the destination and configure these fields.
| Field | When it runs | Example use |
|---|---|---|
| Purchase command | When a purchase activates the benefit | Grant VIP access |
| Renewal command | When a recurring purchase payment completes | Extend a plugin-managed expiry |
| Benefit expiry command | When expiry, refund, or an administrative action ends the benefit | Remove VIP access |
Scheduling renewal cancellation and reaching the benefit's end are different events. The game or plugin must provide a command for the requested action.
Insert player IDs
Use {{id.<key>}} to substitute the buyer's ID. Replace <key> with the ID key used by the product.
| Placeholder | ID |
|---|---|
{{id.steam64}} | Steam64 ID |
{{id.epic}} | Epic Account ID |
{{id.eos}} | EOS Product User ID |
{{id.playerId}} | Player ID |
{{id.charId}} | Character ID |
- Focus the command field.
- Select an ID and insert its placeholder.
- Enter the surrounding command according to the plugin documentation.
- Check the required IDs and the preview below the field.
Save the placeholder, such as {{id.playerId}}, instead of replacing it with a fixed player name. Do not require unrelated IDs.
Configuration example
This example uses the vip group in LuckPerms on Minecraft Java Edition. See game setup for prerequisites.
Purchase:
lp user {{id.playerId}} parent add vipBenefit expiry:
lp user {{id.playerId}} parent remove vipThese are ordinary group additions and removals, so the renewal field is empty. A plugin that manages its own expiry may require a renewal command.
Multiple commands
- Enter one command per line.
- Empty lines are omitted; commands run from top to bottom.
- A failure stops the remaining lines.
- Each field allows up to 1,000 characters in total. The Agent also checks a 1,000-byte limit after ID substitution.
Do not join commands with separators such as semicolons instead of newlines. Fix syntax errors before saving.
Read the preview
The preview substitutes sample IDs. It neither sends a command to the game nor saves the product. Check the ID type, spaces, and argument positions, then verify execution with a test recipient.
If an existing product references saved command settings, checked operations retain those settings when the field is empty. Entering a command replaces them; unchecking an operation removes it. An empty field alone does not mean the saved action was deleted.
Retry failed processing
Inspect the completed range and failed line in processing history. Eligible retries omit commands already known to have succeeded.
Check the game first if the outcome is unknown
Do not repeat a command with an uncertain outcome, including a single command that timed out. Check game state and logs, then follow recovery instructions.