golemTest your plugin the way players use it

One command boots a real PocketMine-MP server, loads your plugin from source and fills it with simulated players. No mocks, no client, no more testing by hand.

Get started

Write your first test

View on GitHub

🖥️

A real server

Your plugin runs on the PocketMine-MP version you pick, with every event fired in the real order. If it passes in Golem, it works in production.

🧍

Simulated players

Golems are genuine Player objects behind a fake network session. They join, chat, run commands, click forms, break blocks and get kicked.

What golems can do

⏱️

Time is a first-class citizen

Tests are generators. Yield a golem, a number of ticks or a condition, and the test resumes when it is ready. Cooldowns and delayed tasks become testable.

Waiting in tests

📦

Zero setup

Golem downloads the official PocketMine PHP build and server phar once, caches them, and creates a fresh world for every run.

🔎

Failures you can read

Expected versus actual, the failing line of your test, and the server log when something crashes. Minecraft-aware assertions included.

All assertions

✅

Made for CI

JUnit reports, failures annotated on the pull request, and a GitHub Action that fits in one line.

Set up CI

Twenty seconds of Golem

A test spawns Steve, he joins a real server, gets greeted, and the test checks it. Then the same thing for every behaviour of your plugin, in one command.

php

public function testGreetsPlayersByName(): Generator
{
    $steve = yield $this->golem('Steve');

    $this->assertReceivedMessage($steve, 'Welcome, Steve!');
    $this->assertHasItem($steve, VanillaItems::BREAD(), 3);
}

Three steps

From a plugin with no tests to a green run in about five minutes.

Install

Golem is a dev dependency. The CLI itself needs nothing else.

bash

composer require --dev achedon12/golem

Scaffold

A first test and a GitHub Actions workflow.

bash

vendor/bin/golem init

Run

Boots a server, runs every test, stops it.

bash

vendor/bin/golem

Results as they happen

Each test reports as soon as it finishes, with how long it took in milliseconds and server ticks. This is the real output of the example plugin shipped with Golem.

Golem output: every test of the example plugin passing

And when it breaks

You see what was expected, what the server actually sent, and the exact line of your test.

A failing test with expected and actual values and the failing line

Every pull request, tested

Add one step to your workflow. PocketMine is cached between runs, a JUnit report is written, and failures are annotated right on the diff.

yaml

jobs:
  golem:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - uses: achedon12/golem@v0

Stop testing your plugin by hand

Golem is open source (MIT) and young: feedback shapes what comes next.

Get started

Join the discussion

golemTest your plugin the way players use it

A real server

Simulated players

Time is a first-class citizen

Zero setup

Failures you can read

Made for CI

Twenty seconds of Golem ​

Three steps ​

Install ​

Scaffold ​

Run ​

Results as they happen ​

And when it breaks ​

Every pull request, tested ​

Stop testing your plugin by hand ​

Twenty seconds of Golem

Three steps

Install

Scaffold

Run

Results as they happen

And when it breaks

Every pull request, tested

Stop testing your plugin by hand