Acme::RTB - Perl extension for building realtimebattle bots


Acme-RTB documentation  | view source Contained in the Acme-RTB distribution.

Index


NAME

Top

Acme::RTB - Perl extension for building realtimebattle bots

SYNOPSIS

Top

  use Acme::RTB;
  my $robot = Acme::RTB->new({  Name    => 'Anarion PerlBot 1.0',
                                Colour  => 'ff0000 ff0000',
                                Log     => '/home/anarion/perl/rtb/robot.log'} );

  $robot->Start;

DESCRIPTION

Top

This module will allow you to create bots for battling with realtimebattle. http://realtimebattle.sourceforge.net/

METHODS

Top

new

First create an object, you should pass a hashref with the Name, Colour and if you will the logfile.

  my $robot = Acme::RTB->new({  Name    => 'Anarion PerlBot 1.0',
                                Colour  => 'ff0000 ff0000',
                                Log     => '/home/anarion/perl/rtb/robot.log'} );




modify_action

With this method you can change all the actions that your bot do when it recieves a msg from the server, the possible actions are:

                Initialize
                YourName
                YourColour
                GameOption
                GameStarts
                Radar
                Info
                RobotInfo
                RotationReached
                Energy
                RobotsLeft
                Collision
                Warning
                Dead
                GameFinishes
                Unknown




$robot->modify_action( Radar => \&my_radar );

$robot->modify_action( GameStarts => \&my_gamestart);

$robot->modify_action( Collision => \&my_collision);

Here are the parameters that you recieve from the server:

Initialize [first? (int)]

This is the very first message the robot will get. If the argument is one, it is the first sequence in the tournament and it should send Name and Colour to the server, otherwise it should wait for YourName and YourColour messages (see below).

YourName [name (string)]

Current name of the robot, don't change it if you don't have very good reasons.

YourColour [colour (hex)]

Current colour of the robot, change it if you find it ugly.

GameOption [optionnr (int)] [value (double)]

At the beginning of each game the robots will be sent a number of settings, which can be useful for the robot. For a complete list of these, look in the file Messagetypes.h for the game_option_type enum. In the options chapter you can get more detailed information on each option. The debug level is also sent as a game option even though it is not in the options list.

GameStarts

This message is sent when the game starts (surprise!)

Radar [distance (double)] [observed object type (int)] [radar angle (double)]

This message gives information from the radar each turn. Remember that the radar-angle is relative to the robot front; it is given in radians.

Info [time (double)] [speed (double)] [cannon angle (double)]

The Info message does always follow the Radar message. It gives more general information on the state of the robot. The time is the game-time elapsed since the start of the game. This is not necessarily the same as the real time elapsed, due to time scale and max timestep.

Coordinates [x (double)] [y (double)] [angle (double)]

Tells you the current robot position. It is only sent if the option Send robot coordinates is 1 or 2. If it is 1 the coordinates are sent relative the starting position, which has the effect that the robot doesn't know where it is starting, but only where it has moved since.

RobotInfo [energy level (double)] [teammate? (int)]

If you detect a robot with your radar, this message will follow, giving some information on the robot. The opponents energy level will be given in the same manner as your own energy (see below). The second argument is only interesting in team-mode (which current isn't implemented), 1 means a teammate and 0 an enemy.

RotationReached [what has reached(int)]

When the robot option SEND_ROTATION_REACHED is set appropriately, this message is sent when a rotation (with RotateTo or RotateAmount) has finished or the direction has changed (when sweeping). The argument corresponds to 'what to rotate' in e.g. Rotate.

Energy [energy level(double)]

The end of each round the robot will get to know its energy level. It will not, however, get the exact energy, instead it is discretized into a number of energy levels.

RobotsLeft [number of robots (int)]

At the beginning of the game and when a robot is killed the number of remaining robots is broadcasted to all living robots.

Collision [colliding object type (int)] [angle relative robot (double)]

When a robot hits (or is hit by) something it gets this message. In the file Messagetypes.h you can find a list of the object types. You get the angle from where the collision occurred (the angle relative the robot) and the type of object hitting you, but not how severe the collision was. This can, however, be determined indirectly (approximately) by the loss of energy.

Warning [warning type (int)] [message (string)]

A warning message can be sent when robot has to be notified on different problems which have occured. Currently seven different warning messages can be sent, namely

UNKNOWN_MESSAGE: The server received a message it couldn't recognize.

PROCESS_TIME_LOW: The CPU usage has reached the CPU warning percentage. Only in competition-mode.

MESSAGE_SENT_IN_ILLEGAL_STATE: The message received couldn't be handled in this state of the program. For example Rotate is sent before the game has started.

UNKNOWN_OPTION: The robot sent a robot option with either illegal option name or illegal argument to that option.

OBSOLETE_KEYWORD: The keyword sent is obsolete and should not be used any more, see the ChangeLog file for information on what to use instead.

NAME_NOT_GIVEN: The robot has not sent its name before the game begins. This happens if the robot startup time is too short or the robot does not send its name early enough.

COLOUR_NOT_GIVEN: The robot has not sent its colour before the game begins.

Dead

Robot died. Do not try to send more messages to the server until the end of the game, the server doesn't read them.

GameFinishes

Current game is finished, get prepared for the next!

ExitRobot

Exit from the program immediately! Otherwise it will be killed forcefully.

process_lines

This is the method that reads (if it can) from the server and execute the apropiate method. You can manage yourself, or let the module to do it itself.

while(1) { # Read stdin $robot->parse_lines; # do other stuff here

}

Rotate [what to rotate (int)] [angular velocity (double)]

Set the angular velocity for the robot, its cannon and/or its radar. Set 'what to rotate' to 1 for robot, 2 for cannon, 4 for radar or to a sum of these to rotate more objects at the same time. The angular velocity is given in radians per second and is limited by Robot (cannon/radar) max rotate speed.

RotateTo [what to rotate (int)] [angular velocity (double)] [end angle (double)]

As Rotate, but will rotate to a given angle. Note that radar and cannon angles are relative to the robot angle. You cannot use this command to rotate the robot itself, use RotateAmount instead!

RotateAmount [what to rotate (int)] [angular velocity (double)] [angle (double)]

As Rotate, but will rotate relative to the current angle.

Sweep [what to rotate (int)] [angular velocity (dbl)] [left angle (dbl)] [right angle (dbl)]

As rotate, but sets the radar and/or the cannon (not available for the robot itself) in a sweep mode.

Accelerate [value (double)]

Set the robot acceleration. Value is bounded by Robot max/min acceleration.

Brake [portion (double)]

Set the brake. Full brake (portion = 1.0) means that the friction in the robot direction is equal to Slide friction.

Shoot [shot energy (double)]

Shoot with the given energy. The shot options give more information.

Debug [message (string)]

Print message on the message window if in debug-mode.

DebugLine [angle1 (double)] [radius1 (double)] [angle2 (double)] [radius2 (double)]

Draw a line direct to the arena. This is only allowed in the highest debug level(5), otherwise a warning message is sent. The arguments are the start and end point of the line given in polar coordinates relative to the robot.

DebugCircle [center angle (double)] [center radius (double)] [circle radius (double)]

Similar to DebugLine above, but draws a circle. The first two arguments are the angle and radius of the central point of the circle relative to the robot. The third argument gives the radius of the circle.

EXAMPLES

Top

My hello botworld:

  use Acme::RTB;
  my $robot = Acme::RTB->new({  Name    => 'Anarion PerlBot 1.0',
                                Colour  => 'ff0000 ff0000',
                                Log     => '/home/anarion/perl/rtb/robot.log'} );

  $robot->Start;




Example two:

#!/usr/bin/perl

use strict; use warnings; use lib "/home/anarion/perl/rtb";

use Acme::RTB;

my $robot = Acme::RTB->new({ Name => 'Killer Montses', Colour => 'ff0000 ff0000', Log => '/home/anarion/perl/rtb/anarion.log'} );

$robot->modify_action( Radar => \&my_radar );

$robot->modify_action( GameStarts => \&my_gamestart);

$robot->modify_action( Collision => \&my_collision);

$robot->Start;

sub my_radar { my ($self, $dist, $obj, $angle) = @_; for($obj) { /0/ && do { robot($dist,$angle) }; /1/ && do { dodge($dist,$angle) }; /2/ && do { turn($dist,$angle) }; /3/ && do { cookie($dist,$angle) }; /4/ && do { mine($dist,$angle) }; } }

sub my_gamestart { my $self = shift; my $speed = rand(1)+1; my $angle = rand(0.4)-0.8; $self->Accelerate($speed); $self->RotateAmount(7,rand(2),rand(5)); }

sub my_collision { my ($self, $object_type, $angle) = @_; $robot->RotateAmount(7,rand(2),rand(5)-2.5); }

sub robot { my ($dist, $angle) = @_; $robot->RotateTo(7,2,$angle-0.2); $robot->Shoot(10); }

sub dodge { $robot->RotateAmount(7,2,1); }

sub turn { my ($dist, $angle) = @_; if($dist < 10) { $robot->RotateAmount(7,2,rand(5)-2.5); } }

sub cookie { my ($dist, $angle) = @_; $robot->RotateAmount(7,2,$angle); }

sub mine { my ($dist, $angle) = @_; $robot->RotateTo(7,2,$angle); $robot->Shoot(1); }

AUTHOR

Top

Debian User, <anarion@7a69ezine.org>

COPYRIGHT AND LICENSE

Top


Acme-RTB documentation  | view source Contained in the Acme-RTB distribution.