natural_20 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5be1c9cb751acb1ca14c7fd56510c5cd3546319402847845d42340dcc56ee5c9
+  data.tar.gz: 6cb35a23e305f0218e21f2ad9e3b750df99436c3f8bdb9a5fa210ba1380c406a
+SHA512:
+  metadata.gz: d84d618418d15c13d6845ce947331c0d0adf61e8be9ea8e6766da2aa239c063516c5d3871075aecfcf5099d84af8dcc1206548523ec5560c49573a30fbcef5f5
+  data.tar.gz: 7c7b48733c61254779b5037cd7ec95303faf4a1c1088f38ece602e4b665b31b6b98136b229387ae0bca0c315e71c35c77673a2824ecbfbd40e5d2116850d5187

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+savegame.yml
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status
+

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at joseph.dayo@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in natural_20.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Joseph Dayo
+
+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,99 @@
+# Natural20
+
+A Ruby toolkit to create your own text based DnD 5th Edition RPG games or to quickly
+test drive certain creature encounters if you are a DM.
+
+Features:
+ - Accurate DnD 5e ruleset implementation using the Open Game License
+ - Line of Sight computation with Lighting simulation (dim, dark areas)
+ - Simulation of doors, traps, treasure chests and cover
+ - Rudimentary AI and pathfinding
+ - Text based UI
+ - Easily extensible to incorporate in your own games
+
+ Supported Races:
+ - Human
+ - Elf
+ - Halfling
+ - More to come
+
+ Supported Classes;
+ - Fighter
+ - Rogue
+ - More to come
+
+## Installation
+
+- Install ruby 2.5 or later
+
+Add this line to your application's Gemfile if you plan to use the game engine in an adventure of your own otherwise you can just clone this repository locally using git clone:
+
+```ruby
+gem 'natural_20'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install natural_20
+
+## Usage
+
+To quickly try this out, clone this repository, in the working folder start the game engine it will
+load the default adventure included in this repository:
+
+```
+bin/nat20
+```
+
+See below for a description of the adventure
+
+## Adventure Tutorial
+
+The default adventure in this story is meant to showcase the game engine,
+it contains a small dungeon with doors and traps as well as goblins and a dangerous owlbear.
+you are to lead a party of 2 to steal the treasure behind one of those doors.
+
+You can find the adventure specific files in the following locations:
+
+char_classes/
+characters/
+items/
+npcs/
+races/
+maps/game_map.yml
+game.yml
+
+These are all text readable for you to customize to your liking.
+
+## Creating your own adventures
+
+You can generate a skeleton adventure using:
+
+```
+nat20author
+```
+
+A prompt based system will launch for you to create your own game.
+
+## 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]/natural_20. 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]/natural_20/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 Natural20 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/natural_20/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/compute_lights

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "natural_20"
+
+require 'optparse'
+
+filename = ARGV[0]
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: compute_lights battle_map.yml"
+
+  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+    options[:verbose] = v
+  end
+end.parse!
+
+puts "#{filename} #{options.inspect}"

data/bin/console

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'natural_20'
+
+require 'tty-prompt'
+require 'json'
+require 'pry-byebug'
+require 'natural_20/cli/commandline_ui'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/nat20

@@ -0,0 +1,135 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'natural_20'
+
+require 'tty-prompt'
+require 'json'
+require 'pry-byebug' if RUBY_ENGINE == 'ruby'
+require 'natural_20/cli/commandline_ui'
+require 'irb/completion'
+
+@prompt = TTY::Prompt.new
+@session = Natural20::Session.new_session
+
+# event handlers
+Natural20::EventManager.standard_cli
+
+def t(token, options = {})
+  I18n.t(token, options)
+end
+
+def training_dummy
+  chosen_characters = @prompt.multi_select(t('select_character')) do |menu|
+    @session.load_characters.each do |character|
+      menu.choice character.name, character
+    end
+  end
+
+  map = Natural20::BattleMap.new(@session, 'maps/battle_sim')
+  battle = Natural20::Battle.new(@session, map)
+  command_line = CommandlineUI.new(battle, map)
+  command_line.battle_ui(chosen_characters)
+end
+
+def dice_roller
+  dice_roll_str = nil
+  loop do
+    dice_roll_str = @prompt.ask(t(:prompt_dice_roller))
+    dieRoll = Natural20::DieRoll.roll dice_roll_str
+    puts "#{dieRoll} = #{dieRoll.result}"
+    break unless dice_roll_str != 'q'
+  end
+end
+
+def new_game
+  return if @session.has_save_game? && @prompt.no?(t('save_already_present'))
+
+  controller = AiController::Standard.new
+  map = Natural20::BattleMap.new(@session, @session.game_properties[:starting_map])
+  battle = Natural20::Battle.new(@session, map, controller)
+  command_line = CommandlineUI.new(battle, map)
+
+  number_of_players = @session.game_properties[:players] || 1
+  chosen_characters = []
+  player_characters = @session.load_characters
+
+  number_of_players.times.each do |i|
+    loop do
+      character = @prompt.select(t('select_party_member', index: i + 1)) do |menu|
+        player_characters.each do |c|
+          next if chosen_characters.include?(c)
+
+          menu.choice "#{c.name} - #{c.description}", c
+        end
+        menu.choice t('character_builder'), :character_builder
+      end
+
+      if character == :character_builder
+        character = Natural20::CharacterBuilder.new(@prompt, @session, battle).build_character
+      end
+      chosen_characters << character
+      break
+    end
+  end
+
+  command_line.battle_ui(chosen_characters)
+end
+
+def continue_game
+  battle = @session.load_save
+  command_line = CommandlineUI.new(battle, battle.map)
+  command_line.game_loop
+end
+
+def settings
+  loop do
+    choice = @prompt.select(t('options.title')) do |menu|
+      menu.choice t('options.dice_roll'), 1
+      menu.choice t(:back)
+    end
+    case choice
+    when 1
+      result = @prompt.select(t('options.dice_roll')) do |q|
+        q.default @session.setting(:manual_dice_roll) ? 1 : 2
+        q.choice t('options.roll_dice_manually'), 1
+        q.choice t('options.automatic_roll'), 2
+      end
+      @session.update_settings(manual_dice_roll: result == 1)
+    else
+      break
+    end
+  end
+end
+
+def start
+  loop do
+    CommandlineUI.clear_screen
+    title_color = @session.game_properties.fetch(:title_color, :white).to_sym
+    @session.game_properties[:title]&.each do |title_line|
+      puts title_line&.colorize(title_color)
+    end
+    puts t('game_author', author: @session.game_properties[:author]) if @session.game_properties[:author]
+    puts ""
+    answer = @prompt.select(@session.game_properties[:description] || '') do |menu|
+      menu.choice 'New Adventure ...', 1
+      menu.choice 'Continue Game ...', 2 if @session.has_save_game?
+      menu.choice 'Settings', 3
+      menu.choice t(:exit), 4
+    end
+    case answer
+    when 4
+      exit(0)
+    when 3
+      settings
+    when 2
+      continue_game
+    when 1
+      new_game
+    else
+      break
+    end
+  end
+end
+
+start

data/bin/nat20.cmd

@@ -0,0 +1,3 @@
+@echo off
+bundle install
+ruby bin\nat20

data/bin/nat20author

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'natural_20'
+
+require 'tty-prompt'
+require 'json'
+require 'pry-byebug' if RUBY_ENGINE == 'ruby'
+require 'natural_20/cli/commandline_ui'
+require 'irb/completion'
+
+@prompt = TTY::Prompt.new
+
+game = {
+  starting_map: 'maps/game_map',
+  player_profiles: 'characters'
+}
+
+@prompt.say('This is the nat20 game authoring tool')
+game[:name] = @prompt.ask('Enter a name for this game')
+game[:title] = @prompt.multiline('Enter a banner title for this game')
+
+game_map = {
+  name: game[:name],
+  description: "Map for #{game[:name]}",
+  map: {
+    illumination: 1.0,
+    base: [],
+  },
+  legend: {
+    g: {
+      name: 'Stivnux',
+      type: 'npc',
+      sub_type: 'goblin'
+    }
+  }
+
+}
+
+game[:description] = @prompt.ask('Enter a description for this game')
+game[:players] = @prompt.ask('Enter number of party members (1-4)') do |q|
+  q.in('1-4')
+end.to_i
+
+spawn_locations = []
+
+game[:players].times do |i|
+  game_map[:legend]["#{i + 1}".to_s] = {
+    name: "spawn_point_#{i + 1}",
+    type: 'spawn_point'
+  }
+  spawn_locations << [i, 0]
+end
+
+width = @prompt.ask('Enter map width') do |q|
+  q.in('8-30')
+end.to_i
+
+height = @prompt.ask('Enter map height') do |q|
+  q.in('8-30')
+end.to_i
+
+npc_location = [width / 2, height / 2]
+
+game_map[:map][:meta] = height.times.map do |row|
+  width.times.map do |col|
+    if npc_location == [col, row]
+      'g'
+    elsif spawn_locations.include?([col, row])
+      col + 1
+    else
+      '.'
+    end
+  end.join
+end
+
+game_map[:map][:base] = height.times.map do
+  width.times.map { '.' }.join
+end
+
+templates_root = File.expand_path(File.join(__dir__, '..'))
+
+game_root_folder = game[:name]
+
+raise "folder #{game_root_folder} already exists" if File.exist?(game_root_folder)
+
+puts 'writing out generated files'
+
+FileUtils.mkdir_p(game_root_folder)
+FileUtils.mkdir_p(File.join(game_root_folder, 'maps'))
+
+%w[char_classes characters items npcs races locales].each do |asset|
+  puts "copy #{File.join(templates_root, asset)} to #{File.join(game_root_folder, asset)}"
+  FileUtils.cp_r(File.join(templates_root, asset), File.join(game_root_folder, asset))
+end
+
+File.write(File.join(game_root_folder, 'game.yml'), game.to_yaml)
+File.write(File.join(game_root_folder, 'maps', 'game_map.yml'), game_map.to_yaml)
+FileUtils.cp_r(File.join(templates_root, 'maps', 'game_map.yml'),
+               File.join(game_root_folder, 'maps', 'sample_game_map.yml'))
+
+puts "written #{File.join(game_root_folder, 'game.yml')}"
+
+@prompt.keypress("Game generated, to run the game go to the '#{game_root_folder}' folder and type: nat20")