This wiki was in read-only mode for many years, but can now be edited again. A lot of information will need to be updated.

BZRobots/Protocol: Difference between revisions

From BZFlagWiki
Jump to navigation Jump to search
← Older edit
Daxxar (talk | contribs)
25 edits
Bulldozer (talk | contribs)
58 edits
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== BZRobots Enhanced Protocol ==
=Overview=
This page describes the [[BZRobots]] Enhanced Protocol that forms the internals of the BZFlag Programmable Computer Player Client


This is a draft of the protocol that's being planned for the new bzrobots as a part of GSoC. The protocol is inspired by the API it will convey the messages of, which in turn is inspired by [http://robocode.sourceforge.net RoboCode]. ;-)
=Description=
The [[BZRobots]] client currently consists of two parts called the "backend" and the "frontend". The "backend" is a lightweight game client that communicates with BZFS. It also runs a lightweight line-by-line text-based server, on which commands can be sent to control a robot. The "frontend" is an instance of a BZAdvancedRobot, including the necessary parts to communicate with the "backend".


{| cellspacing="0" border="1"
==Available Commands==
|+ Backend -> frontend messages
See the [[BZRobots/API]] for the commands currently available to the BZRobots protocol.
!Message syntax
!Description
|-
|SOME_COMMAND_HERE <float>
|THIS RUNS SOME COMMAND WITH FLOAT ARGUMENT
|}


{| cellspacing="0" border="1"
==Legacy==
|+ Frontend -> backend messages
Eventually, in an effort to simplify the internals of BZRobots, the "frontend" and "backend" will likely be altogether removed, thereby eliminating the internal protocol. It is recommended to develop bots in C or Python using the published API, rather than attempting to develop a seperate client for the BZRobot backend.
!Message syntax
!Description
|-
|setAhead <distance>
|Sets planned movement (for next 'execute') that moves 'distance' units.
|-
|setBack <distance>
|Sets planned movement backwards, same as setAhead -distance
|-
|setTurnLeft <degrees>
|Sets planned turn (for next 'execute') that turns 'degrees' degrees to the left.
|-
|setTurnRight <degrees>
|Sets planned turn (for next 'execute') that turns 'degrees' degrees to the right, same as setTurnLeft -degrees.
|-
|setFire
|Sets a planned shot (for next 'execute')
|-
|setTurnRate
|Sets next actions turnrate. (for next 'execute')
|-
|setSpeed
|Sets next actions speed. (for next 'execute')
|-
|getDistanceRemaining
|Gives a 'distanceRemaining'-reply with how much is left of the currently planned movement.
|-
|getTurnRemaining
|Gives a 'turnRemaining'-reply with how much is left of the currently planned turn.
|-
|execute
|Runs a tick of the 'planned actions', and replies with a 'tick over' when the tick has passed.
|}

Latest revision as of 06:14, 4 August 2009

Overview

This page describes the BZRobots Enhanced Protocol that forms the internals of the BZFlag Programmable Computer Player Client

Description

The BZRobots client currently consists of two parts called the "backend" and the "frontend". The "backend" is a lightweight game client that communicates with BZFS. It also runs a lightweight line-by-line text-based server, on which commands can be sent to control a robot. The "frontend" is an instance of a BZAdvancedRobot, including the necessary parts to communicate with the "backend".

Available Commands

See the BZRobots/API for the commands currently available to the BZRobots protocol.

Legacy

Eventually, in an effort to simplify the internals of BZRobots, the "frontend" and "backend" will likely be altogether removed, thereby eliminating the internal protocol. It is recommended to develop bots in C or Python using the published API, rather than attempting to develop a seperate client for the BZRobot backend.

Retrieved from "https://wiki.bzflag.org/index.php?title=BZRobots/Protocol&oldid=6592"