UG_RRobots 1.3 → 2.0

data/doc/install_fr.rdoc

@@ -0,0 +1,86 @@
+= Installation
+
+== Téléchargement
+
+UG_RRobots peut se télécharger depuis :
+
+http://www.ultragreen.net/projects/rrobots/files
+
+On choisit, soit le Gem déja construit, soit le tar.gz si on veut modifier le projet avant installation 
+Les fichiers sont classés par Release
+
+== création 
+
+*Remarque* : Cette étape n'est necessaire que si on choisit de télécharger les sources 
+
+Exemple version 2.0 :
+
+  $  wget http://www.ultragreen.net/attachments/download/51/UG_RRobots-2.0.tgz
+  $ tar xvzf G_RRobots-2.0.tgz
+  $ cd UG_RRobots-2.0/
+  $ rake clean
+  $ rake clobber
+  $ rake gem 
+  $ rake package # pour refaire le tgz 
+
+le gem et le tgz sont dans le sous-répertoire pkg
+si vous installez depuis le gem fraîchement crée la partie wget du Rubygem est à remplacer par la commande 
+
+  $ cd pkg
+
+sinon pour récupéré le gem 
+
+  $ wget http://www.ultragreen.net/attachments/download/52/UG_RRobots-2.0.gem
+
+== Installation gem
+
+On doit être root pour installer  :
+
+  $ sudo bash
+  # gem install UG_RRobots-2.0.gem
+
+Pour désinstaller :
+
+  $ sudo bash
+  # gem uninstall UG_RRobots
+
+
+== Configuration
+
+=== Format du fichier
+
+fichier YAML : rrobots.yaml
+
+  battlefield: 
+    :width: 800
+    :height: 800
+  bullets: 
+    :speed: 30
+  filename: rrobots.yml
+  game: 
+    :timeout: 50000
+  mines: 
+    :with_mines: false
+    :bullet_energy_resistance: 2
+    :energy_hit_points: 20
+  robots: 
+    :nb_mines: 3
+    :radar_mine_scanning_performance: 500
+    :energy_max: 100
+  toolboxes: 
+    :energy_heal_points: 20
+    :life_time: 200
+    :with_toolboxes: false
+    :spawning_chances: 100
+
+
+=== priorité de lecture des fichiers
+
+UG_RRobots possède toutes ses valeurs par défaut en dur dans le code , la configuration par défaut écrite dans :
+
+ GEM_PATH/config/rrobots.yml
+
+est identique à ces valeurs, mais on peut la modifier.
+Grâce à l'argument -write-config de la commande rrobots on peut cloner cette config dans le path ou on execute le jeu.
+Si on n'utilise pas l'argument -ignore-config, Le jeu lit ensuite (merge) les différences entre les valeurs par défaut, puis celle de la config principale, puis celle du fichier dans le PATH.
+Sinon, le fichier de config dans le PATH est ignoré.

data/doc/manual.rdoc

@@ -57,8 +57,10 @@ By including Robot you get all this methods to controll your bot:
 - *turn_gun*(_degrees_)   turns the gun (and the radar), max 30 degrees per tick
 - *turn_radar*(_degrees_) turns the radar, max 60 degrees per tick
 - *dead*                  true if you are dead
-- *say*(_msg_)             shows msg above the robot on screen
-- *broadcast*(_msg_)       broadcasts msg to all bots (they recieve 'broadcasts' events with the msg and rough direction)
+- *say*(_msg_)            shows msg above the robot on screen
+- *broadcast*(_msg_)      broadcasts msg to all bots (they recieve 'broadcasts' events with the msg and rough direction)
+- *team_broadcast*(_msg_) team_broadcasts msg to all bots in your team (they recieve 'team_broadcasts' events with the msg and rough direction)
+- *drop_mine* 			  Drop a mine next to the robot, every robots could drop 3 mines by default
 
 These methods are intentionally of very basic nature, you are free to
 unleash the whole power of ruby to create higher level functions.
@@ -68,58 +70,22 @@ Some words of explanation: The gun is mounted on the body, if you turn
 the body the gun will follow. In a simmilar way the radar is mounted on
 the gun. The radar scans everything it sweeps over in a single tick (100 
 degrees if you turn your body, gun and radar in the same direction) but
-will report only the distance of scanned robots, not the angle. If you 
+will report only the distance of scanned robots, scanned toolboxes or scanned mines, not the angle. If you 
 want more precission you have to turn your radar slower.
 UG RRobots Fork introduce toolboxes, toolboxes could spawn during a match and if a robot run over it, the toolbox heal it of a default value of 20 energy point.
-Toolboxes could be scan separatly of the robots (events keys scanned_toolboxes)
+Toolboxes could be scan separatly of the robots (events keys toolbox_scanned)
 The toolbox mode is optionnal 
+Mines could be scan separatly (events keys mine_scanned) 
+
+Mines could be dropped by robots, scan by others robots and kill with Bullets with à default energy > 2 
 
 RRobots is implemented in pure ruby using a tk ui and should run on all
 platforms that have ruby and tk. (until now it's tested on windows, OS X
 and several linux distributions)
 
-=== To start a match call:
-
-<pre>
-ruby rrobots.rb [resolution] [#match] [-nogui] [-speed=<N>] [-with-toolboxes] [-timeout=<N>] <FirstRobotClassName[.rb]> <SecondRobotClassName[.rb]> <...>
-	  
-  [resolution] (optional) should be of the form 640x480 or 800*600. 
-    default is 800x800
-  [match] (optional) to replay a match, put the match# here, including 
-    the #sign.
-  [-nogui] (optional) run the match without the gui, for highest possible 
-    speed.(ignores speed value if present)
-  [-speed=<N>] (optional, defaults to 1) updates GUI after every N ticks.  
-    The higher the N, the faster the match will play.
-  [-timeout=<N>] (optional, default 50000) number of ticks a match will 
-    last at most.
-  [-ignore-config] (optional) to ignore the config file YAML present in the path.
-  [-write-config] (optional) to write the config in YAML in a file in the path.
-  [-with-toolboxes] (optional) to accept the spawning of healing toolboxes (randomly).
-</pre>
-  
-the names of the rb files have to match the class names of the robots (up to 8 robots)
-
-e.g. 
-  'ruby rrobots.rb SittingDuck NervousDuck'
-or 
-  'ruby rrobots.rb 600x600 #1234567890 SittingDuck NervousDuck'
-
-=== If you want to run a tournament call:
-
-<pre>
-ruby tournament.rb [-timeout=<N>] [-matches=<N>] [-with-toolboxes] (-dir=<Directory> | <RobotClassName[.rb]>+)
-
-  [-timeout=<N>] (optional, default 10000) number of ticks a match 
-    will last at most.
-  [-matches=<N>] (optional, default 2) how many times each robot 
-    fights every other robot.
-  -dir=<Directory> All .rb files from that directory will be 
-    matched against each other.
-  [-ignore-config] (optional) to ignore the config file YAML present in the path.
-  [-with-toolboxes] (optional) to accept the spawning of healing toolboxes (randomly). 
-</pre>
+== Usage
 
+:include:usage.rdoc
 
 the names of the rb files have to match the class names of the robots.
 Each robot is matched against each other 1on1. The results are available 

data/doc/manual_fr.rdoc

@@ -19,7 +19,7 @@ Tous les robots ont les même caractéristiques, et tant que le joueur n'a pas c
 
 === il pourrait ressembler à ceci :
 
-<code language="ruby">
+<code class="ruby">
 require 'robot'
 class NervousDuck
    include Robot
@@ -61,9 +61,11 @@ En incluant le module Ruby Robot vous récupérez les méthodes indispensable po
 - *turn_gun*(_degres_) : tourne votre canon et donc votre radar (max 30 degrés par tick)  
 - *turn_radar*(_degres_) : tourne votre radar (max 60 degrés par tick) 
 - *dead* : renvoie vrai si vous êtes mort
+- *drop_mine* : pose une mine sous le robot (une mine ne peut pas abimer le robot qui l'a posée)
 
 * *say*(_msg_) : affiche un message sur l'écran en mode GUI/TK au dessus de votre robot.
-* *broadcast*(_msg_) : envoie un message à tous les robots sur le champs de bataille, une clef '*broadcast*' est ajouté au hachage '*events*' avec le message
+* *broadcast*(_msg_) : envoie un message à tous les robots sur le champs de bataille, une clef '*broadcast*' est ajouté au hachage '*events*' avec le message et la direction
+- *team_broadcast*(_msg_) envoie un message à tous les robots de votre equipe sur le champs de bataille, une clef '*team_broadcast*' est ajouté au hachage '*events*' avec le message et la direction 
 
 Cette liste de méthode est volontairement réduite et basique, à la charge du joueur créer ses propres méthodes de haut niveau grace à la puissance de Ruby.
 (exemple : move_to, fire_at, etc...)
@@ -73,56 +75,19 @@ Cette liste de méthode est volontairement réduite et basique, à la charge du
 - Le canon est monté sur le corps du robot, donc si vous bougez le robot le canon suit.
 Pareil pour le radar, qui se trouve sur le canon.
 
-- Le radar scan tout se qui trouve sur le rayon de déplacement cumulé du robot, du canon et du radar lui même (mouvement relatif du radar) sur un '*tick*' donné, mais ne renvoi que la distance vers le/les objets scannés (clef *scanned_robots* avec la distance en valeur pour les robots, et clef scanned_toolboxes avec la distance en valeur pour les boites à outils) ceci fait donc un angles d'incertitude maximum de 100°, pour pouvoir être précis il faut bouger votre radar plus doucement.
+- Le radar scan tout se qui trouve sur le rayon de déplacement cumulé du robot, du canon et du radar lui même (mouvement relatif du radar) sur un '*tick*' donné, mais ne renvoi que la distance vers le/les objets scannés (clef *robot_scanned* avec la distance en valeur pour les robots, clef toolbox_scanned avec la distance en valeur pour les boites à outils, clef *mine_scanned*) ceci fait donc un angles d'incertitude maximum de 100°, pour pouvoir être précis il faut bouger votre radar plus doucement.
 
 - UG RRobots Fork introduit les boites à outils, elle sont donc détectables par le radar, lorsqu'un robot passe sur l'une d'elle, il récupère des points d'energie (20 par défaut).
 Les boites à outils apparaissent de façon aléatoire et reste pour une durée définie ( 200 ticks par défaut), chaque tick elle ont la même chance (faible) d'apparaître (1 sur 100 par défaut)
+Les mines déposables peuvent être détecté par les autres robots si il sont suffisamment près d'elle, et dans l'axe du radar (défaut 500 px)
+Les mines sont destructible par l'abus du canon d'un robot de force > (par défaut 2).
 
-UG RRobots Fork comme la version d'origine est implémenté en Ruby pur avec une Interface Graphique TK et peut tourner sur de nombreuses plateformes qui possèdent Ruby et TK, le moteur du jeu en lui même peu très bien se passer de TK.
+UG RRobots Fork, comme la version d'origine, est implémenté en Ruby pur avec une Interface Graphique TK et peut tourner sur de nombreuses plateformes qui possèdent Ruby et TK, le moteur du jeu en lui même peu très bien se passer de TK.
 UG RRobots Fork à été testé sur Windows, la plus part des distributions Linux, FreeBSD et Windows
 
-== Utilisation du moteur de match simple 
+== Utilisation des commandes
 
-<pre>
-  ruby rrobots.rb [resolution] [#match] [-nogui] [-speed=<N>] [-timeout=<N>] [-with-toolboxes] <RobotClassName[.rb]> <RobotClassName[.rb]> <...>
-	  
-  [resolution] (optionel) doit être de la forme 640x480 ou 800*600. 
-    800x800 par défaut
-  [match] (optionel) pour rejouer un match, préciser un numéro de match , avec le signe 
-    # devant.
-  [-nogui] (optionel) lance le match sans GUI/TK, ignore -speed
-  [-with-toolboxes] (optionel) active l'apparition de boite à outils et leurs détections.
-  [-speed=<N>] (optionel, défaut 1) rafraîchit la  GUI après N ticks.  
-    Plus N est grand, plus le match s'affichera vite.
-  [-timeout=<N>] (optionel, defaut 50000) nombre de ticks maximum d'un match
-  [-ignore-config] (optional) pour ignorer la config au format YAML dan un fichier dans le path.
-  [-write-config] (optional) pour ecrire la config au format YAML dan un fichier dans le path.
-</pre>
-
-* le fichier d'un robot doit avoir le même nom que la Classe du Robot
-* (jusqu'à 8 robots)
-
-exemple :
-
-  ruby rrobots.rb SittingDuck NervousDuck'
-
-ou 
-
-  ruby rrobots.rb 600x600 #1234567890 SittingDuck NervousDuck'
-
-== Utilisation du moteur de tournoi :
-
-Pas besoin de TK 
-
-<pre>
-  ruby tournament.rb [-timeout=<N>] [-matches=<N>] (-dir=<Directory> | <RobotClassName[.rb]>+)
-
-  [-timeout=<N>] (optionel, defaut 50000) nombre de ticks maximum d'un match
-  [-with-toolboxes] (optionel) active l'apparition de boite à outils et leurs détections.
-  [-matches=<N>] (optionel, defaut 2) nombre de rounds par match entre deux robots
-  -dir=<Directory> tout les fichiers .rb dans le répertoire seront considérents comme des robots concurents 
-  [-ignore-config] (optional) pour ignorer la config au format YAML dan un fichier dans le path.
-</pre>
+:include:usage_fr.rdoc
 
 - le fichier d'un robot doit avoir le même nom que la Classe du Robot
 - les robots s'affrontes un contre un

data/doc/usage.rdoc

@@ -0,0 +1,56 @@
+=== rrobots
+
+  USAGE: rrobots [resolution] [#match] [-nogui] [-speed=<N>] [-timeout=<N>] [-teams=<N>] [-with-toolboxes] [-with-mines] [-set-locale=<locale>]
+                 <FirstRobotClassName[.rb]> <SecondRobotClassName[.rb]> <...>
+    or : rrobots [-set-locale=<locale>] -list-internals
+    or : rrobots [-set-locale=<locale>] -list-locales
+	or : rrobots [-set-locale=<locale>] -manual 
+	or : rrobots [-set-locale=<locale>]
+
+without arguments : give this usage page
+
+* [-list-internals] (exclusive) give the list of avaibles internals Robots.
+* [resolution] (optional) should be of the form 640x480 or 800*600. default is 800x800.
+* [match] (optional) to replay a match, put the match# here, including the #sign.  
+* [-nogui] (optional) run the match without the gui, for highest possible speed.(ignores speed value if present).
+* [-speed=<N>] (optional, defaults to 1) updates GUI after every N ticks.  The higher the N, the faster the match will play.
+* [-timeout=<N>] (optional, default 50000) number of ticks a match will last at most.
+* [-teams=<N>] (optional) split robots into N teams. Match ends when only one team has robots left.
+* [-with-toolboxes] (optional) to accept the spawning of healing toolboxes (randomly).
+* [-ignore-config] (optional) to ignore the config file present in the path.
+* [-write-config] (optional) to write the config in a file in the path.
+* [-set-locale] (optional) force a locale if avaible in locales list.
+* [-list-locales] (exclusive) list avaible locale.
+* [-manual] (exclusive) give the manual page of RRobots.
+* [-with-mines] (optional) to accept the dropping of mines by the robots (default 3).
+
+
+
+The names of the rb files have to match the class names of the robots
+(up to 8 robots)
+
+e.g. 'rrobots SittingDuck NervousDuck'
+  or 'rrobots 600x600 #1234567890 SittingDuck NervousDuck'
+
+=== tournament
+
+  USAGE : tournament [-timeout=<N>] [-matches=<N>] [-with-toolboxes] [-with-mines] [-set-locale=<locale>] 
+                   (-dir=<Directory> | <RobotClassName[.rb]>+)
+	 or : tournament [-set-locale=<locale>] -list-locales
+	 or : tournament [-set-locale=<locale>] -manual
+	 or : tournament [-set-locale=<locale>]
+	
+without arguments : give this usage page
+	
+* [-timeout=<N>] (optional, default 10000) number of ticks a match will last at most.
+* [-matches=<N>] (optional, default 2) how many times each robot fights every other robot.
+* -dir=<Directory> All .rb files from that directory will be matched against each other.
+* [-ignore-config] (optional) to ignore the config file YAML present in the path.
+* [-with-toolboxes] (optional) to accept the spawning of healing toolboxes (randomly).
+* [-set-locale] (optional) force a locale if avaible in locales list.
+* [-list-locales] (exclusive) list available locales.
+* [-manual] (exclusive) donne la page de manuel du projet RRobots.
+* [-list-internals] (exclusive) give the list of avaibles internals Robots.
+* [-with-mines] (optional) to accept the dropping of mines by the robots (default 3).
+
+This mode doesn't need the TK engine

data/doc/usage_fr.rdoc

@@ -0,0 +1,63 @@
+=== rrobots
+
+  USAGE: rrobots [resolution] [#match] [-nogui] [-speed=<N>] [-timeout=<N>] [-teams=<N>] [-with-toolboxes] [-with-mines] [-set-locale=<locale>]
+                 <FirstRobotClassName[.rb]> <SecondRobotClassName[.rb]> <...>
+    ou : rrobots [-set-locale=<locale>] -list-internals
+    ou : rrobots [-set-locale=<locale>] -list-locales
+	ou : rrobots [-set-locale=<locale>] -manual 
+	ou : rrobots [-set-locale=<locale>]
+	
+Sans arguments : donne cette page d'usage de la commande
+
+
+* [-list-internals] (exclusif) donne la liste des robots disponible en interne.
+* [resolution] (optionel) de la forme 640x480 ou 800x600. (defaut 800x800).
+* [match] (optionel) pour rejouer un match, nommage du format #nombre, enregistre ou rejoue un match.  
+* [-nogui] (optionel) execute le match sans GUI, pour maximiser la vitesse.(ignores l'argument speed si il est présent).
+* [-speed=<N>] (optionel, défaut to 1) maj de la GUI après N ticks. Plus N est grand plus le match est rapide.
+* [-timeout=<N>] (optionel, défaut 50000) nombre de tick max d'un match.
+* [-teams=<N>] (optionel) découpe en N équipes. le match s'arrête quand il ne reste plus qu'un robots ou en timeout.
+* [-with-toolboxes] (optionel) pour accepter l'apparition de boite à outils (aleatoire).
+* [-ignore-config] (optionel) pour ignorer la lecture de la configuration dans le fichier YAML du path.
+* [-write-config] (optionel) pour écrire un dump de la configuration dans le fichier YAML du path.
+* [-set-locale] (optionel) force une locale.
+* [-list-locales] (exclusif) liste les locales disponibles.
+* [-manual] (exclusif) donne la page de manuel du projet RRobots
+* [-with-mines] (optionel) accepte le dépôt de mines parl les robots (default 3).
+
+Remarques :
+* le fichier d'un robot doit avoir le même nom que la Classe du Robot
+* (jusqu'à 8 robots)
+
+Exemple :
+
+  $ rrobots SittingDuck NervousDuck'
+
+ou 
+
+  $ rrobots 600x600 #1234567890 SittingDuck NervousDuck'
+
+
+=== tournament
+
+  USAGE : tournament [-timeout=<N>] [-matches=<N>] [-with-toolboxes] [-with-mines] [-set-locale=<locale>] 
+                     (-dir=<Directory> | <RobotClassName[.rb]>+)
+	 ou : tournament [-set-locale=<locale>] -list-locales
+	 ou : tournament [-set-locale=<locale>] -manual
+	 ou : tournament [-set-locale=<locale>]
+	
+Sans arguments : donne cette page d'usage de la commande 
+
+* [-timeout=<N>] (optionel, defaut 10000) nombre de tick max d'un match.
+* [-matches=<N>] (optionel, defaut 2) nombre de face à face par couple de 2 robots.
+* -dir=<Directory> tout les fichiers .rb de ce répertoire s'affronte par match réciproque.
+* [-ignore-config] (optionel) pour ignorer la lecture de la configuration dans le fichier YAML du path.
+* [-with-toolboxes] (optionel) active le mode d'apparition de boites à outils. 
+* [-set-locale] (optionel) force un locale.
+* [-list-locales] (exclusif) liste les locales disponibles.
+* [-manual] (exclusif) donne la page de manuel du projet RRobots.
+* [-list-internals] (exclusif) donne la liste des robots disponible en interne.
+* [-with-mines] (optionel) accepte le dépôt de mines parl les robots (default 3).
+
+Ce mode n'a pas besoin de TK
+

data/lib/battlefield.rb

@@ -1,3 +1,7 @@
+require 'toolboxes'
+require 'explosions'
+require 'bullets'
+require 'mines'
 
 class Battlefield
    attr_reader :width
@@ -7,15 +11,16 @@ class Battlefield
    attr_reader :bullets
    attr_reader :explosions
    attr_reader :toolboxes
+   attr_reader :mines
    attr_reader :time
    attr_reader :seed
    attr_reader :timeout  # how many ticks the match can go before ending.
    attr_reader :game_over
-   attr_reader :toolboxes
    attr_reader :with_toolboxes
+   attr_reader :with_mines
    attr_reader :config
 
-  def initialize width, height, timeout, seed, with_toolboxes, merge, write_config
+  def initialize width, height, timeout, seed, with_toolboxes, with_mines, merge, write_config
     filename = "rrobots.yml"
     @config = Configuration::new
     @path_prefix = gem_path('config')
@@ -36,6 +41,8 @@ class Battlefield
     @time = 0
     @robots = []
     @toolboxes = []
+    @mines = []
+    @with_mines = (self.config.mines[:with_mines] != with_mines)? with_mines : self.config.mines[:with_mines]
     @with_toolboxes = (self.config.toolboxes[:with_toolboxes] != with_toolboxes)? with_toolboxes : self.config.toolboxes[:with_toolboxes]
     @teams = Hash.new{|h,k| h[k] = [] }
     @bullets = []
@@ -56,6 +63,8 @@ class Battlefield
       @explosions << object
     when Toolbox
       @toolboxes << object 
+    when Mine
+      @mines << object
     end
   end
 
@@ -66,6 +75,9 @@ class Battlefield
     toolboxes.delete_if{|toolbox| toolbox.dead}
     toolboxes.each{|toolbox| toolbox.tick}
 
+    mines.delete_if{|mine| mine.dead}
+    mines.each{|mine| mine.tick}
+
     bullets.delete_if{|bullet| bullet.dead}
     bullets.each{|bullet| bullet.tick}
     
@@ -75,7 +87,7 @@ class Battlefield
       begin
         robot.send :internal_tick unless robot.dead
       rescue Exception => bang
-        puts "#{robot} made an exception:"
+        puts I18n.t('battlefield.robot_made_an_exception', :robot => robot)
         puts "#{bang.class}: #{bang}", bang.backtrace
         robot.instance_eval{@energy = -1}
       end
@@ -91,9 +103,10 @@ class Battlefield
 
   def state
     {:explosions => explosions.map{|e| e.state},
-     :bullets    => bullets.map{|b| b.state},
-     :toolboxes    => toolbox.map{|t| t.state},
-     :robots     => robots.map{|r| r.state}}
+     :bullets => bullets.map{|b| b.state},
+     :toolboxes => toolboxes.map{|t| t.state},
+     :mines => mines.map{|m| m.state},
+     :robots => robots.map{|r| r.state}}
   end
   
   def spawning_toolboxes