Documentation

Examples / Use Cases

Practical ways to use PlayerBatch for testing, scrims, scenario setup, and extension-driven workflows.

PvP Scrim Setup#

Use combat presets and group AI to stand up repeatable sparring scenes quickly:

text
/pb presets save duel combat 2 -diamondarmor -diamondtools -shield
/pb presets use duel
/pb selection all
/pb ai set combat

This works well when you want a consistent baseline fight setup over multiple test sessions.

Focus Fire / Multi-Target Combat#

If you want selected bots to hunt exact targets instead of free-picking everything nearby:

text
/pb selection all
/pb combat on
/pb target kill @a[name=Sam]

Or split pressure across multiple targets:

text
/pb selection all
/pb combat on
/pb target kill @a[name=Sam] @a[name=W4Whiskers]

This is useful for:

  • scripted fights
  • controlled 2vX scenes
  • survival chase testing
  • forcing one wave to pressure a known player set

Load Testing Fake-Player Volume#

If you are benchmarking command handling, mob density side effects, or server behavior under player-like load:

text
/pb config limit 256
/pb config spawns_per_tick 4
/pb spawn 128

The queue keeps the spawn operation from trying to land all bots in one instant burst.

Formation Testing#

Formation-aware summoning is useful for arena validation, scripted scene setup, and quickly comparing spacing:

text
/pb spawn 16 circle
/pb spawn 16 square
/pb spawn 16 triangle
/pb spawn 16 dense

Loadout Reuse With Kits#

If you frequently run the same scenario, save the gear configuration once and reuse it:

text
/pb kits save ranked
/pb spawn 8 random kit{ranked} -diamondarmor -diamondtools

This is much faster than reapplying equipment item-by-item every session.

Range-Based Control#

When you only want to operate on nearby bots:

text
/pb selection range 20
/pb run move forward
/pb ai set follow

That makes PlayerBatch useful for zone-specific testing instead of only whole-server batches.

ExtAPI Use Case#

An external add-on can define:

  • a new formation such as arena_ring
  • a summon token for scenario metadata
  • a custom behavior like guard_owner

That keeps custom workflows outside the main mod while still integrating directly with PlayerBatch's summon pipeline.

  • combat testing
  • server-side behavior rehearsals
  • fake-player scenario bootstrapping
  • command load testing
  • add-on development against the public API
Example combined workflow
text
/pb kits save frontline
/pb presets save raid combat 12 -ironarmor -irontools -shield -reach{3}
/pb presets use raid 24
/pb selection all
/pb group create wave1
/pb group assign wave1
/pb ai set combat+follow group wave1