gloomhaven 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 393f54e0e2243c1a46963690dbf208357449c18cfa7fc56235917cff2f359e12
-  data.tar.gz: 57e3b110c45dbe0f31a84dfa0c70c81fd3e2eef047d7fb2703dde29ed905b4d1
+  metadata.gz: 0a68a6302a5ef217ff720a198849c57281d97d8f3ab82b408dd84ccd91401c24
+  data.tar.gz: fbde2a84dee1c47de00b31638a6ac8df9ad7f41a428b99e95b90443ac58d0fa4
 SHA512:
-  metadata.gz: 883a4061661982065865e92592f56de5f256f6d7bb0a3c9672e8283e46eb726b2886f42ae7a923fd50b55f619d69a6d35b8f7585aaa58aa28abb036fcd0d5dda
-  data.tar.gz: 777fe4268b9906e35b6c9a4be17516bd029016cfb5c4c145a6c1d644777d497d0c344a1dda29e6c83544067d9a602788b45e87eaab43c834a7e5da6886a63f29
+  metadata.gz: 51acac5cada8f4c9d7ccc16da03cff1214487b6d59e23dadfd46309f18ddd03d128f7d9599d99c5829ff71a359149096c645e3041cbed418ebb698b95bb643a8
+  data.tar.gz: 5e5baa61ed10f61ebc569cb1805975a4f3dd08f5f7ae3ac06a2f9efca277b1a52c6cac5f626c6829c6c12ef992d8a283455d1c89ec0960dacb1b2375a06b1f61

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gloomhaven (1.0.4)
+    gloomhaven (1.0.5)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -46,6 +46,7 @@ require 'gloomhaven'
 => 19
 
 # Let's bless and curse the deck
+# Note that blessing/cursing a deck will automatically reshuffle the remaining (undrawn) cards.
 @deck.bless!
 @deck.curse!
 
@@ -86,4 +87,76 @@ require 'gloomhaven'
   #<Gloomhaven::Card @name="Attack +1", @attack=1, @crit=false, @miss=false, @rolling=false, @shuffle=false>,
   #<Gloomhaven::Card @name="Attack +1", @attack=1, @crit=false, @miss=false, @rolling=false, @shuffle=false>
 ]
+```
+
+#### Player
+Create a `Gloomhaven::Player` `@player` object. Includes attribute tracking for `player#gold`, `player#xp`.
+
+```
+@player = Gloomhaven::Player.new(character_class: 'Mindthief', name: 'Ratteo')
+=> #<Gloomhaven::Player @name="Ratteo" @gold=0 @xp=0>
+
+# check / set gold
+@player.gold
+=> 0
+
+@player.gold = 10
+=> 10
+
+@player.gold
+=> 10
+
+# Note: can do the same attr setting w/ @player.xp
+```
+
+New players have a default, 20-card attack modifier `@deck` object.
+`@player`s can also add valid perks of class `Gloomhaven::Perk` to directly modify their deck.
+
+```
+@player.deck
+=> #<Gloomhaven::Deck>
+
+# Basic starting attack modifier deck comes with each player
+@player.deck.cards.count
+=> 20
+
+# Default characters don't have any perks
+@player.perks
+=> []
+
+# If we add perks, it will directly modify the deck
+# Let's remove two -1 cards
+@player.add_perk!(Gloomhaven::Perk.new('remove_two_minus_one_cards'))
+ => [#<Gloomhaven::Perk:0x007fc6918989b0 @key="remove_two_minus_one_cards", @description="Remove two -1 cards", @adds=[], @removes=[{"card_name"=>"Attack -1", "count"=>2}]>] 
+
+# And confirm the perks
+@player.perks
+=> [#<Gloomhaven::Perk:0x007fc6918989b0 @key="remove_two_minus_one_cards", @description="Remove two -1 cards", @adds=[], @removes=[{"card_name"=>"Attack -1", "count"=>2}]>] 
+
+# Finally, the deck should have two less cards because of the perk.
+@player.deck.cards.count
+=> 18
+
+# Perfect. Let's just double check the cards directly
+p @player.deck.cards.to_a
+[
+  #<Gloomhaven::Card @name="2x", @attack=0, @crit=true, @miss=false, @rolling=false, @shuffle=true>,
+  #<Gloomhaven::Card @name="Attack +0", @attack=0, @crit=false, @miss=false, @rolling=false, @shuffle=false>,
+  #<Gloomhaven::Card @name="Attack +0", @attack=0, @crit=false, @miss=false, @rolling=false, @shuffle=false>,
+  #<Gloomhaven::Card @name="Attack +0", @attack=0, @crit=false, @miss=false, @rolling=false, @shuffle=false>,
+  #<Gloomhaven::Card @name="Attack +0", @attack=0, @crit=false, @miss=false, @rolling=false, @shuffle=false>,
+  #<Gloomhaven::Card @name="Attack +0", @attack=0, @crit=false, @miss=false, @rolling=false, @shuffle=false>,
+  #<Gloomhaven::Card @name="Attack +0", @attack=0, @crit=false, @miss=false, @rolling=false, @shuffle=false>,
+  #<Gloomhaven::Card @name="Attack +1", @attack=1, @crit=false, @miss=false, @rolling=false, @shuffle=false>,
+  #<Gloomhaven::Card @name="Attack +1", @attack=1, @crit=false, @miss=false, @rolling=false, @shuffle=false>,
+  #<Gloomhaven::Card @name="Attack +1", @attack=1, @crit=false, @miss=false, @rolling=false, @shuffle=false>,
+  #<Gloomhaven::Card @name="Attack +1", @attack=1, @crit=false, @miss=false, @rolling=false, @shuffle=false>,
+  #<Gloomhaven::Card @name="Attack +1", @attack=1, @crit=false, @miss=false, @rolling=false, @shuffle=false>,
+  #<Gloomhaven::Card @name="Attack +2", @attack=2, @crit=false, @miss=false, @rolling=false, @shuffle=false>,
+  #<Gloomhaven::Card @name="Attack -1", @attack=-1, @crit=false, @miss=false, @rolling=false, @shuffle=false>, # <-- Note we only have 3x -1 cards now
+  #<Gloomhaven::Card @name="Attack -1", @attack=-1, @crit=false, @miss=false, @rolling=false, @shuffle=false>,
+  #<Gloomhaven::Card @name="Attack -1", @attack=-1, @crit=false, @miss=false, @rolling=false, @shuffle=false>,
+  #<Gloomhaven::Card @name="Attack -2", @attack=-2, @crit=false, @miss=false, @rolling=false, @shuffle=false>,
+  #<Gloomhaven::Card @name="Null", @attack=0, @crit=false, @miss=true, @rolling=false, @shuffle=true>
+]
 ```

data/changelog.md

@@ -1,3 +1,6 @@
+# 1.0.5
+- Updated error message for Player creation to list valid types
+
 # 1.0.4
 - Fixed issues with YAML loading data externally.
 

data/lib/gloomhaven/player.rb

@@ -46,7 +46,9 @@ module Gloomhaven
     def validate_character_class!(character_class)
       raise ArgumentError.new("options[:character_class] cannot be blank") if character_class.nil?
 
-      raise TypeError.new("Invalid character_class: #{character_class} is not supported") unless Gloomhaven::CHARACTERS.keys.include?(character_class.downcase)
+      unless Gloomhaven::CHARACTERS.keys.include?(character_class.downcase)
+        raise TypeError.new("Invalid character_class: #{character_class} is not supported. Must be one of the following: #{Gloomhaven::CHARACTERS.keys}")
+      end
     end
   end
 end

data/lib/gloomhaven/version.rb

@@ -1,3 +1,3 @@
 module Gloomhaven
-  VERSION = '1.0.4'
+  VERSION = '1.0.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gloomhaven
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Teo Dell'Amico