carps 0.2.1

data/lib/carps/mod/launch.rb

@@ -0,0 +1,108 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "drb"
+
+require "carps/util"
+
+require "carps/ui"
+
+module CARPS
+
+   # Functions which launch mods.
+   module Launcher
+
+      # Print an error message
+      def Launcher::usage
+         puts "Mod requires argument -p URI for player\nor -h CAMPAIGN URI for DMs."
+         CARPS::enter_quit 1
+      end
+
+      def Launcher::get_mailer uri
+         DRb.start_service
+         mailer = DRbObject.new_with_uri uri
+      end
+
+      # Either get the mod from the mailer or create a new one
+      def Launcher::launch_player_mod role, mailer, *args 
+         mod = nil
+         unless mod = mailer.load
+            mod = role.create_mod
+         end
+         mod.mailer = mailer
+         role.launch mod
+      end
+
+      # Either get the mod from the mailer or create a new one
+      def Launcher::launch_dm_mod role, campaign, mailer
+         mod = nil
+         unless mod = mailer.load
+            mod = role.create_mod campaign
+         end
+         mod.mailer = mailer
+         role.launch mod
+      end
+
+      # Use to launch a mod
+      #
+      # Pass a module, containing the mod: this will do the rest.
+      #
+      # The module must contain two further modules, Player and DM
+      #
+      # Each of Player and DM must also contain a create_mod method (And I mean defined like `def Player::create_mod`).
+      #
+      # Player::create_mod should take one parameter: the mailer.
+      #
+      # DM::create_mod should take two parameters: the campaign, then the mailer.
+      #
+      # Each of Player and DM should also contain a launch method (which should be defined as per above),
+      # this method should take one parameter: the mod
+      def Launcher::launch mod
+
+         CARPS::with_crash_report true do
+            # Start DRB
+            DRb.start_service
+            # Should use optparse?
+            if ARGV.empty?
+               usage
+            else
+               role = ARGV.shift
+               if role == "-h"
+                  if ARGV.length == 2
+                     CARPS::config_dir "dm"
+                     campaign = ARGV.shift
+                     Launcher::launch_dm_mod mod::DM, campaign, Launcher::get_mailer(ARGV.shift)
+                  else
+                     usage
+                  end
+               elsif role == "-p"
+                  if ARGV.length == 1
+                     CARPS::config_dir "player"
+                     Launcher::launch_player_mod mod::Player, Launcher::get_mailer(ARGV.shift)
+                  else
+                     Launcher::usage
+                  end
+               else
+                  Launcher::usage
+               end
+            end
+         end
+      end
+
+   end
+
+end

data/lib/carps/mod/mod.rb

@@ -0,0 +1,52 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps/mod"
+
+module CARPS
+
+   # Mod base class supporting character sheet verification
+   #
+   # Subclasses should override
+   # schema, semantic_verifier
+   class Mod
+
+      # Give a mailer
+      def mailer= mail
+         @mailer = mail
+      end
+
+      protected
+
+      # The semantic verifier
+      def semantic_verifier
+         Sheet::UserVerifier.new
+      end
+
+      # The schema
+      def schema
+         Sheet::Schema.new({})
+      end
+
+      # Sheet editor
+      def editor
+         Sheet::Editor.new schema, semantic_verifier
+      end
+
+   end
+
+end

data/lib/carps/mod/player/interface.rb

@@ -0,0 +1,76 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps/mod"
+
+require "carps/ui"
+
+module CARPS
+
+   module Player
+
+      # Player interface
+      class Interface < CARPS::RolePlayInterface
+
+         def initialize mod
+            super()
+            @mod = mod
+            add_command "act", "Take your turn."
+            add_command "save", "Save the game."
+            add_command "done", "Send your stuff to the dungeon master and await the next turn."
+            add_command "sheet", "Look at your character sheet."
+            add_command "edit", "Edit your character sheet."
+         end
+
+         # Output information about the game, then run.
+         def run
+            if @mod.first_time?
+               puts @mod.description
+               UI::question "Press enter when you are ready to fill in your character sheet."
+               edit
+               @mod.configured
+            end
+            super
+         end
+
+         protected
+
+         def save
+            @mod.save
+         end
+
+         def sheet
+            @mod.show_sheet
+         end
+
+         def edit
+            @mod.edit_sheet
+         end
+
+         def act
+            @mod.take_turn
+         end
+
+         def done
+            @mod.next_turn
+         end
+
+      end
+
+   end
+
+end

data/lib/carps/mod/player/mod.rb

@@ -0,0 +1,109 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps/mod"
+
+require "carps/ui"
+
+module CARPS
+
+   module Player
+
+      # Player mod
+      #
+      # subclasses should provide a method called description
+      #
+      # description should return a string, a summary of the game.
+      # Who wrote it, owns the copyright and where to find the rules 
+      # are appropriate facts.
+      class Mod < CARPS::Mod
+
+         def initialize
+            @sheet = Sheet::Character.new({})
+            @first_time = true
+         end
+
+         # This game has been configured
+         def configured
+            @first_time = false
+         end
+
+         # This game has never been run before
+         def first_time?
+            @first_time
+         end
+
+         # Edit the character sheet
+         def edit_sheet
+            editor.fill @sheet
+            @edited = true
+         end
+
+         # Show the character sheet
+         def show_sheet
+            puts @sheet.emit
+         end
+
+         # Save the game
+         def save
+            @mailer.save self
+         end
+
+         # Take a turn
+         def take_turn
+            if @turn
+               @answers = @turn.take
+            else
+               tu = @mailer.check ClientTurn
+               if tu
+                  @turn = tu
+                  stats = @turn.sheet.dump
+                  unless stats.empty?
+                     @sheet = Sheet::Character.new stats
+                     UI::highlight "Received new character sheet."
+                  end
+                  @answers = @turn.take
+               else
+                  UI::put_error "Turn not received."
+               end
+            end
+            save
+         end
+
+         # Send answers to dungeon master
+         def next_turn
+            if @answers
+               @mailer.relay @answers
+               @turn = nil
+               done = true
+            end
+            if @edited
+               @edited = false
+               @mailer.relay Sheet::NewSheet.new @sheet.attributes
+               done = true
+            end
+            unless done
+               UI::put_error "Nothing to send."
+            end
+            save
+         end
+
+      end
+
+   end
+
+end

data/lib/carps/mod/question.rb

@@ -0,0 +1,63 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps/protocol"
+
+require "carps/mod"
+
+require "carps/ui"
+
+module CARPS
+
+   # A question sent by the server, to be asked of the player.
+   #
+   # Interacts with Answers class
+   class Question < Message
+
+      # Extend the protocol
+      protoval :question
+
+      # Create a question
+      def initialize question
+         @text = question
+      end
+
+      # Parse from the void
+      def Question.parse blob
+         question, blob = find K.question, blob
+         [Question.new(question), blob]
+      end
+
+      # Emit
+      def emit
+         V.question @text 
+      end
+
+      # Ask the question, store the answer in the answers object
+      def ask answers
+         response = UI::question @text
+         answers.answer @text, response
+      end
+
+      # Preview the question
+      def preview
+         puts "Question: " + @text
+      end
+
+   end
+
+end

data/lib/carps/mod/rule.rb

@@ -0,0 +1,112 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+module CARPS
+
+   # A rule.
+   #
+   # This class uses the TemplateMethod pattern.
+   #
+   # Subclasses should provide the following methods
+   #
+   # * 'dice' method which takes needed parameters (ie from apply and show_odds) and returns a Dice
+   class Rule
+
+      # Create the rule
+      def initialize
+         @actions = {}
+      end
+
+      # Apply the rule to the arguments
+      def apply *args
+         d = dice *args
+         result = d.roll
+         action_klass = choose_action_class result
+         action = action_klass.new
+         action.apply result, *args
+      end
+
+      # Print the odds
+      def show_odds *args
+         d = dice *args
+         odds = {}
+         d.odds.each do |result, chance|
+            action = choose_action_class result
+            odds[action] = odds[action].to_f + chance
+         end
+         puts "The odds are approximately:"
+         puts "\n"
+         # Sort the odds
+         odds = odds.to_a.sort {|oda, odb| oda[1] <=> odb[1]}
+         odds = odds.reverse
+         odds.each do |action_klass, chance|
+            action = action_klass.new
+            percent = (chance * 100.0).to_i
+            puts "#{percent}% chance:"
+            puts "\t#{action.summary}"
+         end
+      end
+
+      protected
+
+      # Add an action
+      #
+      # Subclasses should use this method to add new actions
+      # 
+      # Compare may be:
+      # 
+      # * a range of valid values
+      #
+      # * one of :<, :<=, :==, :>, :>= and then an integer with which to compare
+      #
+      # * :all which indicates this is action which always applies
+      #
+      def add_action *compare, action
+         cmp = nil
+         if compare.length > 1
+            cmp = Dice::comparison_to_proc *compare
+         else
+            cmp = compare[0]
+         end
+         @actions[cmp] = action
+      end
+
+      # Choose the action
+      def choose_action_class result
+         @actions.each do |compare, action|
+            if compare.class == Range
+               if compare.include? result
+                  return action
+               end
+            elsif compare.class == Proc
+               if compare.call result
+                  return action
+               end
+            elsif compare == :all
+               return action
+            else
+               UI::warn "BUG: Removing #{action} from #{self.class} because its result selector was invalid: #{compare}."
+               @actions.delete compare
+            end
+         end
+         raise StandardError, "BUG: No action chosen in #{self.class}."
+      end
+
+
+   end
+
+end

data/lib/carps/mod/sheet/character.rb

@@ -0,0 +1,82 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "yaml"
+
+module CARPS
+
+   module Sheet
+
+      # Allow the dungeon master to inspect and modify character sheets
+      #
+      # Supports syntactic and semantic verification
+      class Character
+
+         def initialize sheet = {}
+            @sheet = sheet
+         end
+
+         # Access a value in the sheet
+         def [] attr
+            @sheet[attr]
+         end
+
+         # Set a value in the sheet
+         def []= attr, val
+            @sheet[attr] = val
+         end
+
+         # Dump the attributes
+         def attributes
+            @sheet
+         end
+
+         # The sheet has no entries - it is uninitialized!
+         def empty?
+            @sheet.empty?
+         end
+
+         # Emit
+         def emit
+            @sheet.to_yaml
+         end
+
+      end
+
+      # Player
+      #
+      # The mod is an observer on the player.  Hence when the player is updated, the mod can send the new character sheet via email
+      class Player < Character
+
+         # Pass a sheet, the moniker used to refer to this sheet, and a reference to the mod
+         def initialize mod, moniker, sheet = {}
+            super sheet
+            @mod = mod
+            @moniker = moniker
+         end
+
+         # Update the sheet and notify the mod
+         def []= attr, val
+            super
+            @mod.sheet_updated @moniker
+         end
+
+      end
+
+   end
+
+end

data/lib/carps/mod/sheet/editor.rb

@@ -0,0 +1,97 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps/ui"
+
+require "carps/mod"
+
+module CARPS
+
+
+   module Sheet
+
+      # Editor for a character sheet
+      #
+      # Performs validations also, popping open an editor if they fail
+      class Editor
+
+         def initialize schema, semantics
+            @schema = schema
+            @semantics = semantics
+         end
+
+         # Fill in the sheet
+         def fill sheet
+            edit sheet
+            validate sheet
+         end
+
+         # Is the sheet valid?
+         def valid? sheet
+            failures = @schema.produce_errors sheet
+            unless failures
+               failures = @semantics.produce_errors sheet
+            end
+            if failures
+               UI::put_error "Character sheet was incorrect:"
+               failures.each do |f|
+                  puts f
+               end
+               return false
+            else
+               return true
+            end
+         end
+
+         # Edit the sheet until it is valid
+         def validate sheet
+            valid = false
+            until valid
+               if sheet
+                  valid = valid? sheet
+               end
+               unless valid
+                  edit sheet
+               end
+            end
+         end
+
+         private
+
+         # Edit the sheet
+         def edit sheet
+            sheet_text = @schema.create_sheet_text sheet
+            sheet_map = nil
+            begin
+               editor = CARPS::Editor.load
+               sheet_text = editor.edit sheet_text
+               sheet_map = YAML.load sheet_text
+            rescue ArgumentError => e
+               UI::put_error e.message
+            end
+            if sheet_map
+               sheet_map.each do |attr, val|
+                  sheet[attr] = val
+               end
+            end
+         end
+
+      end
+
+   end
+
+end