API Reference - Plugwright

`player` / `bot` Object

The player or bot object represents a real Minecraft client connected to the test server.

Sends a chat message or command.

message

string

required

The message or command to send.

player.chat('/spawn');

Waits for a GUI to open matching the title and returns a live handle.

options.title

string | RegExp

required

Pattern to match GUI title.

const gui = await player.gui({ title: 'Shop' });
const button = gui.locator(i => i.getDisplayName().includes('Confirm'));

inventory

Inventory

Access the player’s current inventory state.

username

string

The randomly generated or assigned name of the bot.

The server object gives you control over the backend Minecraft server.

Executes a command from the server console.

command

string

required

The console command to execute.

server.execute(`give ${player.username} diamond 64`);