The Lua binding

The Clunkyard robot API in Lua 5.4, through a generated C module linked to the robot core. The arena supplies the binding; a robot carries its own source and imports clunkyard. No compiler runs in the robot container.

Install with make install SDK=/opt/clunkyard/sdk. Run with LUA_PATH='/opt/clunkyard/sdk/bindings/lua/?.lua;;' LUA_CPATH='/opt/clunkyard/sdk/bindings/lua/?.so;;' lua5.4 bot.lua. The shim loads libclunkyard.so.2 from the SDK.

Facts are properties, calls use Lua's colon syntax, and controls take a table of the fields to set. Later calls merge with earlier ones in the same tick. Records are tables and an absent result is nil. cy.forfeit(code, message) forfeits the match. Other errors are logged with their trace; the turn sends the controls already set. cy.play(robot, lines) plays protocol lines in memory for tests.

A tiny robot

local cy = require("clunkyard")
local bot = {}

function bot:on_turn()
  local target = self.sensors.nearest
  if not target then
    self.drive:set({throttle=0.75, turn=0.25})
    self.scanner:set({heading=self.me.heading, arc=40})
    self.status:set({text="SEARCH", value=self.scanner.last.arc})
    return
  end
  local power = self.gun:power_for_flight_time(target.range, 1)
  local aim = self.gun:lead(target, power)
  self.gun:aim({heading=aim and aim.heading or target.bearing,
    pitch=aim and aim.pitch or target.elevation})
  if self.gun:can_fire(power, 10) then self.gun:fire({power=power}) end
  self.drive:set({throttle=0.5,
    turn=cy.angles:clamp(cy.angles:angle_diff(target.bearing, self.me.heading))})
  self.scanner:set({heading=target.bearing, arc=10})
  self.status:set({text="TRACK", value=target.range})
end

cy.run(bot)

make test SDK=... checks the generated API against every core vector, including exact floating-point results and act lines. The declarations, record conversions, wrapper and conformance runner are generated from protocol/v2/api.json; only the runtime integration is specific to Lua.

Names

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

Download this page as Markdown