dungeonsofheck 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3384c1790589b6ee3953103b5c6f9ce2bda7d5314df8e2e641743420bd97737d
+  data.tar.gz: 6956c387947b7f6ed155ef488f47c307a398cccb350fc7ca04be2eab31eccb16
+SHA512:
+  metadata.gz: 8db36a71d96d214aeb799cc188213f333b49947e65d8efd62f82adfb660935f33a5fa31e3a9798812f5faa82fd8d108d3af76c069e526fce6a7bf9c1ea39dbdf
+  data.tar.gz: 5087028fcaca29848ef66f351f5be88f10ac14aec5d79886d725d403f651081e560c3c63e0599d7ac8506fa4e08839733b0eab5bea80484ac99b2abbe74937b0

data/README.md

@@ -0,0 +1,44 @@
+# DungeonsOfHeck
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/DungeonsOfHeck`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'DungeonsOfHeck'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install DungeonsOfHeck
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/DungeonsOfHeck. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/DungeonsOfHeck/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DungeonsOfHeck project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/DungeonsOfHeck/blob/master/CODE_OF_CONDUCT.md).

data/dungeonsofheck.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+    s.name        = 'dungeonsofheck'
+    s.version     = '1.0'
+    s.license     = 'MIT'
+    s.date        = '2020-10-02'
+    s.summary     = "Dungeons of Heck"
+    s.description = "A gem for playing the game Dungeons of Heck"
+    s.authors     = ["Alex Berenger Pike"]
+    s.email       = 'alex.pike.ap@outlook.com'
+    s.files       = Dir['lib/*.*']
+    s.files      += Dir['[A-Z]*'] + Dir['spec/*']
+    s.files.reject! { |fn| fn.include? "CVS" }
+    s.homepage    = 'https://github.com/theRamenWithin/Assignments/tree/master/Term1/Assignment3'
+end

data/lib/Gemfile.lock

@@ -0,0 +1,62 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.8.1)
+    diff-lcs (1.4.4)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    strings (0.2.0)
+      strings-ansi (~> 0.2)
+      unicode-display_width (~> 1.5)
+      unicode_utils (~> 1.4)
+    strings-ansi (0.2.0)
+    tty-box (0.6.0)
+      pastel (~> 0.8)
+      strings (~> 0.2.0)
+      tty-cursor (~> 0.7)
+    tty-color (0.5.2)
+    tty-cursor (0.7.1)
+    tty-font (0.5.0)
+    tty-prompt (0.22.0)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.8.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    tty-table (0.12.0)
+      pastel (~> 0.8)
+      strings (~> 0.2.0)
+      tty-screen (~> 0.8)
+    unicode-display_width (1.7.0)
+    unicode_utils (1.4.0)
+    wisper (2.0.1)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+
+DEPENDENCIES
+  colorize (~> 0.8.1)
+  rspec (~> 3.9)
+  tty-box (~> 0.6.0)
+  tty-font (~> 0.5.0)
+  tty-prompt (~> 0.22.0)
+  tty-table (~> 0.12.0)
+
+BUNDLED WITH
+   2.1.4

data/lib/actions.rb

@@ -0,0 +1,97 @@
+module Action
+
+    # Method for moving between locations
+    def move
+        prompt.select("Where will you move to?".blue) do |menu|
+            Game::ROOM_ATTR[Game::PLAYER_ATTR[:player_location_id]][:move_locations].each do |move_to|
+                # If the location is open, list it as an option.
+                if move_to[:open?] 
+                    menu.choice "#{move_to[:name].capitalize}", -> {Game::PLAYER_ATTR[:player_location_id] = move_to[:id]}
+                end
+            end
+            menu.choice "Cancel", -> {next}
+        end
+    end
+
+    def interact(interact_object)
+        prompt.keypress("Press space or enter to continue".green, keys: [:space, :return])
+
+        # If the interactible has not been used, puts the use success message.
+        if !interact_object[:used?] 
+
+            # If the object needs something to use, check inventory for anything with a matching item_id.
+            if !interact_object[:needs].nil?
+                # If there's a match, delete the item from the inventory and continue, else fail.
+                if Game::PLAYER_ATTR[:inventory].any? {|h| h[:item_id] == interact_object[:needs]}
+                    Game::PLAYER_ATTR[:inventory].delete_at(Game::PLAYER_ATTR[:inventory].index { |v| v[:name] == Game::ITEM_LIST[interact_object[:needs]][:name] })
+                else
+                    return puts interact_object[:use_text_fail]
+                end
+            end
+            
+            # Indicate that the object is now used and puts the successful use message
+            interact_object[:used?] = true
+            puts interact_object[:use_text_success]
+
+            # Unless the interactible gives no item, add the item to the player inventory.
+            unless interact_object[:contains].nil?
+                Game::PLAYER_ATTR[:inventory] << Game::ITEM_LIST[interact_object[:contains]]
+                puts "\n#{Game::PLAYER_ATTR[:inventory].last[:name].upcase.light_green} was added to inventory."
+            end
+
+            # If the interactible has an affect on the room, call used effect proc
+            unless interact_object[:use_effect].nil?
+                interact_object[:use_effect].call
+            end
+        
+        # If the interactible has been used, put the used message
+        elsif interact_object[:used?] 
+            puts interact_object[:used_text] 
+        end
+    end
+
+    # Method for using interactibles in a room if they exist
+    def use
+        inter = Game::ROOM_ATTR[Game::PLAYER_ATTR[:player_location_id]][:interactibles]
+
+        # Unless there's nothing to use, list print out thing to interact with.
+        unless inter.nil?
+            prompt.select("What will you use?") do |menu|
+                inter.each do |interact_object|
+                    if interact_object[:accessible?]
+                        menu.choice "#{interact_object[:name]}", -> {puts "#{interact_object[:use_text_look]}"; interact(interact_object)}
+                    end
+                end
+            end
+        else
+            puts "There is nothing around you that you can use."
+        end
+        prompt.keypress("Press space or enter to continue".green, keys: [:space, :return])
+    end
+
+    # Method for displaying the contents of the player inventory
+    def bag
+        bag_contents
+        prompt.keypress("Press space or enter to continue".green, keys: [:space, :return])
+    end
+
+    def bag_contents
+        if Game::PLAYER_ATTR[:inventory].length > 0
+            rows = Game::PLAYER_ATTR[:inventory].map { |v| [v[:name].light_green,v[:examine_text]] }
+            bag_table = TTY::Table.new(header: ["Item", "Description"], rows: rows)
+            puts bag_table.render(:unicode, multiline: true, padding: [1,0])
+        else
+            puts "\nYour bag is empty. You shake the bag in your mouth sadly."
+        end
+    end
+
+    # Method for exiting to main menu
+    def exit_game
+        prompt.select("Are you sure you want to quit and return to the main menu? (progress will be lost)".red) do |menu|
+            menu.choice "Yes", -> {Game.new.main_menu}
+            menu.choice "No", -> {Game.new.game_menu}
+        end
+    end
+
+    module_function :move, :interact, :use, :bag, :bag_contents, :exit_game
+end

data/lib/battle.rb

@@ -0,0 +1,53 @@
+module Battle
+
+    def fight
+        # Shorter variables for monster attributes
+        mon = Game::MON_LIST[Game::ROOM_ATTR[Game::PLAYER_ATTR[:player_location_id]][:monster_id]]
+
+        # Monster intro text
+        puts mon[:monster_intro]
+        puts "\nFight to survive!"
+
+        # Main combat loop
+        while mon[:monster_hp] > 0
+            prompt.keypress("Press space or enter to attack!".red, keys: [:space, :return])
+            attack = rand(Game::PLAYER_ATTR[:player_attack])
+            mon[:monster_hp] -= attack
+
+            unless mon[:monster_hp] < 0
+                puts "\n#{mon[:name].upcase.red} - HP #{mon[:monster_hp]}/#{mon[:monster_hp_max]}"
+            else
+                puts "\n#{mon[:name].upcase.red} - HP 0/#{mon[:monster_hp_max]}"
+            end
+
+            puts "Using your #{'PAW'.light_green}, you boop the snoot of #{mon[:name].upcase.red} doing #{attack} damage."
+
+            if mon[:monster_hp] < 1
+                break
+            end
+            
+            puts mon[:monster_attack_text]
+            puts "\nYou feel slightly demoralised."
+        end
+
+        #Victory announcement and set monster defeat
+        Game::ROOM_ATTR[Game::PLAYER_ATTR[:player_location_id]][:monster_defeat?] = true
+        puts mon[:monster_defeat_text]
+        puts "\n#{'Victory!'.blue}"
+
+        # If monster has loot, add it to player inventory with message.
+        unless mon[:loot].nil?
+            Game::PLAYER_ATTR[:inventory] << Game::ITEM_LIST[mon[:loot]]
+            puts "\n#{mon[:name].upcase.red} dropped #{Game::ITEM_LIST[mon[:loot]][:name].upcase.light_green}. You add it to your bag."
+        end
+
+        prompt.keypress("Press space or enter to continue".green, keys: [:space, :return])
+    
+        # If defeating the monster has an affect on the room, call the block
+        unless mon[:monster_defeat_effect].nil?
+            mon[:monster_defeat_effect].call
+        end
+    end
+
+    module_function :fight
+end

data/lib/doge.txt

@@ -0,0 +1,35 @@
+                                  .╔M╔,
+                                  ││║║▒                                 ..╓╓
+                                  ││╠║║░,                             (N║║║║▒⌂
+                                  ││║║▒║▒╔                          (NN╠╚║║▒▒▒
+                                  ││╠║╢▒║║N,                     .╔N║╠╠║║║║╢▒▒░
+                                  ║Ñ║╠╠▒║║║╠M╔╓╓,              ╓#║▒▒╠║║║▒▒▒║╢▒▒
+                                 ╔║╠ÑÑ┤┤┤┤┤┤Ñ╠╠╠╠╠╠╠╠╠║#MMM#M##║║▒▒║║║▒╢▒▒▒▒▒╢▒
+                               .╓╙│││││┤┤╠╠╠║║╠╠╠╠╡┤┤┤┤┤Ñ╠╠║▒▒║▒▒▒║║╢▒▓▓▓▓▒▒╢▒▒
+                            ,╔∩│∩│∩∩│││┤Ñ╠╠║╠╠╠╠╠╠╠Ñ╠Ñ┤┤Ñ╠╠╠Ñ║▒▒▒▒║╠║▒▓▓▓▓▒▒║║Ñ
+                         .(│∩│││∩∩∩∩∩∩│┤Ñ║║║╠╠║╠╠╠╠╠╠╠╠╠╠Ñ╠╠╠╠╠╠▒▒▒╢▓██▓▓▒╠║║▒
+                        (∩∩∩⌠││∩│∩∩∩∩∩│╠╠║╠╠╠╠╠╚┤╚┤╠Ñ║Ñ╠╠╠╠ÑÑ╠╠Ñ╠║╢▓██▓▒▒▒║▒▒░
+                    #▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓███████▓▓▓▓▓███████████████████████▒▒║▒∩
+                    ╫████████████▀╙█▌╙██▀▀▀███████████▀╙█▌╙████▀▀▀▀▀▀▀▀▀▀▀████▓▓µ
+                   .╙▀██████████▀@▄▀║▄██┤┤┤██████████▀@▄▀▀▄██▀ÑÑ┤┤┤NN┤┤┤╠║▀███▀▀▒▄
+                   └'`▀█████████▄██▄╫█▀▀││╠▀███████▀▀▄╜▀▄▐██▀╠┤┤┤ÑÑ┤┤┤┤Ñ╠╠║║▒▒║╠▀▀
+                       ╙▀▀▀▀▀▀▀▀▀▀▀▀▀▀W│││╠║╢██████▄▄█▌▄██▀Ñ╚┤┤┤┤┤┤┤┤┤┤┤╠╠╠║║╠╠╠∩
+                  .    :'└└∩│∩│∩∩∩│∩∩∩∩│││┤╠║╠███████████▌│∩└│││││││││││┤┤Ñ╠╠╠║╠╠,
+                    :.  .╓##▒▒▒░#┤∩│∩∩∩││││┤╠┤┤┤╠╠ÑÑ┤N╠┤∩│∩∩∩∩∩∩N││∩∩│││││┤┤╠╠╠╠╠N
+                 ∩:;   #████████▓▓▒∩∩∩∩└││││┤│∩│││╚╚┤┤┤┤∩│∩∩∩∩∩∩└││∩∩│∩∩││││┤ÑÑ┤┤N,
+                :`7∩∩ (║███████████Ñ∩∩(∩∩││││∩│∩∩∩∩∩∩││││∩∩∩∩∩∩∩∩∩∩∩∩│││∩││┤N╠╠┤┤┤Γ
+                ' (,:┐N║██████████▒Ñ∩∩∩N╔││NN∩∩∩∩∩∩∩∩∩∩∩∩∩∩∩∩∩∩∩∩∩│││┤┤││┤╠║║╠╠ÑÑ╡Γ
+                ∩'.:│N║▒▒███████▓▒║╡╙┤│∩││N┤∩∩∩│││∩∩∩∩∩∩∩∩∩∩∩∩││││┤│┤┤┤┤Ñ┤╠║║╠╠╠Ñ╡Γ
+                ;::(││║▒▓▓▓█▓██▓▓▒╠▒╠ÑÑ┤Ñ╠┤┤┤∩N││N││∩││NNN││N│NN┤┤┤││││┤N╠║╠║╠╠╠╠╠
+                (::(∩│╙║▓██████▓▓▒▒▒╠║╠╠╠Ñ╠║║║║╡┤┤┤┤N┤┤┤┤┤│┤┤┤┤││││││││╚╠╠╠║╠╠║║╠
+                  :''(∩╙▒▓█████████▓▒▒▒▒▒▓▓▓▓▓╠╠╠┤┤┤┤┤╚│││││┤│││∩∩│││││┤N╠╠╠╠║║║
+                 `:(∩└└││Ñ▒▒▓█▓▀█▓████▒▒▒▒▒▒▒Ñ┤┤┤┤┤┤┤││N┤││││NN│││││NNN╠╠║╠║╠║▒
+                  └::(∩│∩│Ñ║▒▒▒▒║╠╠║║╠╠║║╠╠╠┤┤┤┤Ñ┤┤Ñ┤┤┤┤│┤││││││┤┤│┤Ñ╠Ñ║║╠╠║║▒
+                  `∩∩∩∩∩│∩∩│││┤│┤┤┤┤╠ÑÑ┤NNN╠┤Ñ╠╠┤┤┤ÑÑ┤┤┤│││∩∩││N┤┤╠╠╠╠╠╠║║╠▒╙
+                   └∩∩∩∩∩∩││∩││││┤┤┤╠┤┤╠╠╠╠Ñ╠╠Ñ╠╠╠┤┤│││││││NNN││┤╠ÑÑ║║║║▒╙
+                    ││∩∩∩∩││∩│┤││││┤Ñ╠┤┤╠╠ÑÑÑ╠ÑÑÑ┤┤││││∩│││┤N┤┤┤Ñ┤┤Ñ╠║║┘
+                    `│││││││││││┤┤┤┤┤┤Ñ╠ÑÑ╠┤┤Ñ╠╠╠┤┤│N∩││┤┤NÑÑ┤┤┤╠┤╚║╙
+                      └│││┤││││││┤┤┤┤┤Ñ┤┤╠╠╡ÑÑ╠╠╠Ñ╠╠╠╠Ñ╠╠╠Ñ┤┤┤N╙└"
+                        `└│┤┤┤NNNÑÑ┤┤Ñ╠╠╠╠╠╠╠╠║║╠║║║║╠╠Ñ┤Ñ╚┘"
+                           `└└╚╠║║║║╠║║║║║║║║║╠╠╠╠╠╚Ñ╚└`
+                                 '└╙╚╚╚╚╚╚╚╙╙╙╙└'

data/lib/dungeonsofheck.rb

@@ -0,0 +1,25 @@
+# Import local modules
+require_relative 'main'
+require_relative 'actions'
+require_relative 'battle'
+
+
+
+# Start Game
+if ARGV.empty?
+    new_game = Game.new
+    new_game.main_menu
+elsif ARGV[0] == "-h" || ARGV[0] == "--help"
+    puts "--- Help ---"
+    puts "Usage:"
+    puts "  To install this gem, run:\n"
+    puts "  gem install ./dungeonsofheck-1.0.gem"
+    puts "  irb"
+    puts "  require 'dungeonsofheck'"
+    puts "  OR"
+    puts "  ruby ./lib/dungeonsofheck.rb"
+    puts "Options:"
+    puts "  -h or --html        # get help file"
+    puts "Example:"
+    puts "  ruby ./lib/dungeonsofheck.rb -h"
+end

data/lib/main.rb

@@ -0,0 +1,248 @@
+# Import gem modules
+require 'tty-box'
+require 'tty-font'
+require 'tty-table'
+require 'tty-prompt'
+require 'colorize'
+
+# Error handling classes for input validation
+class NotValidName < StandardError
+    def initialize(msg="\nForgetful doge, surely you remember your own name? (Name can only contain letters and must be less than 8 characters)".light_blue)
+    super(msg)
+    end
+end
+class NotValidAge < StandardError
+    def initialize(msg="\nForgetful doge, surely you remember your own age? (Age can only contain numbers)".light_blue)
+    super(msg)
+    end
+end
+
+# Declare methods for gem module functionality
+def prompt
+    TTY::Prompt.new(symbols: {marker: "🐕"})
+end
+def font
+    TTY::Font.new(:doom)
+end
+
+class Game
+
+    # =========================
+    # Declare constants for attribute storage
+    # =========================
+    ROOM_ATTR = [
+                {location_id: 0,
+                location_name: "Entrance",
+                move_locations: [{name: "gate", 
+                                id: 1, 
+                                open?: true}],
+                intro_text: "The dirt road under your beans is cold and dusty. You stand before a tall, iron #{'GATE'.yellow} flanked by high, stone walls. Beside the gate, in the bushes, you spot what could be a #{'CHEST'.green}. Beyond the gate, you see a courtyard and an imposing castle in the distance.",
+                look_text: "The entrance feel lonely. A strong breeze kicks up the small stones and dirt from the path, making you squint. The #{'GATE'.yellow} is your only way forward. Beside it, you spot what could be a #{'CHEST'.green}.",
+                interactibles: [{name: "Chest", 
+                                    needs: nil,
+                                    use_text_look: "\nHidden under some low shrubbery, the metal glint of a small chest catches your eye.",
+                                    use_text_success: "\nYour nails clack noisily against the #{'CHEST'.green} as you fumble it open and retreive a #{'LETTER'.light_green} from inside. Only now do you notice the stake rising from the ground and realise that you just raided the fallen off mailbox of the #{"HECK WIZARD".red}. Boy is he going to be mad.",
+                                    use_text_fail: "\nSomehow you failed to open the #{'CHEST'.green}, even though I didn't program that to be possible.",
+                                    used_text: "\nThe #{'BROKEN MAILBOX'.green} lies forlornly under the bush, empty and mailless.",
+                                    used?: false,
+                                    use_effect: nil,
+                                    accessible?: true,
+                                    contains: 0}],
+                monster?: false,
+                monster_defeat?: false,
+                visited?: false},
+
+                {location_id: 1,
+                location_name: "Courtyard",
+                move_locations: [{name: "Entrance", 
+                                id: 0, 
+                                open?: true},
+
+                                {name: "crypt", 
+                                id: 2, 
+                                open?: false}],
+                intro_text: "You enter the medium sized, gravel covered courtyard via the gate. Dense hedges line the surrounding walls behind and to your side. The middle of the courtyard contains an #{'ALTAR'.green} with shallow pools at its four corners. Between you an the castle you realise is an expansive garden and cemetary. An #{'UNREASONABLY LARGE DOGE'.red} stands in front of the #{'CRYPT DOOR'.yellow} that seems to be your only way forward.",
+                look_text: "The sound of water tinkling in the pools around the #{'ALTAR'.green} might be calming if the #{'COURTYARD'.yellow} was not so desolute. The #{'UNREASONABLY LARGE DOGE'.red} continues to block the way to the #{'CRYPT DOOR'.green}.",
+                interactibles: [{name: "Crypt Door",
+                                    needs: 2,
+                                    use_text_look: "\nThe #{'UNREASONABLY LARGE DOGE'.red} was standing guard in front of the #{'CRYPT DOOR'.green} before you gave him a booping he will never forget. It stands tall in dark mahogony, embellished with iron trimming.",
+                                    use_text_success: "\nThe #{'KEY'.light_green} goes in after a few good slaps. Twisting it with your mouth, the locking mechanism clunks heavily and the #{'CRYPT DOOR'.green} swings in on your weight revealing a path to the #{'CRYPT'.yellow}.",
+                                    use_text_fail: "\nNo amount of pawing and whining at this door will convinced a human to open it for you. Some kind of key shaped hole is the only opening you can see.",
+                                    used_text: "\nAn overwhelming feeling of dread washes over you. The #{'CRYPT'.yellow} beckons.",
+                                    used?: false,
+                                    use_effect: proc {Game::ROOM_ATTR[1][:move_locations][1][:open?] = true},
+                                    accessible?: false,
+                                    contains: nil},
+
+                                    {name: "Altar",
+                                    needs: 1,
+                                    use_text_look: "\nThe #{'ALTAR'.green} is a marbled white, stone slab in the center of the courtyard. You jump up with your front paws on the surface and snoot peeking over the top and see a bone shaped recess in the middle of the #{'ALTAR'.green}.",
+                                    use_text_success: "\nYou drop the #{'CRYSTAL BONE'.light_green} into the #{'CRYSTAL BONE'.light_green} shaped slot in the #{'ALTAR'.green} and give it a good few tippy tap whacks until it rotates just right, fixing itself to the slot. You hear one face of the #{'ALTAR'.green} open with a thud, revealing a small chamber housing a #{'KEY'.light_green}.",
+                                    use_text_fail: "\nPerhaps something goes into the slot.",
+                                    used_text: "\nThere is nothing more to do here except maybe salivated over the #{'CRYSTAL BONE'.light_green}, even though you know it's too hard to chew.",
+                                    used?: false,
+                                    use_effect: nil,
+                                    accessible?: true,
+                                    contains: 2}],
+                monster?: true,
+                monster_id: 0,
+                monster_defeat?: false,
+                visited?: false},
+
+                {location_id: 2,
+                location_name: "Crypt",
+                move_locations: [{name: "Courtyard", 
+                                id: 1,
+                                open?: true}],
+                intro_text: "You descend into the spooky crypt. It smells like dank and not in a good way. The stairs lead to a chamber lit by torches that just light themselves I guess. You no have time to think about the mechanics of a centralised, automatic torch refueling and ignition system because in the middle of the chamber you spot a #{'NOISY HOOVER'.red}!",
+                look_text: "The #{'NOISY HOOVER'.red} dominates the unnaturally clean chamber with its stillness. Perhaps it is asleep? Either way, you must strike to save the land!",
+                interactibles: nil,
+                monster?: true,
+                monster_id: 1,
+                monster_defeat?: false,
+                visited?: false}
+                ]
+
+    PLAYER_ATTR = {player_name: "",
+                player_age: 0,
+                player_location_id: nil,
+                player_attack: 1..4,
+                inventory: []}
+
+    ITEM_LIST = [
+                {name: "Letter",
+                item_id: 0,
+                examine_text: "\"FINAL NOTICE OF NON-PAYMENT!\" reads the letter. The rest is chewed up and illegiable. \nProbably by some other doge or maybe cat. Oh heck."},
+                
+                {name: "Crystal Bone", 
+                item_id: 1,
+                examine_text: "A heckin' huge sparkly, omnious bone that's far too made of crystal to chew on."},
+            
+                {name: "Key", 
+                item_id: 2,
+                examine_text: "A perfectly normal bone key with a not at all spooky skull motif in the handle. This is \nfine."}
+                ]
+
+    MON_LIST = [
+                {name: "unreasonably large doge",
+                monster_hp: 10,
+                monster_hp_max: 10,
+                monster_intro: "\nAn #{'UNREASONABLY LARGE DOGE'.red} blocks your path. He's just standing there with a dumb look on his face while being too big!", 
+                monster_attack_text: "\nThe #{'UNREASONABLY LARGE DOGE'.red} stands over you imposingly and drools on you a little.",
+                monster_defeat_text: "\nThe #{'UNREASONABLY LARGE DOGE'.red} finally notices your attacks, licks your face and goes to take a nap in the corner, revealing the #{'CRYPT DOOR'.green} behind it.",
+                monster_defeat_effect: proc {Game::ROOM_ATTR[1][:interactibles][0][:accessible?] = true},
+                loot: 1},
+
+                {name: "noisy hoover", 
+                monster_hp: 20,
+                monster_hp_max: 20,
+                monster_intro: "\nThe #{'NOISY HOOVER'.red} springs to life, whirring and undulating. You know it will not stop until everything is clean!", 
+                monster_attack_text: "\nThe #{'NOISY HOOVER'.red} cleans the floor back and forth in front of you, evily.",
+                monster_defeat_text: "\nThe #{'NOISY HOOVER'.red} splutters and then explodes dramatically. Do those things even have gasoline tanks? W-Wow, that's a lot of fire. Better get the heck out of here!",
+                monster_defeat_effect: Proc.new {Game.final},
+                loot: nil}
+                ]
+
+    # =========================
+    # Final text sequence and end of game
+    # =========================
+    def self.final
+        box = TTY::Box.frame(width: 100, height: 15, align: :center, padding: 3, border: :thick,
+            title: {top_left: "|Dungeons of Heck|", bottom_right: "|Final|"}) do
+                "You, #{PLAYER_ATTR[:player_name].upcase.yellow}, flee the flaming #{'CRYPT'.green} as smoke billows out from the entrance and between the ancient brickwork. With suprising speed, you seen the #{"HECK WIZARD".red} is giving chase and boy is he mad! \nLike the wind, out the #{'GATE'.green} you shoot and down the road. \nThe #{"HECK WIZARD".red} chases you for a little bit but turns around when he hears the fire engine coming down the road from the other direction. \nOne day you may return but for now you think you better lay low and content yourself with having rid the land of one more #{'NOISY HOOVER'.red}."
+            end
+        system('clear') || system('cls')
+        puts box
+        prompt.keypress("Press space or enter to fulfill your destiny!".green, keys: [:space, :return])
+        exit
+    end
+
+    # =========================
+    # Method for game menu loop
+    # =========================
+    def game_menu
+        system('clear') || system('cls')
+        box = TTY::Box.frame(width: 100, height: 13, align: :center, padding: [3,0], border: :thick,
+            title: {top_left: "|Dungeons of Heck|", bottom_right: "|Location: #{ROOM_ATTR[PLAYER_ATTR[:player_location_id]][:location_name]}|"}) do
+                if ROOM_ATTR[PLAYER_ATTR[:player_location_id]][:visited?]
+                    ROOM_ATTR[PLAYER_ATTR[:player_location_id]][:look_text]
+                else
+                    ROOM_ATTR[PLAYER_ATTR[:player_location_id]][:intro_text]
+                end
+            end
+        puts box
+        ROOM_ATTR[PLAYER_ATTR[:player_location_id]][:visited?] = true
+
+        prompt.select("Choose your FATE".red) do |menu|
+            if ROOM_ATTR[PLAYER_ATTR[:player_location_id]][:monster?] && !ROOM_ATTR[PLAYER_ATTR[:player_location_id]][:monster_defeat?]
+            menu.choice "Fight!", -> {Battle::fight; game_menu}
+            end
+            menu.choice "Move", -> {Action::move; game_menu}
+            menu.choice "Use", -> {Action::use; game_menu}
+            menu.choice "Inventory", -> {Action::bag; game_menu}
+            menu.choice "Quit", -> {Action::exit_game}
+        end
+    end
+
+    # =========================
+    # Method for getting the player name and introducting the player to the game before starting the game_menu loop
+    # =========================
+    def introduction
+        puts "\nHumble doge, what is your true name?".light_blue
+        begin
+            PLAYER_ATTR[:player_name] = gets.chomp.strip.upcase
+        raise NotValidName if PLAYER_ATTR[:player_name].match?(/[^a-zA-Z]/) || PLAYER_ATTR[:player_name].length > 7 || PLAYER_ATTR[:player_name].length < 1 # Name must be letters and less than 8 characters
+        rescue NotValidName => e
+            puts e.message
+            retry
+        end
+
+        puts "\nHumble doge, what is your true age?".light_blue
+        begin
+            PLAYER_ATTR[:player_age] = Integer(gets) rescue 0
+        raise NotValidAge unless PLAYER_ATTR[:player_age] > 0
+        rescue NotValidAge => e
+            puts e.message
+            retry
+        end
+        
+        if PLAYER_ATTR[:player_age] > 15
+            puts "\nWow, that's heckin' old for a doge but if you say so.".light_blue
+        else
+            puts "\n#{PLAYER_ATTR[:player_age]} is a fine age for a doge adventurer such as yourself.".light_blue
+        end
+
+        puts "\nMighty ".light_blue + "#{PLAYER_ATTR[:player_name].upcase.yellow}" + ", this is your tale.".light_blue
+
+        box = TTY::Box.frame(width: 100, height: 15, align: :center, padding: 3, border: :thick,
+            title: {top_left: "|Dungeons of Heck|", bottom_right: "|Introduction|"}) do
+                "The cold wind blows harshly against your snoot. You lick it to keep it moist and glistening as you take in your surroundings. \nYou are #{PLAYER_ATTR[:player_name].upcase.yellow} and you are a #{'GOOD BOY'.green}. \nYou have travelled following rumours and tales of a heckin' evil place where #{'BAD DOGES'.red} and \n#{'NOISY APPLIANCES'.red} are said to lurk. You have tasked yourself with destroying heckin' bad things across the land and now you have arrived outside the grounds of an imposing castle said to be built upon the most heckin' place of all, the #{'DUNGEONS OF HECK'.red}."
+            end
+
+        prompt.keypress("Press space or enter to continue".green, keys: [:space, :return])
+        system('clear') || system('cls')
+        puts box
+
+        prompt.keypress("Press space or enter to continue".green, keys: [:space, :return])
+        PLAYER_ATTR[:player_location_id] = 0
+        game_menu
+    end
+
+    # =========================
+    # Method for the main menu when starting the game
+    # =========================
+    def main_menu
+        system('clear') || system('cls')
+        puts font.write("DUNGEONS OF HECK").red
+
+        # acsii = File.open('doge.txt').read
+        # acsii.each_line { |line| puts line }
+
+        # puts ''
+        prompt.select("Choose your FATE".red) do |menu|
+            menu.choice "Start", -> {introduction}
+            menu.choice "Quit", -> {exit}
+        end
+    end
+
+end

data/spec/actions_spec.rb

@@ -0,0 +1,15 @@
+require_relative '../lib/main'
+require_relative '../lib/actions'
+
+describe 'bag contents' do
+    it 'should puts text to indicate that the bag is not empty' do
+        Game::PLAYER_ATTR[:inventory] = [{name: "Name", examine_text: "Examine"}]
+        expect{Action::bag_contents}.to output("┌────┬───────────┐\n│    │           │\n│Item│Description│\n│    │           │\n├────┼───────────┤\n│    │           │\n│\e[0;92;49mName\e[0m│Examine    │\n│    │           │\n└────┴───────────┘\n").to_stdout
+    end
+
+    it 'should puts text to indicate that the bag is empty' do
+        Game::PLAYER_ATTR[:inventory] = []
+        expect {Action::bag_contents}.to output("\nYour bag is empty. You shake the bag in your mouth sadly.\n").to_stdout
+    end
+
+end

data/spec/main_spec.rb

@@ -0,0 +1,23 @@
+require_relative '../lib/main'
+
+describe 'introduction name' do
+    it 'should raise an error for invalid input' do
+        Game::PLAYER_ATTR[:player_name] = "123"
+        expect {raise NotValidName if Game::PLAYER_ATTR[:player_name].match?(/[^a-zA-Z]/) || Game::PLAYER_ATTR[:player_name].length > 7}.to raise_error(NotValidName)
+    end
+    it 'should not raise an error for valid input' do
+        Game::PLAYER_ATTR[:player_name] = "ALEX"
+        expect {raise NotValidName if Game::PLAYER_ATTR[:player_name].match?(/[^a-zA-Z]/) || Game::PLAYER_ATTR[:player_name].length > 7}.to_not raise_error(NotValidName)
+    end
+end
+
+describe 'introduction age' do
+    it 'should raise an error for invalid input' do
+        Game::PLAYER_ATTR[:player_age] = Integer("ALEX") rescue 0
+        expect {raise NotValidAge unless Game::PLAYER_ATTR[:player_age] > 0}.to raise_error(NotValidAge)
+    end
+    it 'should not raise an error for valid input' do
+        Game::PLAYER_ATTR[:player_age] = Integer(123) rescue 0
+        expect {raise NotValidAge unless Game::PLAYER_ATTR[:player_age] > 0}.to_not raise_error(NotValidAge)
+    end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: dungeonsofheck
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Alex Berenger Pike
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-10-02 00:00:00.000000000 Z
+dependencies: []
+description: A gem for playing the game Dungeons of Heck
+email: alex.pike.ap@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- dungeonsofheck.gemspec
+- lib/Gemfile.lock
+- lib/actions.rb
+- lib/battle.rb
+- lib/doge.txt
+- lib/dungeonsofheck.rb
+- lib/main.rb
+- spec/actions_spec.rb
+- spec/main_spec.rb
+homepage: https://github.com/theRamenWithin/Assignments/tree/master/Term1/Assignment3
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Dungeons of Heck
+test_files: []