carps 0.2.1

data/lib/carps/mod/dm/mod.rb

@@ -0,0 +1,409 @@
+# 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 DM
+      # Class for DM mods
+      #
+      # Functions as a facade to the resource, mailer and reporter classes.
+      #
+      # Subclasses should override schema and semantic_verifier
+      #
+      # FIXME: This class is WAY too big
+      class Mod < CARPS::Mod
+
+         # Initialize with a resource manager
+         def initialize resource
+            @resource = resource
+            new_reporter
+            @players = {}
+            @npcs = {}
+            @entities = {}
+            @monikers = {}
+            @mails = {}
+         end
+
+         # Invite a new player
+         def invite addr
+            @mailer.invite addr
+         end
+
+         # Save the game
+         def save
+            @mailer.save self
+         end
+
+         # Edit a sheet
+         def edit_sheet name
+            with_entity name do |char|
+               editor.fill char
+            end
+         end
+
+         # Ask a question of the player
+         def ask_player player
+            with_player player do
+               edit = Editor.load
+               question = edit.edit "# Enter question for #{player}"
+               @reporter.ask_player player, question
+            end
+         end
+
+         # Ask a question of everyone
+         def ask_everyone
+            edit = Editor.load
+            question = edit.edit "# Enter question for everyone"
+            @players.each_key do |player|
+               @reporter.ask_player player, question
+            end
+         end
+
+         # Delete questions for a player
+         def delete_questions player
+            with_player player do
+               @reporter.delete_questions player
+            end
+         end
+
+         # Update a player's report
+         def update_player player, report
+            @reporter.update_player player, report
+         end
+
+         # Delete all questions
+         def delete_all_questions
+            @reporter.delete_all_questions
+         end
+
+         # Delete all reports
+         def delete_all_reports
+            @reporter.delete_reports
+         end
+
+         # Delete a player's report
+         def delete_report player
+            with_player player do
+               @reporter.update_player player, ""
+            end
+         end
+
+         # All players are in this room
+         def everyone_in room
+            @resource.players_in @players.keys, room
+         end
+
+         # A player is in this room
+         def player_in player, room
+            with_player player do
+               @resource.player_in player, room
+            end
+         end
+
+         # Create a new npc
+         def new_npc type, name
+            if moniker_available? name
+               if char = @resource.new_npc(type)
+                  editor.validate char 
+                  @npcs[name] = char
+                  @entities[name] = :npc
+               end
+            end
+         end
+
+         # Inspect all turns
+         def inspect_reports
+            turns = @reporter.player_turns @players.keys
+            turns.each do |moniker, t|
+               puts "Upcoming turn for " + moniker
+               t.preview
+            end
+         end
+
+         # Inspect a player's turn
+         def inspect_turn player
+            with_player player do
+               turn = @reporter.player_turn player
+               turn.preview
+            end
+         end
+
+         # Next turn 
+         def next_turn
+            # Save the game
+            send_reports
+            new_reporter
+            save
+         end
+
+         # Create a report that all players will see
+         def create_global_report
+            e = Editor.load
+            global = e.edit "# Enter report for all players."
+            @players.each_key do |player|
+               @reporter.update_player player, global
+            end
+         end
+
+         # Edit the report for a player 
+         def tell player
+            with_player player do
+               @reporter.edit player
+            end
+         end
+
+         # Add a player
+         def add_player email
+            valid = false
+            until valid
+               moniker = UI::question "Enter moniker for " + email
+               valid = moniker_available? moniker
+            end
+            add_known_player moniker, email
+         end
+
+         # Add a player with a moniker
+         def add_known_player moniker, email
+            @monikers[moniker] = email
+            @mails[email] = moniker
+            @entities[moniker] = :player
+         end
+
+         # Describe an entity
+         def describe name
+            with_entity2 name,
+               lambda {unsafe_describe_player name},
+               lambda {unsafe_describe_npc name}
+         end
+
+         # Describe all npcs
+         def list_npcs
+            puts "The NPCs are:"
+            @npcs.each_key do |npc|
+               puts "\n#{npc}:"
+               unsafe_describe_npc npc
+            end
+         end
+
+         # Return player stats
+         def player_stats player
+            @players[player]
+         end
+
+         # Return npc stats
+         def npc_stats npc
+            @npcs[npc]
+         end
+
+         # List all the players
+         def list_players
+            puts "The players are:"
+            @players.each_key do |player|
+               unsafe_describe_player player
+            end
+         end
+
+         # Check for mail 
+         def check_mail
+            if mail = @mailer.check(Sheet::NewSheet)
+               unless @mails.member? mail.from 
+                  add_player mail.from
+               end
+               with_valid_mail mail do |moniker|
+                  new_character_sheet moniker, Sheet::Player.new(self, moniker, mail.dump)
+               end
+            elsif mail = @mailer.check(Answers)
+               with_valid_mail mail do |moniker|
+                  new_answer moniker, mail
+               end
+            end
+
+            if mail
+               true
+            else
+               puts "No new mail."
+               false
+            end
+
+         end
+
+         # A sheet has been updated so inform the player
+         def sheet_updated moniker
+            @reporter.sheet moniker, @players[moniker]
+         end
+
+         protected
+
+         # Perform an action with several entities.  Doesn't matter if the entity is a player or NPC.
+         #
+         # blk.arity must == names.length
+         def with_entities *names, &blk
+            entities = names.map {|name| find_entity_unsafe name}
+            if entities.all?
+               if blk.arity == entities.length
+                  blk.call *entities
+               else
+                  raise ArgumentError, "blk.arity != names.length"
+               end
+            else
+               UI::put_error "Some entities did not exist."
+               return
+            end
+         end
+
+         # Find an entity.  UNSAFE.
+         def find_entity_unsafe name
+            entity = nil
+            unless entity = @players[name]
+               entity = @npcs[name]
+            end
+            entity
+         end
+
+         # Perform an action with an entity.  Doesn't matter if the entity is a player or NPC.
+         def with_entity name
+            with_entity2 name,
+               lambda {yield @players[name]},
+               lambda {yield @npcs[name]}
+         end
+
+         # Perform an action with an entity,
+         # where it does not matter if the entity is a player or an NPC.
+
+         # Perform an action with an entity.
+         #
+         # The first Proc is called if it's a Player
+         #
+         # The second is called if it's an NPC
+         def with_entity2 name, player_proc, npc_proc
+            case @entities[name]
+            when :player
+               execute_sheet_proc player_proc, @players[name]
+            when :npc
+               execute_sheet_proc npc_proc, @npcs[name]
+            when nil
+               UI::put_error "Unknown entity: #{name}"
+            end
+         end
+
+         # Execute a proc, passing a sheet if the arity is 1
+         def execute_sheet_proc func, sheet
+            if func.arity == 0
+               func.call
+            elsif func.arity == 1
+               func.call sheet
+            else
+               raise ArgumentError, "'func' must have arity of 0 or 1"
+            end
+         end
+
+         # Register a new character sheet
+         def new_character_sheet moniker, sheet
+            UI::highlight "New character sheet for #{moniker}"
+            editor.validate sheet
+            @players[moniker] = sheet
+         end
+
+         def unsafe_describe_npc npc
+            puts @npcs[npc].emit
+         end
+
+         def unsafe_describe_player player
+            mail = @monikers[player]
+            puts mail + " aka " + player + " aka: "
+            puts @players[player].emit
+         end
+
+         # Moniker is available?
+         def moniker_available? mon
+            not @entities.member? mon
+         end
+
+         # Send the reports
+         def send_reports
+            turns = @reporter.player_turns @players.keys
+            turns.each do |moniker, turn|
+               addr = @monikers[moniker]
+               @mailer.relay addr, turn
+            end
+         end
+
+         # Search for mail
+         def search mail
+            found = nil
+            mail.each do |moniker, inbox|
+               unless inbox.empty?
+                  found = [moniker, inbox.shift]
+                  break
+               end
+            end
+            return found
+         end
+
+         # Print the answer
+         def new_answer moniker, answer
+            answer.from = moniker
+            answer.display
+         end
+
+         def with_valid_mail mail
+            moniker = @mails[mail.from]
+            if moniker
+               yield moniker
+            else
+               warn "BUG",  "Mod received mail from unregistered player #{mail.from}"
+            end
+         end
+
+         # If the player exists, continue
+         def with_player player
+            if player? player
+               yield
+            else
+               UI::put_error "Unknown player."
+            end
+         end
+
+         # Does a player exist?
+         def player? player
+            @players.member? player
+         end
+
+         # Only execute the block if the npc exists
+         def with_npc name
+            if @npcs.member? name
+               yield
+            else
+               UI::put_error "Unknown NPC."
+            end
+         end
+
+         # Create a new reporter
+         def new_reporter
+            @reporter = Reporter.new
+            @resource.reporter = @reporter
+         end
+
+      end
+
+   end
+
+end

data/lib/carps/mod/dm/reporter.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/>.
+
+require "carps/mod"
+
+require "carps/util"
+
+module CARPS
+
+   # Used by the dungeon master to generate reports
+   #
+   # Subclasses should override the "player_turn" method
+   class Reporter
+
+      def initialize
+         @status = {}
+         @questions = {}
+         @sheets = {}
+      end
+
+      # Produce a ClientTurn for the player referred to by the moniker
+      def player_turn moniker
+         report = @status[moniker]
+         unless report
+            report = ""
+         end
+         status = StatusReport.new report 
+         qtext = @questions[moniker]
+         unless qtext
+            qtext = []
+         end
+         questions = qtext.map {|q| que = Question.new q}
+         sheet = @sheets[moniker]
+         unless sheet
+            sheet = Sheet::Character.new({})
+         end
+         stats = sheet.attributes
+         new_sheet = Sheet::NewSheet.new stats
+         ClientTurn.new new_sheet, status, questions 
+      end
+
+      # Produce a hash of email address to ClientTurn objects
+      def player_turns monikers
+         turns = {}
+         monikers.each do |moniker|
+            turns[moniker] = player_turn moniker 
+         end
+         turns
+      end
+
+      # A character sheet has been changed
+      def sheet moniker, sheet
+         @sheets[moniker] = sheet
+      end
+
+      # Edit the report for a player 
+      def edit player
+         editor = Editor.load
+         stat = @status[player]
+         unless stat
+            stat = ""
+         end
+         stat = "# Enter report for #{player}\n" + stat
+         @status[player] = editor.edit stat
+      end
+
+      # Inform the reporter of updates to a player's status report
+      def update_player player, status
+         @status[player] = status
+      end
+
+      # Ask a player some questions
+      def ask_player moniker, question
+         if @questions.member? moniker
+            @questions[moniker].push question
+         else
+            @questions[moniker] = [question]
+         end
+      end
+
+      # Delete reports
+      def delete_reports
+         @status = {}
+      end
+
+      # Delete all questions for a player
+      def delete_questions moniker
+         @questions.delete moniker 
+      end
+
+      # Delete all questions for all players
+      def delete_all_questions
+         @questions = {}
+      end
+
+   end
+
+end

data/lib/carps/mod/dm/resource.rb

@@ -0,0 +1,88 @@
+# 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"
+
+require "yaml"
+
+module CARPS
+
+   # Resource manager
+   class Resource
+
+      # Takes as an argument a directory, within the users campaign directory
+      def initialize rdir
+         @dir = $CONFIG + "campaigns/#{rdir}"
+      end
+
+      # Create a new npc of a given type
+      def new_npc type
+         sheet_loc = @dir + "/npcs/" + type + ".yaml"
+         begin
+            Sheet::Character.new YAML::load File.read sheet_loc
+         rescue
+            UI::warn "Could not create NPC: " + sheet_loc
+            return nil
+         end
+      end
+
+      # Put everyone in this room
+      def players_in players, room_name
+         room = load_room room_name
+         if room
+            players.each do |player|
+               update_reporter player, room
+            end
+         end
+      end
+
+      # This player is in this room
+      def player_in player, room_name
+         room = load_room room_name
+         if room
+            update_reporter player, room
+         end
+      end
+
+      # Register a reporter, update the reporter with changes
+      def reporter= report
+         @reporter = report
+      end
+
+      private
+      
+      # Load a room
+      def load_room room
+         room_loc = @dir + "/rooms/" + room + ".txt"
+         begin
+            return Room.new room_loc
+         rescue Exception => e
+            UI::warn "Could not load room: " + room_loc
+            return nil
+         end
+      end
+
+      # Update the reporter
+      def update_reporter player, room
+         @reporter.update_player player, room.describe
+      end
+
+   end
+
+end

data/lib/carps/mod/dm/room.rb

@@ -0,0 +1,33 @@
+# 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 room, loaded in by the Resource class
+   class Room
+
+      def initialize filepath
+         @desc = File.read filepath
+      end
+
+      def describe
+         @desc
+      end
+
+   end
+
+end

data/lib/carps/mod/interface.rb

@@ -0,0 +1,73 @@
+# 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/service"
+
+require "carps/mod"
+
+require "carps/ui"
+
+module CARPS
+
+   # Interface for roleplaying
+   class RolePlayInterface < QuitInterface
+
+      def initialize
+         super
+         add_command "d", "Roll a dice with a given number of sides.", "SIDES"
+         add_command "int", "An random integer between MIN and MAX.", "MIN", "MAX"
+         add_command "dec", "A decimal between MIN and MAX.", "MIN", "MAX"
+      end
+
+      def d n
+         i = n.to_i
+         if i <= 1
+            UI::put_error "A dice must have more than 1 side."
+         else
+            puts Dice::rint(1, i)
+         end
+      end
+
+      def int min, max
+         min = min.to_i
+         max = max.to_i
+         if min >= max
+            bounds_err
+         else
+            puts Dice::rint(min, max)
+         end
+      end
+
+      def dec min, max
+         min = min.to_f
+         max = max.to_f
+         if min >= max
+            bounds_err
+         else
+            puts Dice::rfloat(min, max)
+         end
+      end
+
+      private
+
+      def bounds_err
+         UI::put_error "MIN must be less than MAX."
+      end
+
+   end
+
+end