The Ruby binding

The Clunkyard robot API in Ruby, through Fiddle and the core's C ABI. clunkyard/api.rb is generated from protocol/v2/api.json. Only the run loop and exception mapping in clunkyard.rb are written by hand; physics, tracking, parsing and act serialization run in the core.

Install with make install SDK=/opt/clunkyard/sdk. Run a robot with RUBYLIB=/opt/clunkyard/sdk/bindings/ruby ruby bot.rb. The binding loads libclunkyard.so.2, or the file named by CLUNKYARD_LIB.

Subsystems and facts are methods. Optional results are nil; records have named attributes, and enums use their protocol strings. Controls accept positional arguments or keywords and change only the fields supplied. drive.get('throttle') reads a pending field. Raise Clunkyard::Forfeit.new(code, message) to forfeit. Other exceptions are logged with their trace and send the controls already set. Clunkyard.play(robot, lines) plays lines in memory for tests.

A tiny robot

require 'clunkyard'

class Tiny < Clunkyard::Robot
  def on_turn
    target = sensors.nearest
    unless target
      drive.set(throttle: 0.75, turn: 0.25)
      scanner.set(me.heading, 40)
      status.set('SEARCH', scanner.last.arc)
      return
    end
    power = gun.power_for_flight_time(target.range, 1)
    aim = gun.lead(target, power)
    aim ? gun.aim(aim.heading, aim.pitch) : gun.aim(target.bearing, target.elevation)
    gun.fire(power) if gun.can_fire(power, 10)
    drive.set(throttle: 0.5, turn: angles.clamp(angles.angle_diff(target.bearing, me.heading)))
    scanner.set(target.bearing, 10)
    status.set('TRACK', target.range)
  end
end

Clunkyard.run(Tiny.new)

make test SDK=... compares every API vector against the core, including exact floating-point results and act lines. The README robot participates in the cross-language act identity check.

Names

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

Download this page as Markdown