sector_maker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4148fcde17702fad821443b7b52ec2499058af6614c483893fe22db3fa9980ea
+  data.tar.gz: 155ab65fcf80c2e70491eac3af3d96fa7cbf5fd1962dad44f941fc2707b9df06
+SHA512:
+  metadata.gz: 6fa00d08d44f0aacc979b6f6aed268b8824371b1c372cca4617f5dd5acd56fff7e032759dcb78965a1ed2fb250630bc22a86e514d0211343b16c43c71eababc4
+  data.tar.gz: 4e8fab0df6f42ffd44a4a820676829297f7aeca5b828c09c3ec416464e70b77546c9cf2cd67bd6ac374a7bf74123579b262417aa9275fdf49e7a668fc1a14bac

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sector_maker.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "markov_namegen", "~> 0.1.4"
+
+gem "rubocop-rspec", "~> 2.12"
+
+gem "rubocop-rake", "~> 0.6.0"

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    sector_maker (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.2)
+    markov_namegen (0.1.4)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  markov_namegen (~> 0.1.4)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.12)
+  sector_maker!
+
+BUNDLED WITH
+   2.3.21

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Jack Kellenberger
+
+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.md

@@ -0,0 +1,33 @@
+# SectorMaker
+
+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/sector_maker`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add sector_maker
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install sector_maker
+
+## 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 the created tag, 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]/sector_maker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/sector_maker/constants.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/ModuleLength
+# Default constants used by SectorMaker
+module SectorMaker
+  # Traveller 5 "Expanded Hexadecimal":
+  # values 1-33 mapped to 0-9, A-Z, excluding I and O.
+  EHEX = [*(0..9)].zip([*("0".."9")]).to_h
+                  .merge([*(10..33)].zip([*("A".."Z")] - %w[I O]).to_h)
+
+  # PLACEHOLDER NAMELIST FOR NAMEGENERATOR
+  DEFAULT_NAMES = ["Alabama", "Alaska", "American Samoa", "Arizona", "Arkansas",
+                   "California", "Colorado", "Connecticut", "Delaware",
+                   "District of Columbia", "Florida", "Georgia", "Guam", "Hawaii",
+                   "Idaho", "Illinois", "Indiana", "Iowa", "Kansas", "Kentucky",
+                   "Louisiana", "Maine", "Maryland", "Massachusetts", "Michigan",
+                   "Minnesota", "Minor Outlying Islands", "Mississippi", "Missouri",
+                   "Montana", "Nebraska", "Nevada", "New Hampshire", "New Jersey",
+                   "New Mexico", "New York", "North Carolina", "North Dakota",
+                   "Northern Mariana Islands", "Ohio", "Oklahoma", "Oregon",
+                   "Pennsylvania", "Puerto Rico", "Rhode Island", "South Carolina",
+                   "South Dakota", "Tennessee", "Texas", "Virgin Islands", "Utah",
+                   "Vermont", "Virginia", "Washington", "West Virginia", "Wisconsin",
+                   "Wyoming"].freeze
+
+  # SECTOR GENERATION VALUES
+
+  SUBSECTOR_LIST = %i[A B C D
+                      E F G H
+                      I J K L
+                      M N O P].freeze
+
+  COORDINATE_RANGE = { A: { col_min: 1, row_min: 1 },
+                       B: { col_min: 9, row_min: 1 },
+                       C: { col_min: 17, row_min: 1 },
+                       D: { col_min: 25, row_min: 1 },
+                       E: { col_min: 1, row_min: 11 },
+                       F: { col_min: 9, row_min: 11 },
+                       G: { col_min: 17, row_min: 11 },
+                       H: { col_min: 25, row_min: 11 },
+                       I: { col_min: 1, row_min: 21 },
+                       J: { col_min: 9, row_min: 21 },
+                       K: { col_min: 17, row_min: 21 },
+                       L: { col_min: 25, row_min: 21 },
+                       M: { col_min: 1, row_min: 31 },
+                       N: { col_min: 9, row_min: 31 },
+                       O: { col_min: 17, row_min: 31 },
+                       P: { col_min: 25, row_min: 31 } }.freeze
+
+  DEFAULT_SYSTEM_PRESENCE = { A: 5, B: 5, C: 5, D: 5,
+                              E: 5, F: 5, G: 5, H: 5,
+                              I: 5, J: 5, K: 5, L: 5,
+                              M: 5, N: 5, O: 5, P: 5 }.freeze
+
+  # SYSTEM GENERATION VALUES
+
+  STARPORT_DISTRIBUTION = %w[A A A B B C C D E E X].freeze
+
+  STARPORT_TECH_MOD = { "X" => -4,
+                        "C" => 2,
+                        "B" => 4,
+                        "A" => 6 }.freeze
+
+  NAVAL_BASE_CHANCE_BY_PORT_CLASS = { "A" => 8,
+                                      "B" => 8 }.freeze
+
+  SCOUT_BASE_CHANCE_BY_PORT_CLASS = { "D" => 7,
+                                      "C" => 8,
+                                      "B" => 9,
+                                      "A" => 10 }.freeze
+
+  SIZE_TECH_MOD = { 0 => 2,
+                    1 => 2,
+                    2 => 1,
+                    3 => 1,
+                    4 => 1 }.freeze
+
+  SIZE_DESCRIPTION = { 0 => "Asteroid or planetoid belt",
+                       32 => "Stellar-scale construct" }.freeze
+
+  ATMOSPHERE_TECH_MOD =  { 0 => 1,
+                           1 => 1,
+                           2 => 1,
+                           3 => 1,
+                           10 => 1,
+                           11 => 1,
+                           12 => 1,
+                           13 => 1,
+                           14 => 1,
+                           15 => 1 }.freeze
+
+  ATMOSPHERE_DESCRIPTION = ["No atmosphere",
+                            "Trace",
+                            "Very thin, tainted",
+                            "Very thin",
+                            "Thin, tainted",
+                            "Standard",
+                            "Standard, tainted",
+                            "Dense",
+                            "Dense, tainted",
+                            "Exotic",
+                            "Corrosive",
+                            "Insidious",
+                            "Dense, high",
+                            "Ellipsoid",
+                            "Thin, low"].freeze
+
+  HYDROGRAPHICS_TECH_MOD = { 9 => 1,
+                             10 => 2 }.freeze
+
+  HYDROGRAPHICS_DESCRIPTION = { 0 => "No free standing water",
+                                10 => "No land masses" }.freeze
+
+  POPULATION_TECH_MOD = { 1 => 1,
+                          2 => 1,
+                          3 => 1,
+                          4 => 1,
+                          5 => 1,
+                          9 => 2,
+                          10 => 4,
+                          11 => 4,
+                          12 => 4,
+                          13 => 4,
+                          14 => 4,
+                          15 => 4 }.freeze
+
+  POPULATION_MODIFIER_DISTRIBUTION = [1, 7, 5, 3, 1, 2, 1, 4, 6, 8, 9].freeze
+
+  GOVERNMENT_TECH_MOD = { 0 => 1,
+                          5 => 1,
+                          13 => -2 }.freeze
+
+  GOVERNMENT_DESCRIPTION_SHORT = ["No govenrment/structure",
+                                  "Company/Corporation",
+                                  "Participating Democracy",
+                                  "Self-perpetuating Oligarchy",
+                                  "Representative Democracy",
+                                  "Feudal Technocracy",
+                                  "Captive Government",
+                                  "Balkanization",
+                                  "Civil Service Bureaucracy",
+                                  "Impersonal Bureaucracy",
+                                  "Charismatic Dictator",
+                                  "Non-charismatic Leader",
+                                  "Charismatic Oligarchy",
+                                  "Religious Dictatorship",
+                                  "Religious Autocracy",
+                                  "Totalitarian Oligarchy"].freeze
+end
+# rubocop:enable Metrics/ModuleLength

data/lib/sector_maker/rollable.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SectorMaker
+  # Dice rolling methods
+  module Rollable
+    def roll(dice_quantity = 1)
+      Array.new(dice_quantity) { rand(1..6) }.sum
+    end
+
+    # rubocop:disable Lint/BinaryOperatorWithIdenticalOperands
+    def flux
+      roll - roll
+    end
+    # rubocop:enable Lint/BinaryOperatorWithIdenticalOperands
+
+    def roll_over?(target = 8)
+      roll(2) >= target
+    end
+
+    def roll_under?(target = 8)
+      roll(2) <= target
+    end
+  end
+end

data/lib/sector_maker/sector.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module SectorMaker
+  # A Traveller5 sector
+  class Sector
+    include Rollable
+    def initialize(system_chance = DEFAULT_SYSTEM_PRESENCE)
+      @namegen = MarkovNameGen.new(DEFAULT_NAMES)
+      @sector_name = "New Sector"
+      @system_chances = system_chance
+      @systems = []
+      @hexes = {}
+      generate_sector
+    end
+
+    def to_s
+      "#{@sector_name.upcase} \n #{"-" * @sector_name.length}\n" \
+        "#{@systems.compact.map(&:to_s).join("\n")}"
+    end
+
+    def to_txt(filename = @sector_name)
+      File.write("#{filename}.txt", to_s)
+    end
+
+    def generate_sector
+      SUBSECTOR_LIST.each do |letter|
+        generate_subsector(letter)
+      end
+    end
+
+    def generate_subsector(letter = A)
+      col_min = COORDINATE_RANGE[letter][:col_min]
+      row_min = COORDINATE_RANGE[letter][:row_min]
+      col_min.upto(col_min + 7) do |col|
+        row_min.upto(row_min + 9) do |row|
+          hex = [col, row]
+          world = check_system_presence(hex, letter)
+          @hexes[hex] = world
+          @systems.push(world)
+        end
+      end
+    end
+
+    def format_hex(coordinate)
+      coordinate.map { |pair| pair.to_s.rjust(2, "0") }.join
+    end
+
+    def check_system_presence(hex, letter = A)
+      return unless roll(1) >= @system_chances[letter]
+
+      System.new(sector_name: @sector_name,
+                 mainworld_name: @namegen.new_name,
+                 hex: format_hex(hex))
+    end
+  end
+end

data/lib/sector_maker/system.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module SectorMaker
+  # A Traveller5 star system
+  class System
+    include Rollable
+    attr_reader :name, :hex, :uwp, :bases, :trade_codes, :travel_code, :pbg,
+                :allegiance
+
+    def initialize(sector_name: "----", mainworld_name: "blank", hex: "0101",
+                   uwp: World.new(main: true), pbg: random_pbg)
+      @name = { sector: sector_name,
+                main_world: mainworld_name }
+      @hex = hex
+      @uwp = uwp
+      @pbg = pbg
+      @trade_codes = "Ag Ni"
+      @bases = "N"
+      @allegiance = "Nebay"
+      @travel_code = [" ", "A", "R"].sample
+    end
+
+    def to_s
+      "#{name[:main_world].ljust(17)} #{hex} #{uwp}  #{bases} " \
+        "#{trade_codes.ljust(19)} #{travel_code}  #{pbg} #{allegiance[0..1]}"
+    end
+
+    def random_pbg
+      [random_population_modifier,
+       random_number_of_planetoid_belts,
+       random_number_of_gas_giants].map(&:to_s).join
+    end
+
+    def random_population_modifier
+      POPULATION_MODIFIER_DISTRIBUTION[roll(2) - 2]
+    end
+
+    def random_number_of_planetoid_belts
+      [roll - 3, 0].max
+    end
+
+    def random_number_of_gas_giants
+      [(roll(2) / 2) - 2, 0].max
+    end
+  end
+end

data/lib/sector_maker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SectorMaker
+  VERSION = "0.1.0"
+end

data/lib/sector_maker/world.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module SectorMaker
+  # Represents Traveller5 worlds
+  class World
+    include Rollable
+    attr_reader :starport, :size, :atmosphere, :hydrographics,
+                :population, :government, :law_level, :tech_level
+
+    def initialize(_)
+      @starport = random_starport
+      @size = random_size
+      @atmosphere = random_atmosphere
+      @hydrographics = random_hydrographics
+      @population = random_population
+      @government = random_government
+      @law_level = random_law_level
+      @tech_level = random_tech_level
+    end
+
+    def to_s
+      starport + attributes_to_ehex
+    end
+
+    def attributes_to_ehex
+      [@size,
+       @atmosphere,
+       @hydrographics,
+       @population,
+       @government,
+       @law_level,
+       @tech_level].map { |value| EHEX[value] }.join.insert(6, "-")
+    end
+
+    def adjust_to_range(number, min_value: 0, max_value: 10)
+      [[number, min_value].max, max_value].min
+    end
+
+    def random_starport
+      STARPORT_DISTRIBUTION[roll(2) - 2]
+    end
+
+    def random_size
+      result = roll(2) - 2
+
+      if result == 10
+        9 + roll
+      else
+        result
+      end
+    end
+
+    def random_atmosphere
+      return 0 if @size < 2
+
+      result = flux + @size
+
+      adjust_to_range(result, max_value: 15)
+    end
+
+    def atmosphere_mod
+      return @atmosphere unless @atmosphere < 2 || @atmosphere > 9
+
+      @atmosphere - 4
+    end
+
+    def random_hydrographics
+      return 0 if @size < 2
+
+      adjust_to_range(flux + atmosphere_mod)
+    end
+
+    def random_population
+      result = roll(2) - 2
+
+      if result == 10
+        roll(2) + 3
+      else
+        result
+      end
+    end
+
+    def random_government
+      return 0 if @population.zero?
+
+      adjust_to_range(flux + @population, max_value: 15)
+    end
+
+    def random_law_level
+      adjust_to_range(flux + @government, max_value: 18)
+    end
+
+    def random_tech_level
+      calculation = [roll,
+                     STARPORT_TECH_MOD.fetch(@starport, 0),
+                     SIZE_TECH_MOD.fetch(@size, 0),
+                     ATMOSPHERE_TECH_MOD.fetch(@atmosphere, 0),
+                     HYDROGRAPHICS_TECH_MOD.fetch(@hydrographics, 0),
+                     POPULATION_TECH_MOD.fetch(@population, 0),
+                     GOVERNMENT_TECH_MOD.fetch(@government, 0)].sum
+
+      adjust_to_range(calculation, max_value: 33)
+    end
+  end
+end

data/lib/sector_maker.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SectorMaker
+  require "markov_namegen"
+  require "sector_maker/constants"
+  require "sector_maker/rollable"
+  require "sector_maker/world"
+  require "sector_maker/system"
+  require "sector_maker/sector"
+  require "sector_maker/version"
+end

data/sig/sector_maker.rbs

@@ -0,0 +1,4 @@
+module SectorMaker
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: sector_maker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jack Kellenberger
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-09-03 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- jackson@kellenberger.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sector_maker.rb
+- lib/sector_maker/constants.rb
+- lib/sector_maker/rollable.rb
+- lib/sector_maker/sector.rb
+- lib/sector_maker/system.rb
+- lib/sector_maker/version.rb
+- lib/sector_maker/world.rb
+- sig/sector_maker.rbs
+homepage: https://github.com/jmkellenberger
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jmkellenberger
+  source_code_uri: https://github.com/jmkellenberger
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A Traveller Sector generator inspired by Traveller5.
+test_files: []