The PHP binding

The Clunkyard robot API in PHP, through the FFI extension and the core's C ABI. The API classes, records and declarations are generated from protocol/v2/api.json; only the run loop and exception mapping are written by hand. Tracking, physics, parsing and serialization stay in the core.

Install with make install SDK=/opt/clunkyard/sdk. Run with php -d ffi.enable=preload -d include_path=/opt/clunkyard/sdk/bindings/php bot.php. The binding loads libclunkyard.so.2, or CLUNKYARD_LIB.

Subsystems are properties and facts are methods. Names use camelCase. Optional results are null; records have public fields and enum values use their protocol strings. Controls accept positional or named arguments and change only supplied fields in the turn. drive->get('throttle') reads a pending field. Throw new Clunkyard\Forfeit(code, message) to forfeit. Other exceptions are logged with their trace and send the controls already set. Clunkyard\play(robot, lines) plays in memory for tests.

A tiny robot

<?php
require 'clunkyard.php';
use Clunkyard as cy;

class Tiny extends cy\Robot {
    public function onTurn():void{
        $target=$this->sensors->nearest();
        if($target===null){
            $this->drive->set(throttle:0.75,turn:0.25);
            $this->scanner->set($this->me->heading(),40);
            $this->status->set('SEARCH',$this->scanner->last()->arc);
            return;
        }
        $power=$this->gun->powerForFlightTime($target->range,1);
        $aim=$this->gun->lead($target,$power);
        $this->gun->aim($aim?->heading??$target->bearing,$aim?->pitch??$target->elevation);
        if($this->gun->canFire($power,10))$this->gun->fire($power);
        $this->drive->set(throttle:0.5,turn:$this->angles->clamp($this->angles->angleDiff($target->bearing,$this->me->heading())));
        $this->scanner->set($target->bearing,10);
        $this->status->set('TRACK',$target->range);
    }
}
cy\run(new Tiny());

make test SDK=... compares every API vector and emitted act with the core's transcript, including exact floating-point bits. The README robot also participates in the cross-language identity check.

Names

Every entry of the robot API 2.0.0 in PHP. names.md has every language side by side.

Download this page as Markdown