coop_al 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 940d2406792da127d6db1a622ff9fe6d7dfae655
+  data.tar.gz: 742e038d58588e7b58634201f6ae371f83fa2b47
+SHA512:
+  metadata.gz: 49ac99bf96894e7162ff25da3e4124511d4f2cce35d18131d610b674f8435327b9955bd13817326c2bd32885ac48ca44714df20960f61fd62669126648fbc4eb
+  data.tar.gz: fcb213c0563ecc6a93f03b9b4555650b4df458bf2a3ab8c51406f23a0ba20adc2095adb524798d06b3aa8363c56f9fa55dcd982da5b7042f392355b21cae40a9

data/.gitignore

@@ -0,0 +1,7 @@
+*.swp
+*.swo
+/.bundle/
+/Gemfile.lock
+/coverage/
+/pkg
+/*.gem

data/.rubocop.yml

@@ -0,0 +1,9 @@
+Metrics/LineLength:
+    Enabled: false
+Metrics/ModuleLength:
+    Enabled: false
+Metrics/BlockLength:
+    Enabled: true
+    Exclude:
+        - res/*.rb
+        - spec/**/*.rb

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,89 @@
+# Coop - Adventurers League Character Log Generator
+
+> "Reality is frequently inaccurate." -- Douglas Adams
+
+Coop is a little tool that uses simple DSL-specified Dungeons and Dragons adventures to generate a log of pretend gameplay to support an Adventurers League character.
+
+It includes SRD content, but nothing else. You'll have to supply your own copy of WoTC material.
+
+## Installation
+
+    $> gem install coop_al
+
+## Usage
+
+    $> coop --help
+    coop [options] resource [resource...]
+    --path <path1>[,<path2>,...] Specify path to follow
+    --path-file <filename>       Specify paths in a file, one per line
+    --no-loot                    Do not report loot
+    --no-xp                      Do not report accumulated XP
+    --no-paths                   Do not report available paths
+    --party-size n               Total XP and treasure is divided by n [6]
+    --encounter-count n          Encounters per session [10]
+    --end-date YYYY-MM-DD        Most recent session [today]
+    --session-frequency n        Sessions every n days [7]
+    --blackout-dates YYYY-MM-DD[,YYYY-MM-DD,...]
+    --skip-frequency n           Chance of skipping week is 1 in n [never]
+    --srd                        Use included SRD file for monsters
+    --trace                      Print encounter details
+    --help                       Print this help
+
+## Customization
+
+Check out the examples provided.
+
+### Bestiary
+
+Create your own bestiary by providing a resource file in the form:
+
+    bestiary do
+      add :scary_monster, :cr1_2
+      add :scarier_monster, :cr17
+    end
+
+### Adventures
+
+Create your own adventures by providing a resource file in the form:
+
+    adventure :shortname, 'Adventure Name' do
+      entry :chapter_1
+      chapter :chapter_1, 'Chapter 1. Surrounding Area' do
+        5.times do
+          random 'Random Encounter' do
+            f(1..2) { monster :scary_monster }
+            f(3..20) { monsters '3d6', :scarier_monster }
+          end
+        end
+        encounter 'Some old weak guy' do
+          npc :cr0
+          treasure 2000.gp + 400.pp
+          treasure 1000.gp, 'diamond'
+          item 'Vorpal sword'
+        end
+        encounter 'Bag of XP' do
+          xp 500
+        end
+        link_to :chapter_2
+      end
+      chapter :chapter_2, 'Chapter 2. The Caves' do
+        ...
+        link_to_downtime
+      end
+    end
+
+## Development
+
+Coop is written in Ruby, and requires the [Tablescript gem](https://github.com/jamiehale/tablescript.rb).
+
+### Tests
+
+Such as they are...
+
+    $> rake spec
+
+Coverage provided by simplecov.
+
+### Rubocop
+
+    $> rake rubocop

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :rubocop do
+  sh 'bundle exec rubocop'
+end

data/coop.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'coop_al/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'coop_al'
+  spec.version = CoopAl::VERSION
+  spec.authors = ['Jamie Hale']
+  spec.email = ['jamie@smallarmyofnerds.com']
+  spec.summary = 'Adventurers League Character Log Generator'
+  spec.description = 'Tool for automated character growth through predefined adventures'
+  spec.homepage = 'https://github.com/jamiehale/coop'
+  spec.license = 'GPL-3.0'
+
+  raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_dependency 'tablescript', '0.0.3'
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'cucumber', '~> 2.4'
+  spec.add_development_dependency 'simplecov', '~> 0.13'
+  spec.add_development_dependency 'rubocop', '~> 0.47'
+end

data/examples/filler.rb

@@ -0,0 +1,9 @@
+adventure :filler, 'Filler' do
+  entry :chapter_1
+  chapter :chapter_1, 'Chapter 1. Filler' do
+    encounter 'Bag of XP' do
+      xp 4000 * 6
+    end
+    link_to_downtime
+  end
+end

data/examples/test.rb

@@ -0,0 +1,15 @@
+adventure :test, 'Simple Adventure' do
+  entry :chapter_1
+  chapter :chapter_1, 'Chapter 1' do
+    encounter '1. Entrance' do
+      monster :goblin
+      monsters 2, :orc
+      treasure '2d6*10'.gp
+      item 'Potion of healing'
+    end
+    link_to :chapter_2
+    link_to_downtime
+  end
+  chapter :chapter_2, 'Chapter 2' do
+  end
+end

data/exe/coop

@@ -0,0 +1,131 @@
+#! /usr/bin/env ruby
+
+require 'tablescript'
+require 'coop_al'
+require 'date'
+
+def version
+  puts "Coop v#{CoopAl::VERSION} - \"Reality is frequently inaccurate.\""
+  exit
+end
+
+def display_message(message)
+  puts
+  puts message
+end
+
+def usage(message = nil)
+  puts 'coop [options] resource [resource...]'
+  puts '  --path <path1>[,<path2>,...] Specify path to follow'
+  puts '  --path-file <filename>       Specify paths in a file, one per line'
+  puts '  --no-loot                    Do not report loot'
+  puts '  --no-xp                      Do not report accumulated XP'
+  puts '  --no-paths                   Do not report available paths'
+  puts '  --party-size n               Total XP and treasure is divided by n [6]'
+  puts '  --encounter-count n          Encounters per session [10]'
+  puts '  --end-date YYYY-MM-DD        Most recent session [today]'
+  puts '  --session-frequency n        Sessions every n days [7]'
+  puts '  --blackout-dates YYYY-MM-DD[,YYYY-MM-DD,...]'
+  puts '  --skip-frequency n           Chance of skipping week is 1 in n [never]'
+  puts '  --srd                        Use included SRD file for monsters'
+  puts '  --trace                      Print encounter details'
+  puts '  --help                       Print this help'
+  display_message(message) unless message.nil?
+  exit
+end
+
+resource_files = []
+paths = []
+options = {
+  party_size: 6,
+  encounter_count: 10,
+  end_date: Date.today,
+  session_frequency: 7,
+  blackout_dates: []
+}
+until ARGV.empty?
+  parameter = ARGV.shift
+  case parameter
+  when '--help'
+    usage
+  when '--version'
+    version
+  when '--path'
+    usage unless paths.empty?
+    parameter = ARGV.shift
+    usage if parameter.nil?
+    paths = parameter.split(',').map { |p| CoopAl::Path.parse(p) }
+  when '--path-file'
+    usage unless paths.empty?
+    parameter = ARGV.shift
+    usage if parameter.nil?
+    File.open(parameter, 'r') do |f|
+      f.each_line do |line|
+        paths << CoopAl::Path.parse(line.strip)
+      end
+    end
+  when '--no-loot'
+    options[:show_loot] = false
+  when '--no-xp'
+    options[:show_xp] = false
+  when '--no-paths'
+    options[:show_paths] = false
+  when '--party-size'
+    parameter = ARGV.shift
+    usage if parameter.nil?
+    options[:party_size] = parameter.to_i
+  when '--encounter-count'
+    parameter = ARGV.shift
+    usage if parameter.nil?
+    options[:encounter_count] = parameter.to_i
+  when '--end-date'
+    parameter = ARGV.shift
+    usage if parameter.nil?
+    options[:end_date] = Date.parse(parameter)
+  when '--session-frequency'
+    parameter = ARGV.shift
+    usage if parameter.nil?
+    options[:session_frequency] = parameter.to_i
+  when '--blackout-dates'
+    parameter = ARGV.shift
+    usage if parameter.nil?
+    options[:blackout_dates] = parameter.split(',').map { |d| Date.parse(d) }
+  when '--skip-frequency'
+    parameter = ARGV.shift
+    usage if parameter.nil?
+    options[:skip_frequency] = parameter.to_i
+    usage('Invalid skip frequency') if options[:skip_frequency] < 1
+  when '--srd'
+    resource_files << File.expand_path('../res/srd.rb', File.dirname(__FILE__))
+  when '--trace'
+    CoopAl::Trace.instance.tracing = true
+  else
+    resource_files << parameter
+  end
+end
+
+usage('No resources specified') if resource_files.empty?
+begin
+  resource_files.each do |filename|
+    require filename
+  end
+rescue StandardError => e
+  puts e
+  exit
+end
+
+date_generator = CoopAl::SessionDateGenerator.new(options)
+log = CoopAl::SessionLog.new(date_generator, options)
+
+state = CoopAl::State.new
+follower = CoopAl::PathFollower.new(CoopAl::Library.instance, state)
+begin
+  follower.follow(paths, log)
+rescue StandardError => e
+  puts e
+  exit
+end
+
+CoopAl::StateReporter.new(state, CoopAl::Library.instance, options).report(STDOUT)
+
+log.dump(STDOUT)

data/lib/coop_al/adventure.rb

@@ -0,0 +1,52 @@
+module CoopAl
+  ##
+  # Adventure
+  #
+  class Adventure
+    attr_reader :name, :description, :chapters
+
+    def initialize(name, description)
+      @name = name
+      @description = description
+      @entries = []
+      @chapters = {}
+    end
+
+    def add_entry(path)
+      @entries << path
+    end
+
+    def add_chapter(chapter)
+      @chapters[chapter.name] = chapter
+    end
+
+    def all_chapter_names
+      @chapters.keys
+    end
+
+    def chapter_by_path(path)
+      @chapters[path.chapter]
+    end
+
+    def chapter_paths
+      @chapters.values.map(&:absolute_path)
+    end
+
+    def all_entries
+      @entries.map { |e| Path.absolute(@name, e) }
+    end
+
+    def chapter?(name)
+      @chapters.key?(name)
+    end
+
+    def chapter(name)
+      raise "Chapter (#{name}) not found" unless @chapters.key?(name)
+      @chapters[name]
+    end
+
+    def full_name
+      @description
+    end
+  end
+end

data/lib/coop_al/adventure_generator.rb

@@ -0,0 +1,35 @@
+module CoopAl
+  ##
+  # AdventureGenerator
+  #
+  class AdventureGenerator
+    attr_reader :adventure
+
+    def initialize(name, description, bestiary)
+      initialize_adventure(name, description)
+      @bestiary = bestiary
+    end
+
+    def entry(name)
+      @adventure.add_entry(name)
+    end
+
+    def chapter(name, description, &blk)
+      generator = ChapterGenerator.new(name, description, @adventure, @bestiary)
+      generator.instance_eval(&blk)
+      @adventure.add_chapter(generator.chapter)
+    end
+
+    private
+
+    def initialize_adventure(name, description)
+      if Library.instance.adventure?(name)
+        @adventure = Library.instance.adventure(name)
+      else
+        raise "Description required for adventure (#{name})" if description.nil?
+        @adventure = Adventure.new(name, description)
+        Library.instance.add_adventure(@adventure)
+      end
+    end
+  end
+end

data/lib/coop_al/bestiary.rb

@@ -0,0 +1,51 @@
+require 'singleton'
+
+module CoopAl
+  ##
+  # Bestiary
+  #
+  class Bestiary
+    include Singleton
+
+    def initialize
+      @monsters = {}
+      @xp_lookup = XpRewardTable.new
+      @loot_generator = LootGenerator.new
+    end
+
+    def empty?
+      @monsters.empty?
+    end
+
+    def add(monster)
+      @monsters[monster.id] = monster
+    end
+
+    def monster?(id)
+      @monsters.key?(id)
+    end
+
+    def monster(id)
+      @monsters[id]
+    end
+
+    def create(id, treasure, encounter)
+      raise "Invalid monster ID (#{id})" unless @monsters.key?(id)
+      monster = @monsters[id]
+      xp = calculate_xp(monster)
+      loot = generate_loot(monster, treasure)
+      Monster.new(id, xp, loot, encounter)
+    end
+
+    private
+
+    def calculate_xp(monster)
+      @xp_lookup[monster.cr]
+    end
+
+    def generate_loot(monster, treasure)
+      return @loot_generator.generate(monster.cr, monster.treasure) if treasure == :default
+      @loot_generator.generate(monster.cr, treasure)
+    end
+  end
+end

data/lib/coop_al/bestiary_generator.rb

@@ -0,0 +1,3 @@
+def bestiary(&blk)
+  CoopAl::BestiaryPopulator.new(&blk)
+end

data/lib/coop_al/bestiary_populator.rb

@@ -0,0 +1,14 @@
+module CoopAl
+  ##
+  # BestiaryPopulator
+  #
+  class BestiaryPopulator
+    def initialize(&blk)
+      instance_eval(&blk)
+    end
+
+    def add(id, cr, treasure = :individual)
+      Bestiary.instance.add(MonsterDefinition.new(id, cr, treasure))
+    end
+  end
+end

data/lib/coop_al/chapter.rb

@@ -0,0 +1,51 @@
+module CoopAl
+  ##
+  # Chapter
+  #
+  class Chapter
+    attr_reader :name, :description, :encounters, :links
+
+    def initialize(name, description, adventure)
+      @name = name
+      @description = description
+      @adventure = adventure
+      @encounters = []
+      @links = []
+      @links_to_downtime = false
+    end
+
+    def adventure_name
+      @adventure.description
+    end
+
+    def add_encounter(encounter)
+      @encounters << encounter
+    end
+
+    def add_link(path)
+      @links << path
+    end
+
+    def link_to_downtime
+      @links_to_downtime = true
+    end
+
+    def links_to_downtime?
+      @links_to_downtime
+    end
+
+    def follow(state, log)
+      @encounters.each do |encounter|
+        encounter.run(state, log)
+      end
+    end
+
+    def absolute_path
+      Path.Absolute(@adventure.name, @name)
+    end
+
+    def full_name
+      @adventure.full_name + ' - ' + @description
+    end
+  end
+end

data/lib/coop_al/chapter_generator.rb

@@ -0,0 +1,32 @@
+module CoopAl
+  ##
+  # ChapterGenerator
+  #
+  class ChapterGenerator
+    attr_reader :chapter
+
+    def initialize(name, description, adventure, bestiary)
+      @adventure = adventure
+      @chapter = Chapter.new(name, description, adventure)
+      @bestiary = bestiary
+    end
+
+    def encounter(name, &blk)
+      generator = EncounterGenerator.new(name, @chapter, @bestiary)
+      @chapter.add_encounter(generator.generate_encounter(&blk))
+    end
+
+    def random(name, &blk)
+      generator = RandomEncounterGenerator.new(name, @chapter, @bestiary)
+      @chapter.add_encounter(generator.generate_encounter(&blk))
+    end
+
+    def link_to(chapter)
+      @chapter.add_link(Path.absolute(@adventure.name, chapter))
+    end
+
+    def link_to_downtime
+      @chapter.link_to_downtime
+    end
+  end
+end