UG_RRobots 1.3 → 2.0

data/{RakeFile → Rakefile}

@@ -5,19 +5,19 @@ require "rake/gempackagetask"
 
 spec = Gem::Specification.new do |s| 
   s.name = "UG_RRobots"
-  s.version = "1.3"
+  s.version = "2.0"
   s.author = "Simon Kröger, Romain GEORGES"
   s.email = "dev@ultragreen.net"
   s.homepage = "http://www.ultragreen.net/projects/rrobots"
   s.platform = Gem::Platform::RUBY
   s.summary = "Ultragreen RRobots Fork with new features like toolboxes, config file, gemified"
-  s.files = FileList["{bin,lib,images,config,doc,contribs,robots}/**/*"].to_a.concat(['COPYRIGHT.txt','RakeFile'])
+  s.files = FileList["{bin,lib,images,config,doc,contribs,robots}/**/*"].to_a.concat(['COPYRIGHT.txt','Rakefile'])
   s.require_path = "lib"
   #  s.autorequire = "name"
   #  s.test_files = FileList["{test}/**/*test.rb"].to_a
   s.has_rdoc = true
-  s.extra_rdoc_files = ["doc/manual.rdoc","doc/manual_fr.rdoc"].concat(FileList["bin/*"].to_a)
-  #  s.add_dependency("dependency", ">= 0.x.x")
+  s.extra_rdoc_files = FileList["doc/*"].to_a.concat(FileList["bin/*"].to_a)
+  s.add_dependency("i18n", ">= 0.2.1")
   s.bindir = 'bin'
   s.executables = ['rrobots','tournament']
   s.description = "Ultragreen RRobots Fork"

data/bin/rrobots

@@ -1,41 +1,61 @@
 #!/usr/bin/env ruby
-
+#== Synopsis
+#
+# rrobots : AI Ruby Scripts based Robots simulation game
+#
+#== Date
+#
+#  2009-11-27
+#
+#== Copyright 
+#
+# 
+# Ultragreen (c) 2005-2008 : Romain GEORGES UG RRobots
+# Fork du projet RRobots
+# Historical (c) Simon Kröger
+# Ruby license (http://www.ruby-lang.org/en/LICENSE.txt).
+#
+#* Version : 2.0
+#
+#== About :
+# 
+#* Author:: Simon Kröger, Romain GEORGES 
+#* type:: robots AI Game (need TK)  
+#* obj:: command
+# 
+#== Source :
+# 
+#* http://www.ultragreen.net/projects/rrobots
+# 
+
+require 'I18n'
+
+require 'rdoc/usage'
 require 'misc'
 require 'robot'
 require 'yaml'
 require 'overloads'
 require 'configuration'
 require 'battlefield'
-require 'toolboxes'
-require 'explosions'
-require 'bullets'
+
+
+init_I18n get_locale_from_env
 
 ##############################################
 # arena
 ##############################################
 
 def usage
-  puts "usage: rrobots [resolution] [#match] [-nogui] [-speed=<N>] [-timeout=<N>] [-teams=<N>] [-with-toolboxes] <FirstRobotClassName[.rb]> <SecondRobotClassName[.rb]> <...>"
-  puts "Or : rrobots -list-internals"
-  puts "\t[-list-internals] (exclusive) give the list of avaibles internals Robots"
-  puts "\t[resolution] (optional) should be of the form 640x480 or 800*600. default is 800x800"
-  puts "\t[match] (optional) to replay a match, put the match# here, including the #sign.  "
-  puts "\t[-nogui] (optional) run the match without the gui, for highest possible speed.(ignores speed value if present)"
-  puts "\t[-speed=<N>] (optional, defaults to 1) updates GUI after every N ticks.  The higher the N, the faster the match will play."
-  puts "\t[-timeout=<N>] (optional, default 50000) number of ticks a match will last at most."
-  puts "\t[-teams=<N>] (optional) split robots into N teams. Match ends when only one team has robots left."
-  puts "\t[-with-toolboxes] (optional) to accept the spawning of healing toolboxes (randomly)."
-  puts "\t[-ignore-config] (optional) to ignore the config file present in the path."
-  puts "\t[-write-config] (optional) to write the config in a file in the path."
-  puts "\tthe names of the rb files have to match the class names of the robots"
-  puts "\t(up to 8 robots)"
-  puts "\te.g. 'ruby rrobots.rb SittingDuck NervousDuck'"
-  puts "\t or 'ruby rrobots.rb 600x600 #1234567890 SittingDuck NervousDuck'"
+  usage_file = "usage.rdoc"
+  usage_file = "usage_#{I18n.locale}.rdoc" if I18n.locale != 'en'
+  doc = "#{gem_path('doc')}/#{usage_file}"
+  RDoc.file_no_exit(doc,"rrobots")
   exit
 end
 
 def run_out_of_gui(battlefield)
-  $stderr.puts 'match ends if only 1 bot/team left or dots get here-->|'
+  $stderr.puts I18n.t('rrobots.match_limit_warning')
+  
 
   until battlefield.game_over
     battlefield.tick
@@ -94,6 +114,9 @@ def print_outcome(battlefield)
     end
     puts "    kills:              #{robot.kills}"
     puts "    toolboxes catched:  #{robot.catched_toolboxes}" if battlefield.with_toolboxes
+    puts "    dropped mines:      #{robot.dropped_mines}" if battlefield.with_mines
+    puts "    trigged mines:      #{robot.trigged_mines}" if battlefield.with_mines
+    puts "    destroyed mines:    #{robot.destroyed_mines}" if battlefield.with_mines
   end
 end
 
@@ -111,7 +134,7 @@ def hash_internals
 end
 
 def list_internals
-  title = "List of avaibles internals robots :"
+  title = I18n.t('rrobots.list_internals_title')
   puts title
   puts "-"*title.size
   hash_internals.each do |key,value|
@@ -119,15 +142,45 @@ def list_internals
   end
 end
 
+def list_locales
+  title = I18n.t('rrobots.list_locales_title')
+  puts title
+  puts "-"*title.size
+  I18n.backend.available_locales.each do |value|
+    puts " - #{value}"
+  end
+end
 
 $stdout.sync = true
 
+
+ARGV.grep( /^-set-locale=(\w{2})/ )do |item|
+  x = $1.to_s
+  I18n.locale=x
+  ARGV.delete(item)
+end
+
 # look for query for robots internal list
 ARGV.grep(/^(-list-internals)/) do |item|
   list_internals 
   exit 0
 end
 
+# look for query for robots internal list
+ARGV.grep(/^(-manual)/) do |item|
+  manual_file = "manual.rdoc"
+  manual_file = "manual_#{I18n.locale}.rdoc" if I18n.locale != 'en'
+  doc = "#{gem_path('doc')}/#{manual_file}"
+  RDoc.file_no_exit(doc)
+  exit 0
+end
+
+# look for query for locales avaible list
+ARGV.grep(/^(-list-locales)/) do |item|
+  list_locales   
+  exit 0
+end
+
 # look for resolution arg
 xres, yres = 800, 800
 ARGV.grep(/^(\d+)[x\*](\d+$)/) do |item|
@@ -149,6 +202,12 @@ with_toolboxes = true
   ARGV.delete(item)
 end
 
+#look for with_toolboxes arg
+with_mines = false
+ARGV.grep( /^(-with-mines)/ ) do |item|
+with_mines = true 
+  ARGV.delete(item)
+end
 
 #look for mode arg
 mode = :run_in_gui
@@ -179,6 +238,7 @@ ARGV.grep( /^-speed=(\d\d?)/ )do |item|
   ARGV.delete(item)
 end
 
+
 #look for timeout arg
 timeout = 50000
 ARGV.grep( /^-timeout=(\d+)/ )do |item|
@@ -199,7 +259,7 @@ teams = Array.new([team_count, ARGV.size].min){ [] }
 
 usage if ARGV.size > 8 || ARGV.empty?
 
-battlefield = Battlefield.new xres*2, yres*2, timeout, seed, with_toolboxes, merge, write_config
+battlefield = Battlefield.new xres*2, yres*2, timeout, seed, with_toolboxes, with_mines, merge, write_config
 
 c = 0
 team_divider = (ARGV.size / teams.size.to_f).ceil

data/bin/tournament

@@ -1,6 +1,12 @@
 #!/usr/bin/env ruby
 
 require "yaml"
+require 'I18n'
+require 'rdoc/usage'
+require 'misc'
+require 'overloads' 
+
+init_I18n get_locale_from_env
 
 class Match
   attr_reader :bots
@@ -286,15 +292,69 @@ end
 ####################################################################
 
 def usage
-  puts "Usage: ruby tournament.rb [-timeout=<N>] [-matches=<N>] [-with-toolboxes] (-dir=<Directory> | <RobotClassName[.rb]>+)"
-  puts "\t[-with-toolboxes] (optional) to accept the spawning of healing toolboxes (randomly)."
-  puts "\t[-ignore-config] (optional) to ignore the config file present in the path."
-  puts "\t[-timeout=<N>] (optional, default 10000) number of ticks a match will last at most."  
-  puts "\t[-matches=<N>] (optional, default 2) how many times each robot fights every other robot."  
-  puts "\t-dir=<Directory> All .rb files from that directory will be matched against each other."
-  puts "\t[-ignore-config] (optional) to ignore the config file present in the path."  
-  puts "\tthe names of the rb files have to match the class names of the robots."
-  exit(0)
+  usage_file = "usage.rdoc"
+  usage_file = "usage_#{I18n.locale}.rdoc" if I18n.locale != 'en'
+  doc = "#{gem_path('doc')}/#{usage_file}"
+  RDoc.file_no_exit(doc,"tournament")
+  exit
+end
+
+def hash_internals
+  my_res = Hash::new
+  robots_path = gem_path('robots')
+  Dir["#{robots_path}/*.rb"].each  {|file| 
+    robots = File.basename(file, ".rb")
+    my_res[robots] = file
+  }
+  return my_res
+end
+
+def list_internals
+  title = I18n.t('rrobots.list_internals_title')
+  puts title
+  puts "-"*title.size
+  hash_internals.each do |key,value|
+    puts " - #{key}"
+  end
+end
+
+def list_locales
+  title = I18n.t('rrobots.list_locales_title')
+  puts title
+  puts "-"*title.size
+  I18n.backend.available_locales.each do |value|
+    puts " - #{value}"
+  end
+end
+
+$stdout.sync = true
+
+
+ARGV.grep( /^-set-locale=(\w{2})/ )do |item|
+  x = $1.to_s
+  I18n.locale=x
+  ARGV.delete(item)
+end
+
+# look for query for robots internal list
+ARGV.grep(/^(-list-internals)/) do |item|
+  list_internals 
+  exit 0
+end
+
+# look for query for robots internal list
+ARGV.grep(/^(-manual)/) do |item|
+  manual_file = "manual.rdoc"
+  manual_file = "manual_#{I18n.locale}.rdoc" if I18n.locale != 'en'
+  doc = "#{gem_path('doc')}/#{manual_file}"
+  RDoc.file_no_exit(doc)
+  exit 0
+end
+
+# look for query for locales avaible list
+ARGV.grep(/^(-list-locales)/) do |item|
+  list_locales   
+  exit 0
 end
 
 #look for timeout arg
@@ -317,6 +377,13 @@ with_toolboxes = true
   ARGV.delete(item)
 end
 
+#look for with_mines arg
+with_mines = false
+ARGV.grep( /^(-with-mines)/ ) do |item|
+with_mines = true 
+  ARGV.delete(item)
+end
+
 #look for config arg
 merge = true
 ARGV.grep( /^(-ignore-config)/ )do |item|
@@ -372,7 +439,8 @@ robots.each do |bot1|
     matches_per_round.times do |i|
       puts "- Match #{i+1} of #{matches_per_round} -"
       cmd = "rrobots -nogui -timeout=#{timeout} "
-      cmd += "-with-toolboxes " if with_toolboxes  
+      cmd += "-with-toolboxes " if with_toolboxes
+      cmd += "-with-mines " if with_mines  
       cmd += "-ignore-config" if merge
       cmd += "#{folder}/#{bot1} #{folder}/#{bot2}"
       

data/config/locales/en.yml

@@ -0,0 +1,17 @@
+---
+en:
+    rrobots:
+        list_internals_title: List of avaibles internals robots
+        list_locales_title: List of avaible locales
+        match_limit_warning: match ends if only 1 bot/team left or dots get here-->|
+    battlefield:
+        robot_made_an_exception: '{{robot}} made an exception'
+    tkarena:
+        ai_name_dead: '{{ai_name}} dead'
+        draw: "Draw!"
+        no_team_wonn: ' won!'        
+        no_team_won: '{{winner_name}} won!'
+        team_won: 'Team {{winner_team}} won!'
+        game_over: GAME OVER
+
+        

data/config/locales/fr.yml

@@ -0,0 +1,14 @@
+---
+fr:
+    rrobots:
+        list_internals_title: Liste des robots disponibles en interne
+        list_locales_title: Liste des locales disponibles
+        match_limit_warning: fin si 1 robot/equipe survi(e) ou ligne jusqu'ici  -->|
+    battlefield:
+        robot_made_an_exception: '{{robot}} a lev� une exception'
+    tkarena:
+        ai_name_dead: '{{ai_name}} d�truit'
+        draw: Match nul !
+        no_team_won: '{{winner_name}} a gagn� !'
+        team_won: "L'�quipe {{winner_team}} a gagn� !"
+        game_over: FIN DU MATCH

data/config/rrobots.yml

@@ -1,15 +1,22 @@
 --- !ruby/object:Configuration 
 battlefield: 
-  :height: 800
   :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
-  :with_toolboxes: false
   :life_time: 200
+  :with_toolboxes: false
   :spawning_chances: 100

data/doc/install.rdoc

@@ -0,0 +1,85 @@
+= Installation
+
+== Download
+
+UG_RRobots could be download from the URL :
+
+http://www.ultragreen.net/projects/rrobots/files
+
+You could choose the Gem file or the TGZ fiile if you want to modify the project before to install it.
+Files are sort by release
+ 
+== Gem or Package creation
+
+*Info* : this step is mandatory only if you choose to download TGZ 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 
+
+Gemfile or TGZ source are under the pkg Folder
+
+If you create your gem, please do :
+
+  $ cd pkg
+
+otherwise
+
+  $ wget http://www.ultragreen.net/attachments/download/52/UG_RRobots-2.0.gem
+
+== Gem Installation 
+
+You should be root
+
+  $ sudo bash
+  # gem install UG_RRobots-2.0.gem
+
+deinstallation :
+
+  $ sudo bash
+  # gem uninstall UG_RRobots
+
+== Configuration
+
+=== Config File Format
+
+YAML file : 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
+
+
+=== Config file reading order and priority
+
+in this order
+
+* Code builtin values
+* GEM_PATH/config/rrobots.yml (merge)
+* PATH ('.') unless you have the -ignore-config for the rrobots command
+
+the -argument -write-config create a clone of the configuration in PATH ('.') also named rrobots.yml