super_simple_world_builder 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de14f50b2e48b61cb7ae290b22dade156d622f48d2385dfcb9adb93eaafdcc89
+  data.tar.gz: 80526ac2883656e8fc735a2baff4058c67505a80c90159aba9d92bdd78083ec4
+SHA512:
+  metadata.gz: 7f2abf5f973ea291d49c42c774b1de12248de91f12c37a9a8e43cd7cd1d6e69233b5817cc93c4c3d85bd7d759e790968146bd0da811363faea8c87dfe7852b91
+  data.tar.gz: 2fcea5a1fd2a7d6cc25d477510471f681420e1bf71ee55438b837416506e51e7ed2370dc5fa401a1d31e1f73b6095c135c0a5d4a06653df44369bddb8b7c9b56

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2020 Kevin Tanyag
+
+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,47 @@
+USE CASES:
+
+1. Your friends bully you because your imaginary role playing worlds are predictable and boring.
+2. You like seeing chars printed in nifty patterns.
+
+HOW TO RUN:
+
+1. Run `ruby super_simple_world_builder.rb`
+2. Follow the prompts
+
+EXAMPLE INPUT:
+
+Guten Tag! Welcome to Super Simple World Builder.
+Enter 1 to build a random world
+Enter 2 to build a custom world
+Please enter your selection (1, 2, or exit):
+2
+Enter the name of your world:
+Community-Town
+Enter the minimum width of the world:
+15
+Enter the minimum height of the world:
+15
+What character do you want to fill the background of your world with? (i.e. any character or single space)
+ 
+How many lake features do you want?
+3
+How many mountain features do you want?
+2
+How many town features do you want?
+3
+How many forest features do you want?
+4
+
+OUTPUT:
+
+1. Console print out of the world map
+2. A text file of the world map
+
+ACHTUNG:
+
+1. Don't worry if the width or height entered is too small. The world will automatically enlarge to fit all features.
+2. World maps look better when you enter a <space> as the character to fill the background.
+3. This is a quick-and-dirty project so yolo with the specs. I added comments as a consolation prize.
+4. See `feature_set.rb` to tweak the features that can be added to the world map.
+5. Interestingly, menu prompts may not show up in the git bash terminal. But they do show up in Windows command prompt, so lmao.
+6. Feel free to tweak the code however you like. I plan to refactor in the future to dry up some sections.

data/bin/super_simple_world_builder

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+require_relative '../lib/super_simple_world_builder/world'
+require_relative '../lib/super_simple_world_builder/feature_set'
+
+module SuperSimpleWorldBuilder
+    features = FeatureSet::FEATURES
+    user_features = {}
+
+    loop do
+        puts "Guten Tag! Welcome to Super Simple World Builder.\n"
+        puts "Enter 1 to build a random world"
+        puts "Enter 2 to build a custom world"
+        puts "Please enter your selection (1, 2, or exit): "
+        answer = gets.chomp.downcase
+
+        case answer
+        when "1"
+            puts "Building a random world..."
+            world = SuperSimpleWorldBuilder::World.new("Randoville#{rand(1..10000000)}", 20, 20)
+            world.print_map_to_console
+            world.export_map_to_file
+            break
+        when "2"
+            puts "Enter the name of your world: "
+            name = gets.chomp
+
+            puts "Enter the minimum width of the world: "
+            width = gets.chomp.downcase.to_i
+
+            puts "Enter the minimum height of the world: "
+            height = gets.chomp.downcase.to_i
+
+            puts "What character do you want to fill the background of your world with? (i.e. any character or single space)"
+            filler = gets.chomp.downcase
+
+            features.each do |f|
+                puts "How many #{f.name} features do you want?"
+                answer = gets.chomp.downcase.to_i
+                user_features[f.name] = answer
+            end
+
+            puts "Generating #{name}..."
+            world = SuperSimpleWorldBuilder::World.new(name, width, height, filler, user_features)
+            world.print_map_to_console
+            world.export_map_to_file
+            break
+        when "quit", "exit"
+            break
+        else
+            puts "Woops. Enter 1, 2, or exit:"
+        end
+    end
+end

data/lib/super_simple_world_builder/feature_set.rb

@@ -0,0 +1,15 @@
+module SuperSimpleWorldBuilder
+    Feature = Struct.new(:name, :width, :height, :filler)
+
+    module FeatureSet
+        FEATURES = [
+            Feature.new(:lake, rand(4..7), rand(5..11), '~' ),
+            Feature.new(:mountain, rand(4..12), rand(2..13), 'M'),
+            Feature.new(:town, rand(4..6), rand(5..14), '#'),
+            Feature.new(:forest, rand(4..10), rand(5..11), '^'),
+        ]
+
+        RANDOM_FEATURE_MIN = 1
+        RANDOM_FEATURE_MAX = 20
+    end
+end

data/lib/super_simple_world_builder/world.rb

@@ -0,0 +1,143 @@
+require_relative 'feature_set'
+
+module SuperSimpleWorldBuilder
+    class World
+        
+        #Number of iterations of randomly placing features on map before enlarging
+        DEPTH_MAX = 30
+        
+        #Number of rows and cols to expand map by
+        DEPTH_INCR = 3
+
+        def initialize(name, width, height, filler=' ', user_features={})
+            @name = name
+            @width = width
+            @height = height
+            @filler = filler
+            @user_features = user_features
+
+            #initialize 2d array
+            @map = Array.new(@height) { Array.new(@width, @filler) }
+            
+            @depth_count = 0
+            @map_enlarged = false
+
+            @features = FeatureSet::FEATURES
+
+            #randomly defines number of each feature if random world created
+            if user_features.empty?
+                @features.each do |f|
+                    @user_features[f.name] = rand(FeatureSet::RANDOM_FEATURE_MIN..FeatureSet::RANDOM_FEATURE_MAX)
+                end
+            end
+
+            add_feature_shuffler.each { |f| add_feature_to_map(f) }
+        end
+
+        #shuffles feature names into array to keep distribution random if map enlarged
+        #iterates over names and adds to map
+        def add_feature_shuffler
+            user_features_shuffled = []
+            @user_features.each do |k, v|
+                v.times {user_features_shuffled << k}
+            end
+
+            user_features_shuffled.shuffle!
+        end
+
+        def get_feature(name)
+            feature = ""
+            @features.each do |f|
+                if f.name == name.to_sym
+                    feature = f
+                end
+            end
+            feature
+        end
+
+        def print_legend
+            puts "Legend"
+            puts "-------"
+            @features.each do |f|
+                puts "#{f.name.capitalize} (#{@user_features[f.name]})".ljust(30, ".") + " #{f.filler}"
+            end
+        end
+
+        def add_feature_to_map(name)
+            feature = get_feature(name)
+
+            #randomly pick x,y coords on map
+            x = rand(0..@map[0].size)
+            y = rand(0..@map.size)
+
+            #if there's enough space at the coords, add the feature to the map
+            #see FeatureSet::FEATURES for dimensions and filler char
+            if enough_space?(x, y, feature)
+                feature.height.times do |i|
+                    feature.width.times do |j|
+                        @map[y+i][x+j] = feature.filler
+                    end
+                end
+            else
+                @depth_count += 1
+
+                #if feature couldn't be placed at coords the max amount of times then enlarge map and try again
+                if @depth_count > DEPTH_MAX
+                    @depth_count = 0
+
+                    #increases HEIGHT of existing 2d arr by DEPTH_INCR
+                    #and fill with existing number of arr elements
+                    DEPTH_INCR.times {@map.push([])}
+                    DEPTH_INCR.times do |i|
+                        @map[0].size.times { @map[@map.size-DEPTH_INCR+i] << @filler }
+                    end
+
+                    #increases WIDTH of existing 2d arr by DEPTH_INCR
+                    @map.size.times do |i|
+                        DEPTH_INCR.times {@map[i] << @filler}
+                    end
+                end
+
+                @map_enlarged = true
+                add_feature_to_map(name)
+            end
+        end
+
+        #point (x,y) indicates top left corner of feature
+        def enough_space?(x, y, feature)
+            result = true
+            if (x + feature.width) > @map[0].size || (y + feature.height) > @map.size
+                result = false
+            elsif
+                feature.height.times do |i|
+                    feature.width.times do |j|
+                        if @map[y+i][x+j] != @filler
+                            result = false
+                        end
+                    end
+                end
+            end
+            result
+        end
+
+        def print_map_to_console
+            puts "#{@name.center((@map[0].size*2)-1, '~')}\n\n"
+            puts @map.map { |x| x.join(' ') }
+            print_legend
+            puts "\n#{@name} was enlarged from #{@width}x#{@height} to #{@map[0].size}x#{@map.size} to accomodate all #{@user_features.values.reduce(:+)} features." if @map_enlarged
+        end
+
+        def export_map_to_file
+            File.open("#{@name}.txt", "w") do |file|
+                file.puts "#{@name.center((@map[0].size*2)-1, '~')}\n\n"
+                file.puts @map.map { |x| x.join(' ') }
+                file.puts "\nLegend"
+                file.puts "-------"
+                @features.each do |f|
+                    file.puts "#{f.name.capitalize} (#{@user_features[f.name]})".ljust(30, ".") + " #{f.filler}"
+                end
+                file.puts "\n#{@name} was enlarged from #{@width}x#{@height} to #{@map[0].size}x#{@map.size} to accomodate all #{@user_features.values.reduce(:+)} features." if @map_enlarged
+            end
+        end
+    end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: super_simple_world_builder
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- andydwyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+description: "USE CASES:\n\n1. Your friends bully you because your imaginary role
+  playing worlds are predictable and boring.\n2. You like seeing chars printed in
+  nifty patterns.\n\nHOW TO RUN:\n\n1. Run `ruby super_simple_world_builder.rb`\n2.
+  Follow the prompts\n\nEXAMPLE INPUT:\n\nGuten Tag! Welcome to Super Simple World
+  Builder.\nEnter 1 to build a random world\nEnter 2 to build a custom world\nPlease
+  enter your selection (1, 2, or exit):\n2\nEnter the name of your world:\nCommunity-Town\nEnter
+  the minimum width of the world:\n15\nEnter the minimum height of the world:\n15\nWhat
+  character do you want to fill the background of your world with? (i.e. any character
+  or single space)\n \nHow many lake features do you want?\n3\nHow many mountain features
+  do you want?\n2\nHow many town features do you want?\n3\nHow many forest features
+  do you want?\n4\n\nOUTPUT:\n\n1. Console print out of the world map\n2. A text file
+  of the world map\n\nACHTUNG:\n\n1. Don't worry if the width or height entered is
+  too small. The world will automatically enlarge to fit all features.\n2. World maps
+  look better when you enter a <space> as the character to fill the background.\n3.
+  This is a quick-and-dirty project so yolo with the specs. I added comments as a
+  consolation prize.\n4. See `feature_set.rb` to tweak the features that can be added
+  to the world map.\n5. Interestingly, menu prompts may not show up in the git bash
+  terminal. But they do show up in Windows command prompt, so lmao.\n6. Feel free
+  to tweak the code however you like. I plan to refactor in the future to dry up some
+  sections."
+email: ktanyag@gmail.com
+executables:
+- super_simple_world_builder
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README
+- bin/super_simple_world_builder
+- lib/super_simple_world_builder/feature_set.rb
+- lib/super_simple_world_builder/world.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+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: CL tool to create a super simple world for role playing and such.
+test_files: []