gwdamcalc 0.1.0

data/bin/gwdamcalc

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "..", "lib", "gwdamcalc")
+GWTools::UI.new

data/bin/gwdamcalc.rb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "..", "lib", "gwdamcalc")
+GWTools::UI.new

data/lib/gwdamcalc.rb

@@ -0,0 +1,628 @@
+#!/usr/bin/env ruby
+#--
+# Copyright (c) 2007 Daniel Stevens
+# 
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+#++
+# = gwdamcalc - The Guild Wars Damage Calculator
+# 
+# _gwdamcalc_ is a damage calculator for the MMORPG/CORPG video game Guild
+# Wars. The software can be used to determine the damage caused by
+# a single attack by a character against a defending target, given a set of
+# relevant statistics for the attacker and target. The implementation for the
+# software was inspired by Guild Wars damage research documented at
+# http://guildwars.incgamers.com/wiki/index.php/Damage_Explained and other
+# sources.
+# 
+# == Downloading
+# 
+# The latest version of _gwdamcalc_ can be downloaded from http://rubyforge.org/frs/?group_id=4975.
+# 
+# == Requirements
+# 
+# _gwdamcalc_ is implemented in the scripting language _Ruby_. The Ruby
+# interpreter is require in order to run the script and use the software.
+# Information on downloading the Ruby interpreter for you platform is available at
+# http://www.ruby-lang.org/en/downloads.
+# 
+# == Usage
+# 
+# _gwdamcalc_ is invoked from the command line, passing the statistics of the
+# attacker and target as arguments. If gwdamcalc was installed from a gem, it
+# should be possible to invoke it directly from the command line from any
+# directory. Use the <tt>--help</tt> argument to see a list of arguments and
+# their usage. Additional information can be found in the  Rdoc for the
+# following classes:
+# 
+# GWTools::DamageCalc:: This contains detailed information on the workings of 
+#                       _gwdamcalc_. Read this if you're interested in using 
+#                       _gwdamcalc_ with your own code.
+# GWTools::UI:: This contains more detailed information about _gwdamcalc_'s 
+#               command line interface. Read this if you're having trouble
+#               figuring out how to use it.
+# 
+# == License information
+# 
+# Author:: Dan Stevens <dan.stevens.iamai@googlemail.com>
+# License:: Copyright (c) 2007 Daniel Stevens. Released under a MIT/X11 style
+#           license. See the 'license' file.
+# 
+# == Warranty
+# 
+# This software is provided "as is" and without any express or
+# implied warranties, including, without limitation, the implied
+# warranties of merchantibility and fitness for a particular
+# purpose.
+#
+
+require 'optparse'
+require 'ostruct'
+
+module GWTools
+
+# A basic damage calculator for the MMORPG/CORPG video
+# game <em>Guild Wars</em>. The class is based strongly around the damage
+# calculation itself: only the relevant independent variables are expected, as
+# opposed to them being encapsulated into classes that represent attack/target
+# entities in an abstract form (this may be a future development).
+#
+# The class has been mostly derived from the contents of
+# http://guildwars.incgamers.com/wiki/index.php/Damage_Explained. The
+# calculation has been divided into a number of methods that reflect most of the
+# components mentioned in the article, although most of the names of the terms
+# have been changed.
+#
+# The Full equation for spell, signet, staff and wand attacks:
+# * d = (bd � tda � (2 ^ (((3 � lvl) - (ttav � tap)) � 40))) + db
+# The Full equation for <em>Martial Weapon</em> attacks:
+# * d = (bd � tda � (2 ^ (((5 � min((lvl + 4) � 2 rank) + 2 � max(0, rank - ((lvl + 4) � 2))) - (ttav � tap)) � 40))) + db
+class DamageCalc
+
+  # Version for gwdamcalc
+  VERSION = '0.1.0'
+
+#  PHYS_DAM_TYPES = [:blunt, :slashing, :piercing].freeze
+
+	# The set of weapon types that are classified as <em>martial weapons</em>. 
+	MARTIAL_WEAPONS = [:axe, :bow, :daggers, :hammer, :scythe, :spear, :sword].freeze
+
+  # All weapon types.
+  WEAPONS = (MARTIAL_WEAPONS + [:staff, :wand, :spell, :signet]).freeze
+
+  # A regular expression that matches strings that express the damage range of
+  # a weapons in the form that is used in Guild Wars e.g. '11-25'.
+  BD_FORM = /(\d+)(-(\d+))?/.freeze
+	
+	# call-seq: tofrac(percentage) -> Float
+	#
+	# Converts a value as a percentage (integer) into the fractional equivalent.
+	# Examples:
+	#
+	#   DamageCalc.tofrac(20) -> 1.25
+	#   DamageCalc.tofrac(-12) -> 0.88
+	def DamageCalc.tofrac(percent)
+		(100 + percent) / 100.0
+	end
+	
+	# call-seq: topercent(fraction) -> Integer
+	#
+	# Converts a value as a fraction (float) into the equivalent percentage (and
+	# are rounded, if necessary).
+	# Examples:
+	#
+	#   DamageCalc.topercent(1.25) -> 20
+	#   DamageCalc.topercent(0.88) -> -12
+	def DamageCalc.topercent(fraction)
+		(fraction * 100 - 100).round
+	end
+		
+  # The type of weapon causing the damage (:axe, :bow, :daggers, :hammer,
+  # :scythe, :spear, :sword, :staff, :wand, :spell, :signet). If the attack is
+  # caused by a spell or  signet, use the symbols :spell and :signet
+  # respectively.
+  attr_accessor :wep_type
+   
+  # The attacker's rank in the relevant skill attribute for the weapon. Not
+	# applicable for attacks caused by spells, signets, staves or wands.
+   attr_accessor :rank
+	
+	# The attacker's level.
+	attr_accessor :lvl
+   
+  # The <em>Base Damage</em> range of the weapon, or damage value of the skill.
+  # If a Range object is specified, a value from within the range is chosen
+  # automatically at random. A single value will be used outright.
+  attr_accessor :bd
+   
+  # The <em>Total Damage Adjustment</em> for the weapon. This should be
+  # expressed as a fraction, with values greater than one for a positive
+  # adjustment and values between 0.0 and 0.99 for a negative adjustment e.g.
+  # +20% damage = 1.20, -15% damage = 0.85. Summate adjustments from multiple
+  # sources into this variable. Use the tofrac method convert whole percentage
+	# into fractions. 
+   attr_accessor :tda
+   
+  # The <em>Total Target Armor Value</em>. The sum of all the sources of
+	# armor for the target including body armor, shields (where appropriate),
+	# armor buffs and debuffs from skills (debuffs should have negative impact on
+	# the value).
+   attr_accessor :ttav
+	
+	# The <em>Total Armor Penetration</em> of the attack. This should be
+	# expressed as a fraction, with the armor penetration acting as a reduction
+	# in the target's armor by multiplying it against the ttav. Therefore, the
+  # value of this variable should be between 0.0 (for complete penetration) up
+  # to 1.0 for no penetration. When using the tofrac method, specify the armor
+	# penetration as a negative number and the appropriate fraction will be
+	# returned.
+	attr_accessor :tap
+	
+	# The <em>Damage Bonus</em> of the attack; additional damage which is added
+  # at the end of the <em>Net Damage</em> calculation.
+	attr_accessor :db
+	
+  # call-seq:
+	#   new(wep_type=:sword, bd=11..15, ttav=60, lvl=20, rank=12, tda=1.0, tap=1.0, db=0) -> DamageCalc
+	#
+	# Constructs a new DamageCalc object. Accepts the attributes defined above
+  # as parameters.
+	def initialize(wep_type=:sword, bd=11..25, ttav=60, lvl=20, rank=12, tda=1.0,
+	  tap=1.0, db=0)
+		@wep_type = wep_type
+		@bd = bd
+		@ttav = ttav
+		@lvl = lvl
+		@rank = rank
+		@tda = tda
+		@tap = tap
+		@db = db
+	end
+		
+	# call-seq: d -> Integer
+	#
+	# Returns the <em>Net Damage</em> (d); the final resultant damage taking
+	# into the account the attacker's stats and the target's armor. It is
+	# calculated as the product of the <em>Base Damage</em> (bd), the
+	# <em>Total Damage Adjustment</em> (tda) and the <em>Defensive
+	# Adjustment</em> (da), plus a <em>Damage Bonus</em> (db):
+	#
+	# d = (bd � tda � da) + db
+	#
+	# The end result is rounded to the nearest integer.
+	def d
+		((bd.pick * tda * da) + db).round
+	end
+
+	# Alias for d
+	alias calc d
+	
+	# call-seq: da -> Float
+	#
+	# Returns the <em>Defensive Adjustment</em> (da); a fraction that modifies
+	# damage with respect to the attacker's stance and targets armor. It is
+	# calculated as follows:
+	#
+	# 2^((atddm - eav) � 40)
+	#
+	# where:
+	# * <b>atddm</b> is the <em>Attack Type Dependant Damage Modifier</em>;
+	# * <b>eav</b> is the <em>Effective Armor Value</em> of the target.
+	def da
+		2 ** ((atddm - eav) / 40.0)
+	end
+	
+	# call-seq: atddm -> Integer
+	#
+	# Returns the <em>Attack Type Dependant Damage Modifier</em> (atddm). The
+	# value returned depends on the type of attack, which are attacks made with a
+	# martial weapon or attacks caused by a skill, staff or wand. The values 
+	# <em>Damage Modified for Weapon Attacks</em> (dmwa) or <em>Damage Modified
+	# for Spell Attacks</em> (dmsa) will be returned, respectively.
+	def atddm
+		martial? ? dmwa : dmsa
+	end
+	
+	# call-seq: martial? -> true or false
+	#
+	# Returns true if the attack is caused by a martial weapon i.e. axe, sword,
+	# daggers, hammer, scythe, spear, bow.
+	# 
+	def martial?
+		 MARTIAL_WEAPONS.include? wep_type
+	end
+	
+	# call-seq: dmwa -> Integer or Float
+	#
+	# Returns the <em>Damage Modifier for Weapon Attacks</em> (dmwa); the
+	# modification made to the damage for attacks made with martial weapons.
+	# There is a threshold, dependant upon the level of the attacker, at which
+	# the rank for the weapon has a lesser influence when exceeding the
+	# threshold. dmwa is calculated as follows:
+	#
+	# 5 � min(threshold, rank) + 2 � max(0, rank - threshold)
+	def dmwa
+		5 * [threshold, rank].min + 2 * [0, rank - threshold].max
+	end
+	
+	# call-seq: threshold -> Float
+	#
+	# Returns the level dependant threshold past which the influence the rank has
+	# on the damage modifier is lower. It is calculated as follows:
+  #
+  # threshold = (lvl + 4) � 2
+	def threshold
+		(lvl + 4) / 2.0
+	end
+	
+	# call-seq: dmsa -> Integer
+	#
+	# Returns the <em>Damage Modifier for Spell Attacks</em> (dmsa); the
+	# modification made to the damage for attacks made with spells, signets,
+	# staves or wands. It is calculated as follows:
+	#
+	# 3 � <em>Attacker's Level</em>
+	def dmsa
+		3 * lvl
+	end
+	
+	# call-seq: eav -> Float
+	#
+	# Returns the <em>Effective Armor Value</em> (eav) of the target; the product
+	# of the effective armor of the target taking into account its own total
+	# armor value (ttav) and the <em>Total Armor Penetration</em>
+	# of the attacker:
+	#
+	# ttav � tap
+	def eav
+		ttav * tap
+	end
+	
+end
+
+# The following describes the command line interface for _gwdamcalc_ in more detail.
+#
+# == Invoking gwdamcalc
+#
+# If gwdamcalc was installed from a gem , it can be invoked directly from
+# the command line from any directory:
+#
+#   gwdamcalc
+# 
+# If you did not install from a gem, you will need to locate the gwdamcalc.rb
+# file, change the working directory to that of the file and enter the
+# following in your command shell:
+#
+#   ruby gwdamcalc.rb
+#
+# == Usage
+#
+# The damage calculation for Guild Wars depends on a set of statistics relating
+# the attacking and defending characters. _gwdamcalc_ has a set of command line
+# options that can be used to specify the value of these statistics for use in
+# the calculation. If a option is not specified for a stat, a default value is a
+# assumed in the calculation. You can get _gwdamcalc_ to list the set of
+# statistics and their default values by using the <tt>--help</tt> arguments:
+#
+#   $ gwdamcalc --help
+#   Usage: gwdamcalc [OPTIONS]...
+#   A basic damage calculator for the MMORPG/CORPG video game Guild Wars. The
+#   independent variables of the calculation are specified by the options below.
+#   See the rdoc for more details on each of the variables.
+#   
+#   gwdamcalc accepts one or more of the options below. If a option is not
+#   explicitely specified, the default value is assumed in the calculation.
+#       -w, --weptype=string             The type of weapon. Choose from: axe, bow, sword, daggers, hammer,
+#                                        scythe, spear, staff, wand. If the attack is caused by a spell or
+#                                        signet, use 'spell' and 'signet' respectively. Default
+#                                        value: sword
+#       -d, --bd=int[-int]               The Base Damage of the attack. Specified or a single value, or a
+#                                        range in the form 11-22. Default value: 11-25
+#       -a, --ttav=int                   The Total Target Armor Value. Default value: 60
+#       -l, --lvl=int                    The level of the attacker. Default value: 20
+#       -r, --rank=int                   The attacker's rank in the appropriate attribute for their weapon.
+#                                        Not required for attacks made with spells, signets, staves and wands.
+#                                        Default value: 12
+#       -j, --tda=float                  The Total Damage Adjustment. Expressed as a fraction (see rdoc).
+#                                        Default value: 1.0
+#       -p, --tap=float                  The Total Armor Penetration. Expressed as a fraction (see rdoc).
+#                                        Default value: 1.0
+#       -b, --db=int                     The Damage Bonus. Default value: 0
+#       -s, --summary                    Display a summary of the values of the variables of the calculation
+#       -q, --quiet                      Displays only the result of the calculation
+#           --help, --usage              Displays this help message.
+#           --version                    Displays version information.
+#   
+# The first eight options are for specifying values relating to the stats of the
+# attacker and defender. The last four are support options. Each option has a
+# short, single character version, prefixed with a single dash, and long
+# version prefixd with two dashs. When specify a value using the short version,
+# seperate the option and the value with a space, for example:
+#
+#   gwdamcalc -d 50
+#
+# When specify a value using the long version, seperate the option and the value
+# with an equals sign, for example:
+#
+#   gwdamcalc --bd=50
+#
+# The following headings describe each of the options in more detail, in the above
+# order.
+#
+# === Weapon type
+#
+#   -w, --weptype=string
+#
+# Use this specify the means by which the attacker is attacking. Technically, in
+# terms of how this value affects the calculation, there are two groups: 'Martial
+# weapons', which include axe, bow, sword, dagger, hammer, scythe and spear, and
+# 'magic', which include staff, wand, spell and signet. Changing the weapon type
+# to another in the same group does not affect the calculation in anyway.
+#
+# === Base damage
+#
+#   -d, --bd=int[-int]
+#
+# Use this to specify the damage rating for the weapon or skill. This can be
+# discreet value or a range. If a range is specified, a whole value from within the
+# range will be selected from within the range. If you are performing a
+# calculation for a martial weapon, which typically have a range for its damage
+# rating, you can set this value to its minimum or maximum value (or any value
+# you want!) to get the minimum or maximum possible damage for the given
+# remaining stats.
+#
+# If specifying a range, seperate the lower and upper values of the range with a
+# dash, for example:
+#
+#   gwdamcalc -bd 11-22
+#
+# === Total Target Armor Value
+#
+#   -a, --ttav=int
+#
+# The <em>Total Target Armor Value</em> is the sum of all the sources of armor for the target 
+# including body armor, shields (where appropriate), armor buffs and debuffs from 
+# skills (debuffs should have negative impact on the value). 
+#
+# === Level of attacker
+#
+#   -l, --lvl=int
+#
+# Use this to specify the level of the attacker.
+#
+# === The attacker's rank
+#
+# Use this to specify the attacker's rank in the relevant skill attribute for the
+# weapon. This is only relevant to attacks made with martial weapons.
+#
+# === Total Damage Adjustment
+#
+# Use this to specify a fractional modification of the base damage. Instances of
+# where this would be used is where the weapon has +% damage modifier (e.g. +20%
+# damage for a customized weapon). However this option expects this value as a
+# fraction rather than a percentage, with values greater than one for a positive
+# adjustment and values between 0.0 and 0.99 for a negative adjustment. If there
+# are multiple damage modifies, total them together.
+#
+# Tip: If you don't want to convert a percentage into a fraction in your head,
+# with Ruby installed you can enter the following in the command shell,
+# replacing 'x' with the percentage, to get the fraction:
+#
+#    ruby -e "puts (100 + x) / 100.0"
+#
+# === Total Armor Pentration
+#
+# Use this to specify the total of all sources of armor penetration against the
+# target. Like the Total Damage Adjustment, with the armor penetration acting as a
+# reduction in the target's armor by multiplying it against the Total Target Armor
+# Value. Therefore, the value of this variable should be between 0.0 (for complete
+# penetration) up to 1.0 for no penetration.
+class UI
+
+	include GWTools
+
+	BANNER = 
+"Usage: gwdamcalc [OPTIONS]...
+A basic damage calculator for the MMORPG/CORPG video game Guild Wars. The
+independent variables of the calculation are specified by the options below.
+See the rdoc for more details on each of the variables." # :nodoc:
+
+	WEP_TYPES = [:axe, :bow, :sword, :daggers, :hammer, :scythe, :spear, :staff,
+		:wand, :spell, :signet].freeze
+		
+	def initialize
+	
+		begin
+
+		@calc = DamageCalc.new()
+		@summary = false
+		@quiet = false
+
+		# Deal with command line paramters
+		parse(ARGV)
+		
+		unless @quiet
+			if @summary
+				puts
+				puts "Calculation summary:"
+				print "  Weapon type:\t\t\t", @calc.wep_type.id2name.capitalize, "\n"
+				print "  Base Damage:\t\t\t", @calc.bd.begin, @calc.bd.is_a?(Range) ? "-#{@calc.bd.end}" : "", "\n"
+				print "  Total Target Armor Value:\t", @calc.ttav, "\n"
+				print "  Attacker's level:\t\t", @calc.lvl, "\n"
+				print "  Attacker's rank:\t\t", @calc.rank, "\n"
+				printf "  Total Damage Adjustment:\t%+d%% (%.2f)\n", DamageCalc.topercent(@calc.tda), @calc.tda
+				printf "  Total Armor Penetration:\t%+d%% (%.2f)\n", DamageCalc.topercent(@calc.tap), @calc.tap, "\n"
+				print "  Damage Bonus:\t\t\t", @calc.db, "\n"
+			end
+			
+			puts
+			print "Calculated damage: "
+		end
+		
+		puts @calc.d
+		
+		rescue SystemCallError => err
+			$stderr.puts "Error: #{err}"
+		rescue OptionParser::InvalidArgument => err
+			$stderr.puts "Error: #{err}"
+			$stderr.puts "Please ensure option argument is in the correct format."
+			$stderr.puts "Use -h option for valid options and their argument's format."
+		rescue OptionParser::InvalidOption => err
+			$stderr.puts "Error: #{err}"
+			$stderr.puts "Use -h option for valid options."
+		end
+		
+	end
+
+	# Returns a struct containing the options.
+	def parse(args) # :nodoc:
+		# Stores options
+		#opts = OpenStruct.new
+		
+		OptionParser.new() do |optparser|
+			optparser.banner = BANNER
+			
+			optparser.separator ""
+			optparser.separator "gwdamcalc accepts one or more of the options below. If a option is not"
+			optparser.separator "explicitely specified, the default value is assumed in the calculation."
+			
+			optparser.on("-w", "--weptype=string", WEP_TYPES,
+			 "The type of weapon. Choose from: axe, bow, sword, daggers, hammer,",
+			 "scythe, spear, staff, wand. If the attack is caused by a spell or",
+			 "signet, use 'spell' and 'signet' respectively. Default",
+			 "value: sword") do |arg|
+				@calc.wep_type = arg
+			end
+			
+			optparser.on("-d", "--bd=int[-int]",
+			 "The Base Damage of the attack. Specified or a single value, or a",
+			 "range in the form 11-22. Default value: 11-25") do |arg|
+				if arg =~ BD_FORM
+          if $3.nil?: @calc.bd = $1.to_i
+					else @calc.bd = $1.to_i..$3.to_i
+          end
+				else raise OptionParser::InvalidArgument
+				end
+			end
+			
+			optparser.on("-a", "--ttav=int", Integer,
+			 "The Total Target Armor Value. Default value: 60") do |arg|
+				@calc.ttav = arg
+			end
+			
+			optparser.on("-l", "--lvl=int", Integer,
+			 "The level of the attacker. Default value: 20") do |arg|
+				@calc.lvl = arg
+			end
+			
+			optparser.on("-r", "--rank=int", Integer,
+			 "The attacker's rank in the appropriate attribute for their weapon.",
+			 "Not required for attacks made with spells, signets, staves and wands.",
+			 "Default value: 12") do |arg|
+				@calc.rank = arg
+			end
+			
+			optparser.on("-j", "--tda=float", Float,
+			 "The Total Damage Adjustment. Expressed as a fraction (see rdoc).",
+			 "Default value: 1.0") do |arg|
+				@calc.tda = arg
+			end
+			
+			optparser.on("-p", "--tap=float", Float,
+			 "The Total Armor Penetration. Expressed as a fraction (see rdoc).",
+			 "Default value: 1.0") do |arg|
+				@calc.tap = arg
+			end
+			
+			optparser.on("-b", "--db=int", Integer,
+			 "The Damage Bonus. Default value: 0") do |arg|
+				@calc.db = arg
+			end
+			
+			optparser.on("-s", "--summary",
+			"Display a summary of the values of the variables of the calculation") do |arg|
+				@summary = true
+			end
+			
+			optparser.on("-q", "--quiet",
+			 "Displays only the result of the calculation") do |arg|
+				@quiet = true
+			end
+			
+			optparser.on_tail("--help", "--usage", "Displays this help message.") do
+				puts optparser
+				exit
+			end
+			
+			optparser.on_tail("--version", "Displays version information.") do
+				puts "gwdamcalc #{DamageCalc::VERSION}"
+				exit
+			end
+			
+			optparser.parse!(args)
+		end
+	end
+
+	
+
+end
+
+end
+
+class Integer
+#class Fixnum
+
+	# Accommodate for duck typing.
+	def pick
+		self
+	end
+	
+	# Accommodate for duck typing.
+	def begin
+		self
+	end
+	
+	# Accommodate for duck typing.
+	def end
+		self
+	end
+
+end
+
+# call-seq: randran(min, max) -> Integer
+#
+# Returns a random number with in the range specified by min and max
+# inclusively.
+def randran(min, max)
+	rand(max + 1 - min) + min
+end
+
+class Range
+
+	# Randomly picks a value within the the boundries of the range, inclusively.
+	def pick
+		randran(self.begin, self.end)
+	end
+	
+end
+
+GWTools::UI.new if $0 == __FILE__
+

data/lib/test_gwdamcalc.rb

@@ -0,0 +1,104 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'test/unit'
+require 'gwdamcalc'
+
+include GWTools
+
+# A set of tests for GWTools::DamageCalc, based on a number of examples from the
+# web (that are assumed to be accurate). These are:
+# * http://guildwars.incgamers.com/wiki/index.php/Damage_Explained#Examples
+# * http://www.guildwarsguru.com/content/game-mechanics-id674.php
+class TestDamageCalc < Test::Unit::TestCase
+
+	# A level 16 elementalist casts a fireball (71 damage) at a monk wearing the
+	# judge�s armor (60AL + 10AL vs physical). The monk has a defensive staff of
+	# defense (+10AL). The monk takes 48 fire damage.
+	def test1
+		result = DamageCalc.new(:spell, 71, 70, 16).d
+		assert_equal(48, result)
+	end
+	
+	# A level 15 Elementalist butchering packs of level 7, 21 defense Charr with
+	# 69 damage, level 8 Fireballs. Each one you cast is going to deal 104.6
+	# (105).
+	def test2
+		result = DamageCalc.new(:spell, 69, 21, 15).d
+		assert_equal(105, result)
+	end
+	
+	# A level 20 Ranger hunting level 28, 118 defense Rift Wardens in the Tombs.
+	# You have a customized, 15-28 Half Moon Bow, and a level 12 attribute to go
+	# with it. Minimum damage: 18.3 (18); Maximum damage: 34.2 (34).
+	# def test3
+		# result = DamageCalc.new(:bow, 15..28, 118, 12, 20, 1.2, 0.8).d
+		# assert((result >= 18) && (result <= 34))
+		# @summary << ["test3:", result]
+	# end
+	
+	# Attacker level:: 20
+	# Weapon:: Sword 15-22 damage +20%
+	# Swordmanship rank:: 9
+	# Strength:: 0 (0% armor penetration)
+	# Target armor:: 60 points
+	# Expected minimum damage:: 14
+	# Expected maximum damage:: 20
+	def test4
+		result = DamageCalc.new(:sword, 15..22, 60, 20, 9, 1.2, 1.0).d
+		assert((result >= 14) && (result <= 20))
+	end
+	
+	# Attacker level:: 20
+	# Weapon:: Sword 15-22 damage +20%
+	# Swordmanship rank:: 12
+	# Strength:: 0 (0% armor penetration)
+	# Target armor:: 60 points
+	# Expected minimum damage:: 18
+	# Expected maximum damage:: 26
+	def test5
+		result = DamageCalc.new(:sword, 15..22, 60, 20, 12, 1.2, 1.0).d
+		assert((result >= 18) && (result <= 26))
+		
+	end
+	
+	# Attacker level:: 6
+	# Spell:: Flare 22 damage (5 Fire Magic)
+	# Target armor:: 60 points
+	# Expected damage:: 11
+	def test6
+		result = DamageCalc.new(:spell, 22, 60, 6).d
+		assert_equal(11, result)
+		
+	end
+	
+	# Attacker level:: 73
+	# Spell:: Flare 22 damage (5 Fire Magic)
+	# Target armor:: 60 points
+	# Expected damage:: 11
+	def test7
+		result = DamageCalc.new(:spell, 22, 60, 7).d
+		assert_equal(11, result)
+		
+	end
+	
+	# Attacker level:: 30
+	# Spell:: Deep Freeze 76 damage (12 Water Magic)
+	# Target armor:: 60 points
+	# Expected damage:: 128
+	def test8
+		result = DamageCalc.new(:spell, 76, 60, 30).d
+		assert_equal(128, result)
+		
+	end
+	
+	# Attacker level:: 10
+	# Weapon:: Wand 6-10 damage + 20%
+	# Target armor:: 60 points
+	# Expected Minimum damage:: 4
+	# Expected Maximum damage:: 7
+	def test9
+		result = DamageCalc.new(:wand, 6..10, 60, 10, nil, 1.2).d
+		assert((result >= 4) && (result <= 7))
+		
+	end
+
+end

data/license

@@ -0,0 +1,23 @@
+Copyright (c) 2007 Daniel Stevens
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+

data/readme

@@ -0,0 +1,48 @@
+= gwdamcalc - The Guild Wars Damage Calculator
+
+_gwdamcalc_ is a damage calculator for the MMORPG/CORPG video game Guild
+Wars. The software can be used to determine the damage caused by
+a single attack by a character against a defending target, given a set of
+relevant statistics for the attacker and target. The implementation for the
+software was inspired by Guild Wars damage research documented at
+http://guildwars.incgamers.com/wiki/index.php/Damage_Explained and other
+sources.
+
+== Downloading
+
+The latest version of _gwdamcalc_ can be downloaded from http://rubyforge.org/frs/?group_id=4975.
+
+== Requirements
+
+_gwdamcalc_ is implemented in the scripting language _Ruby_. The Ruby 
+interpreter is require in order to run the script and use the software.
+Information on downloading the Ruby interpreter for you platform is available at
+http://www.ruby-lang.org/en/downloads.
+
+== Usage
+
+_gwdamcalc_ is invoked from the command line, passing the statistics of the
+attacker and target as arguments. If gwdamcalc was installed from a gem, it
+should be possible to invoke it directly from the command line from any
+directory. Use the '--help' argument to see a list of arguments and their usage.
+Additional information can be found in the Rdoc for the following classes:
+
+GWTools::DamageCalc:: This contains detailed information on the workings of 
+                      _gwdamcalc_. Read this if you're interested in using 
+                      _gwdamcalc_ with your own code.
+GWTools::UI:: This contains more detailed information about _gwdamcalc_'s 
+              command line interface. Read this if you're having trouble
+              figuring out how to use it.
+
+== License information
+
+Author:: Dan Stevens <dan.stevens.iamai@googlemail.com>
+License:: Copyright (c) 2007 Daniel Stevens. Released under a MIT/X11 style
+          license. See the 'license' file.
+
+== Warranty
+
+This software is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantibility and fitness for a particular
+purpose.

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: gwdamcalc
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dan 'IAmAI' Stevens
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-01-03 00:00:00 +00:00
+default_executable: gwdamcalc.rb
+dependencies: []
+
+description: A basic damage calculator for the MMORPG/CORPG video game, Guild Wars.
+email: dan.stevens.iamai@googlemail.com
+executables: 
+- gwdamcalc.rb
+- gwdamcalc
+extensions: []
+
+extra_rdoc_files: 
+- readme
+- license
+files: 
+- lib
+- bin
+- license
+- readme
+- lib/gwdamcalc.rb
+- lib/test_gwdamcalc.rb
+- bin/gwdamcalc
+- bin/gwdamcalc.rb
+has_rdoc: true
+homepage: http://gwdamcalc.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --title
+- Guild Wars Damage Calculator Documentation
+- --main
+- readme
+- --inline-source
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: gwdamcalc
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Guild Wars Damage Calculator
+test_files: 
+- lib/test_gwdamcalc.rb