ruby-perlin-2D-map-generator 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e6cc04acc39df3077354eadba18f3dc043c2eca6806c14429b8468990aaa9f5
-  data.tar.gz: f3ec0afeb64bea28b1c5593b1648ff1effad677fc595a00748e7fc79349138d4
+  metadata.gz: 1bd8731cdd9870723cfcb6b977f7d111cc160591f727598ae05be919d6dd231f
+  data.tar.gz: d13ec13f781e96e6251bf37ee54d998c065698063e59d99b8143735c48e7e28a
 SHA512:
-  metadata.gz: 1a5b8063ab6ce6a9dd92774686e42a4b9ecaa30a9b1d0df14676b76e4a83d9213a5d14268d3ed5945d554cc4c8eb41a128657aca4243257d04f1a40bb54a5b5c
-  data.tar.gz: 6d6e443145404ccd4d937723150b02953d5231e6a3d2b8f7287750bb79199cc5db275bdd44664d9025522a637b3f9104f852e3b652aefbe6ef395163e7b84f3e
+  metadata.gz: 766f4c73584e9e5152bf6842790bb3f330ca7d7fd9b46ab7427754f4c7869c0529e870827f181b0523f341d9134e8c5fdce18eecc2ef8a9ad2d22f17112cb040
+  data.tar.gz: ed3f8b411ccced1c278e0038abd92ccb6f856f67b683f13ab5298b51f762e71683efecf69e87ab53b56ecacf24859a8541336330fb65dcb15da2a8ae1e3b2740

data/README.md

@@ -1,4 +1,10 @@
 # Ruby Perlin 2D Map Generator
+
+[![Gem Version](https://badge.fury.io/rb/ruby-perlin-2D-map-generator.svg)](https://badge.fury.io/rb/ruby-perlin-2D-map-generator)
+![CI Status](https://github.com/matthewstyler/ruby-perlin-2D-map-generator/actions/workflows/main.yml/badge.svg)
+![CodeQL](https://github.com/matthewstyler/ruby-perlin-2D-map-generator/workflows/CodeQL/badge.svg)
+[![Downloads](https://img.shields.io/gem/dt/ruby-perlin-2D-map-generator.svg?style=flat)](https://rubygems.org/gems/ruby-perlin-2D-map-generator)
+
 A gem that procedurally generates seeded and customizable 2D map using perlin noise.
 
 Include the gem in your project, or use the executable from the command line.
@@ -55,10 +61,26 @@ See Command line Usage for full customization, below are some examples. Alter th
 
 # Generate without rendering
 
-```bash
+```irb
 irb(main):001:0> map = Map.new
-...
-irb(main):002:0> map.describe[1][0]
+```
+
+Map can then be manipulated via traditional x,y lookup
+```irb
+map[x, y].to_h
+=>
+{:x=>0,                                                        
+ :y=>1,                                                        
+ :height=>0.29251394359649563,                                 
+ :moist=>0.29100678755603004,                                  
+ :temp=>0.6034041566100443,                                    
+ :biome=>{:name=>"deep_valley", :flora_range=>1, :colour=>"\e[48;5;47m"},
+ :items=>[]}
+```
+or the less intuitative multidimensional lookup (reversed axis):
+
+```irb
+map.tiles[y][x].to_h
 => 
 {:x=>0,                                                        
  :y=>1,                                                        
@@ -69,6 +91,20 @@ irb(main):002:0> map.describe[1][0]
  :items=>[]}
 ```
 
+or from the command line:
+
+```bash
+$ ruby-perlin-2D-map-generator describe coordinates=0,1
+
+{:x=>0,                                                        
+ :y=>1,                                                        
+ :height=>0.29251394359649563,                                 
+ :moist=>0.29100678755603004,                                  
+ :temp=>0.6034041566100443,                                    
+ :biome=>{:name=>"deep_valley", :flora_range=>1, :colour=>"\e[48;5;47m"},
+ :items=>[]}
+```
+
 # Full Command line Usage
 ```bash
 $ ruby-perlin-2D-map-generator --help
@@ -82,8 +118,14 @@ hashes with each tiles information.
 
 Arguments:
   (DESCRIBE | RENDER)  command to run: render prints the map to standard
-                       output using ansi colors, while describe prints each
-                       tiles bionome information in the map.
+                       output using ansi colors. describe prints each tiles
+                       bionome information in the map, can be combined with the
+                       coordinates keyword to print a specific tile.
+                       (permitted: describe, render)
+
+Keywords:
+  COORDINATES=INT_LIST  Used with the describe command, only returns the given
+                        coordinate tile details
 
 Options:
       --elevation=float  Adjust each generated elevation by this percent (0 -
@@ -127,4 +169,7 @@ Examples:
 
   Render with options
     $ ruby-perlin-2D-map-generator render --elevation=-40 --moisture=25 --hs=1
+
+  Describe tile [1, 1]
+    $ ruby-perlin-2D-map-generator describe coordinates=1,1
 ```

data/lib/CLI/command.rb

@@ -20,14 +20,25 @@ module CLI
 
       example 'Render with options',
               '  $ ruby-perlin-2D-map-generator render --elevation=-40 --moisture=25 --hs=1'
+
+      example 'Describe tile [1, 1]',
+              '  $ ruby-perlin-2D-map-generator describe coordinates=1,1'
     end
 
     argument :command do
       name '(describe | render)'
       arity one
-      validate ->(v) { v.downcase == 'describe' || v.downcase == 'render' }
-      desc 'command to run: render prints the map to standard output using ansi colors, ' \
-           'while describe prints each tiles bionome information in the map.'
+      permit %w[describe render]
+      desc 'command to run: render prints the map to standard output using ansi colors. ' \
+           'describe prints each tiles bionome information in the map, can be combined with ' \
+           'the coordinates keyword to print a specific tile.'
+    end
+
+    keyword :coordinates do
+      arity one
+      convert :int_list
+      validate ->(v) { v >= 0 }
+      desc 'Used with the describe command, only returns the given coordinate tile details'
     end
 
     option :height_seed do
@@ -255,7 +266,7 @@ module CLI
       ))
       case params[:command]
       when 'render' then map.render
-      when 'describe' then puts map.describe
+      when 'describe' then puts(!params[:coordinates].nil? ? map[params[:coordinates][0], params[:coordinates][1]].to_h : map.describe)
       end
     end
 

data/lib/map.rb

@@ -21,6 +21,14 @@ class Map
     end
   end
 
+  # rubocop:disable Naming/MethodParameterName:
+  def [](x, y)
+    raise ArgumentError, 'coordinates out of bounds' if y.nil? || y >= tiles.size || x.nil? || x >= tiles[y].size
+
+    tiles[y][x]
+  end
+  # rubocop:enable Naming/MethodParameterName:
+
   def tiles
     @tiles ||= MapTileGenerator.new(map: self).generate
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-perlin-2D-map-generator
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Tyler Matthews (matthewstyler)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-08 00:00:00.000000000 Z
+date: 2023-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: perlin