pathfinder-dnd-tools 0.1.2 → 0.1.3

data/bin/pathfinder

@@ -34,8 +34,8 @@ class Fixnum
 end
 
 # all skills & most stats included
-puts '--- Pathfinder Character Tools 2: Revenge of Google Docs ---
- version 0.1.2 "Gold and Gems"
+puts %Q[--- Pathfinder Character Tools 2: Revenge of Google Docs ---
+ version #{Pathfinder::VERSION}
 
     You are in a fully-interactive ruby console. 
     You can `ls` to see methods.
@@ -47,7 +47,7 @@ puts '--- Pathfinder Character Tools 2: Revenge of Google Docs ---
 
     type `help` for an overview of console usage
     type `show-doc <method>` to view help for that specific method
+]
 
-'
     
 character.pry

data/lib/pathfinder_dnd.rb

@@ -1,3 +1,8 @@
+# A simple D&D runtime that connects to Google Docs for your character data
+# Also loads personal functions from ~/.config/pathfinder/rc.rb
+module Pathfinder
+    VERSION = '0.1.3 - "User Functions"'
+end
 require 'pathfinder_dnd/character_sheet'
 require 'pathfinder_dnd/state_manager'
 

data/lib/pathfinder_dnd/character_sheet.rb

@@ -17,6 +17,11 @@ module Pathfinder
 
         # include standard D&D tools
         include Pathfinder::Tools
+
+        # Include user RC if possible
+        if load '~/.config/pathfinder/rc.rb'
+            include Pathfinder::RC
+        end
         
         # What sheet title to pull stats from?
         STATS_SHEET = 'Stats, Skills, Weapons'

data/lib/pathfinder_dnd/tools.rb

@@ -1,6 +1,7 @@
 module Pathfinder
 
     # This is where all the in-game functions are defined, like rolling dice.
+    # Also includes some analytics, like an `average` function.
     module Tools
 
         # Deep sum arrays of integers and arrays.
@@ -8,6 +9,10 @@ module Pathfinder
         # @return [Integer] the total
         def sum(array)
             res = 0
+
+            # numbers sum to themselves
+            return array if array.is_a? Fixnum
+
             array.each do |i|
                 if i.respond_to? :each
                     res += sum(i)
@@ -27,14 +32,14 @@ module Pathfinder
         # @param failure_level [integer] alert the user to dice rolls
         #   at or below this level when rolling 20-sided dice. Default 1.
         # @return [Integer] result of the dice roll
-        def single_roll(sides, crit_level = 19, failure_level = 1)
+        def single_roll(sides, crit_level = 0, failure_level = 1)
             res = 1 + rand(sides)
-            if sides == 20 and res >= crit_level
-                puts "Crit: rolled #{res}"
+            if res >= crit_level + sides and @verbose
+                puts "High roll: rolled #{res} on a d#{sides}"
             end
 
-            if sides == 20 and res <= failure_level
-                puts "Low roll: rolled #{res}"
+            if res <= failure_level and @verbose
+                puts "Low roll:  rolled #{res} on a d#{sides}"
             end
 
             res
@@ -46,43 +51,48 @@ module Pathfinder
         # @param sides [Integer] number of sides on each die. Default 6.
         # @see #single_roll
         # @return [Array<Integer>] list of dice roll results
-        def roll(dice = 1, sides = 6, crit_level = 19, failure_level = 1)
+        def roll(dice = 1, sides = 6, crit_level = 0, failure_level = 1)
             (1..dice).to_a.map{ |_| single_roll(sides, crit_level, failure_level) }
         end
 
         # Roll a 20-sided dice and add an optional skill bonus
+        # Alerts the user on 19-20 rolls
         # @param skill [Integer] your skill-check or saving-throw bonus. Default 0.
         # @return [Integer]
         def check(skill = 0)
-            sum(roll(1, 20)) + skill
+            verbose do 
+                single_roll(20, -1) + skill
+            end
         end
 
-        # roll to hit
-        # Rolls a basic check with an additional bonus
-        # @param bonus [Integer] added bonus, usually from Anne's blung-ing or haste
-        # @param base [Integer] your usual attack bonus. Character-specific default 14.
-        # @see #check
-        def atk_roll(bonus = 0, base = 14)
-            check(base) + bonus
-        end
+        # Average the many runs of a function.
+        # Intended to benchmark your damage.
+        #
+        # @param runs [Integer] how many samples to take
+        # @param fn_name [String, Symbol] name of the method to call
+        # @param block [Proc] a block to use instead of calling a defined method
+        # @return [Integer] the average
+        def average(runs = 100, fn_name = nil, &block)
+            res = 0
+
+            if fn_name
+                b = method(fn_name.to_sym)
+            else
+                b = block
+            end
 
-        # roll for damage
-        # Character-specific to Shalizara
-        # @return [Array<Integer>] magic and normal components of the attack
-        def normal_damage(magic_damage_dice = 2)
-            magic = sum(roll(magic_damage_dice, 6)) + 2
-            dagger = sum(roll(1, 4)) + 2
-            [magic, dagger]
+            runs.times { res += sum(b.call()) }
+            res / runs
         end
 
-        # Roll for sneak-attack damage
-        # Character-specific to Shalizara
-        # @see #normal_damage
-        def sneak_damage(magic_damage_dice = 2)
-            sneak = sum(roll(5, 6))
-            reg = normal_damage(magic_damage_dice)
-            reg << sneak
-            reg
+        # roll verbosely
+        def verbose(&block)
+            old_v = @verbose
+            @verbose = true
+            res = block.call()
+            @verbose = old_v
+
+            res
         end
     end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pathfinder-dnd-tools
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -97,3 +97,4 @@ signing_key:
 specification_version: 3
 summary: D&D Tools
 test_files: []
+has_rdoc: