carps 0.2.1

data/lib/carps/protocol.rb

@@ -0,0 +1,19 @@
+# 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/keyword"
+require "carps/protocol/message"

data/lib/carps/service/client_parser.rb

@@ -0,0 +1,34 @@
+# 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/game"
+require "carps/crypt/default_messages"
+
+require "carps/mod/client_turn"
+
+module CARPS
+
+   module Player
+
+      # Create a parser which parses messages for the client
+      def Player::parser
+         MessageParser.new default_messages + [Invite, ClientTurn] 
+      end
+
+   end
+
+end

data/lib/carps/service/dm/config.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/service/game"
+require "carps/service/start/config"
+
+require "yaml"
+
+module CARPS
+
+   module DM
+      # Class to read game configuration files
+      class GameConfig < SessionConfig
+
+         # Create a new GameConfig
+         def initialize filename, mod, campaign, about, session, dm
+            super session, filename
+            @campaign = campaign
+            @mod = mod
+            @about = about
+            @dm = dm
+         end
+
+         # Parse a game config file
+         def parse_yaml conf
+            super
+            @campaign = read_conf conf, "campaign"
+            @mod = read_conf conf, "mod"
+            @about = read_conf conf, "about"
+            @dm = read_conf conf, "dm"
+         end
+
+         # Display information on this configuration
+         def display
+            puts "Mod: " + @mod
+            puts "Campaign: " + @campaign
+            puts "Description:"
+            puts @about
+            puts "DM: " + @dm
+         end
+
+         # Return a GameServer object that can communicate with players 
+         def spawn
+            GameServer.new @mod, @campaign, @about, @session, self, @dm
+         end
+
+         protected
+
+         # Emit as hash 
+         def emit
+            {"mod" => @mod, 
+             "campaign" => @campaign, 
+             "about" => @about,
+             "dm" => @dm
+            }.merge super
+         end
+
+      end
+
+   end
+
+end

data/lib/carps/service/dm/mailer.rb

@@ -0,0 +1,70 @@
+# 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/service"
+
+module CARPS
+
+   module DM
+
+      # A bridge between the DM mod and CARPS 
+      class Mailer < ModMailer
+
+         # Create the mailer from
+         #
+         # a Mailer,
+         #
+         # a GameConfig,
+         # 
+         # a session id,
+         #
+         # the email address of the dm,
+         #
+         # the name of the mod,
+         #
+         # and the description of the game
+         def initialize mailer, conf, session, dm, mod, desc
+            super mailer, conf
+            @session = session
+            @dm = dm
+            @mod = mod
+            @about = desc
+         end
+
+         # Invite a new player
+         def invite addr
+            inv = Invite.new @dm, @mod, @about, @session
+            relay addr, inv
+         end
+
+
+         # Check for mail of a given type
+         def check type
+            @mailer.check type
+         end
+
+         # Send mail to the recipient
+         def relay to, message
+            @mailer.send to, message
+         end
+
+      end
+
+   end
+
+end

data/lib/carps/service/dm/new_game.rb

@@ -0,0 +1,101 @@
+# 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/ui"
+
+module CARPS
+
+   module DM
+
+      # Interface for creating new games
+      class NewGameInterface < Interface
+
+         # Create a new NewGameInterface from a continuation
+         def initialize cont, manager, config, mailer
+            super()
+            @manager = manager
+            @game_config = config
+            @continuation = cont
+            @mailer = mailer
+            add_command :go, "Start the game."
+            add_command :describe, "Describe the game."
+            add_command :name, "Give the game a name.", "NAME"
+            add_command :mod, "Choose the mod.\n#{options load_mods.keys}", "MOD"
+            add_command :campaign, "Choose the campaign.", "CAMPAIGN"
+         end
+
+         protected
+
+         # Set the campaign
+         def campaign adventure
+            @campaign = adventure
+         end
+
+         # Set the mod
+         def mod user_mod
+            if load_mods.include?(user_mod)
+               @mod = user_mod
+            else
+               UI::put_error "No such mod is installed."
+            end
+         end
+
+         # Describe the game
+         def describe
+            editor = Editor.load
+            @description = editor.edit "# Enter description of game."
+         end
+
+         # Give the game a name
+         def name nm
+            @name = nm
+         end
+
+         # Start the game
+         def go
+            if @mod and @name and @description and @campaign
+               puts "The game details are:"
+               puts "Name: #{@name}"
+               puts "Mod: #{@mod}"
+               puts "Campaign: #{@campaign}"
+               puts "Description: #{@description}"
+
+               happy = UI::confirm "Are these details correct?"
+
+               if happy
+                  mods = load_mods
+                  session_id = @manager.generate @name + @mod + @campaign
+                  config = @game_config.new @name, @mod, @campaign, @description, session_id, @mailer.address
+                  config.save
+                  game = config.spawn
+                  @continuation.call lambda {
+                     game.start @mailer
+                  }
+               end
+            else
+               UI::put_error "You need to set the game options first."
+            end
+
+         end
+
+      end
+
+   end
+
+end

data/lib/carps/service/dm/start.rb

@@ -0,0 +1,47 @@
+# 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/util"
+
+require "carps/ui"
+
+module CARPS
+
+   module DM
+
+      # Interface for the dm to start games
+      class StartInterface < StartGameInterface
+
+         def initialize continuation, mailer, game_config, manager 
+            super
+            add_command :new, "Start a new game."
+         end
+
+         protected
+
+         # Start new game
+         def new
+            new_game_interface = NewGameInterface.new @continuation, @manager, @game_config, @mailer
+            new_game_interface.run
+         end
+      end
+
+   end
+
+end

data/lib/carps/service/game.rb

@@ -0,0 +1,101 @@
+# 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/protocol"
+
+require "carps/ui"
+
+require "carps/util"
+
+require "drb"
+
+module CARPS
+
+   # Server game
+   class GameServer
+
+      # The first parameter is email account information.
+      # The second is the mod.
+      # The third is the description.
+      # The fourth is the session key
+      # The fifth is the configuration file
+      # The sixth is the DM's address
+      def initialize mod, campaign, desc, session, conf, dm
+         @campaign = campaign
+         @mod = mod
+         @about = desc
+         @session = session
+         @conf = conf
+         @dm = dm
+      end
+
+      # Invite players to this game and begin
+      #
+      # FIXME: Just use 'play'
+      def start mailer
+         play mailer
+      end
+
+      # Resume this game
+      #
+      # FIXME: just use 'play'
+      def resume mailer
+         play mailer
+      end
+
+      private
+
+      def play mailer
+         mod = load_mods[@mod]
+         dm_mailer = DM::Mailer.new mailer, @conf, @session, @dm, @mod, @about
+         Process.singleton.launch dm_mailer, mod + " -h \"" + @campaign + "\""
+      end
+
+   end
+
+   # Client games
+   class GameClient
+
+      # The first parameter is the dungeon master's name
+      # The second is the mod.
+      # The third is the configuration file
+      def initialize dm, mod, conf
+         @dm = dm
+         @mod = mod
+         @conf = conf
+      end
+
+      # Join this game as a client
+      #
+      # FIXME: just use resume
+      def join_game mailer
+         resume mailer
+      end
+
+      # Play the game
+      def resume mailer
+         mod = load_mods[@mod]
+         player_mailer = Player::Mailer.new @dm, mailer, @conf
+         Process.singleton.launch player_mailer, mod + " -p"
+      end
+
+   end
+
+
+end

data/lib/carps/service/interface.rb

@@ -0,0 +1,174 @@
+# 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/question"
+
+require "carps/ui/warn"
+
+require "carps/ui/error"
+
+module CARPS
+
+   # A basic user interface
+   #
+   # Subclass this interface to provide commands
+   class Interface
+
+      def initialize 
+         @commands = {}
+         add_command :help, "Displays this help message."
+      end
+
+      def run
+         consistent!
+         help
+         repl
+      end
+
+      protected
+
+      # Provide a string of options
+      def options *opts
+         out = "Options are:\n\t"
+         out + opts.join("\n\t\tor\n\t")
+      end
+
+      # Ensure consistency 
+      def consistent!
+         # Check we're working
+         @commands.each_key do |cmd|
+            unless respond_to?(cmd)
+               UI::warn "This menu was intended to provide a '#{cmd}' command!", 
+               "However, it has been ommitted due to a programmer error."
+               @commands.delete cmd
+            end
+         end
+      end
+
+      # Add a command
+      #
+      #
+      # You must also create a method 
+      # called name which takes each of args as parameters
+      def add_command name, help, *args
+         name = name.to_s
+         @commands[name] = {"help" => help, "args" => args}
+         eval <<-END
+         def exec_#{name} args
+            check args, #{args.length} do
+         #{name} *args
+            end
+         end
+      END
+      end
+
+      # Add a command which receives the text after it, as one, argument: a possibly empty string
+      def add_raw_command name, help, *args
+         name = name.to_s
+         @commands[name] = {"help" => help, "args" => args}
+         eval <<-END
+         def exec_#{name} args
+         #{name} args.join " "
+         end
+         END
+      end
+
+      # Check the args are of the correct length
+      def check args, length
+         if args.length == length
+            yield *args
+         else
+            UI::put_error "Expected #{length} parameters."
+         end
+      end
+
+      def execute cmd
+         if cmd.empty?
+            empty_line
+         else
+            if @commands.member? cmd[0]
+               self.send "exec_" + cmd[0], cmd[1..-1]
+            else
+               UI::put_error "Unknown command: '" + cmd[0] + "'. Try 'help'."
+            end
+         end
+      end
+
+      def empty_line
+         UI::put_error "You must enter a command.  Try 'help'."
+      end
+
+      def help
+         puts ""
+         puts "The available commands, and their formal parameters, are:"
+         @commands.each do |cmd, info|
+            puts ""
+            puts cmd + " " + info["args"].join(" ")
+            puts info["help"]
+         end
+         puts ""
+      end
+
+      # Read eval print loop
+      def repl
+         loop do
+            rep
+         end
+      end
+
+      # Read eval print
+      def rep 
+         line = UI::question "Enter command:"
+         cmd = line.split /\s+/
+         execute cmd
+      end
+
+   end
+
+   class QuitInterface < Interface
+
+      def initialize
+         super
+         add_command :quit, "Quit the program"
+      end
+
+      protected
+
+      def quit
+         @run = false
+      end
+
+      def repl
+         @run = true
+         while @run
+            rep
+         end
+      end
+
+   end
+
+   # Interface which can alter program execution (ie, by terminating)
+   module ControlInterface 
+
+      def quit
+         puts "Bye!"
+         exit
+      end
+
+   end
+
+end

data/lib/carps/service/invite.rb

@@ -0,0 +1,79 @@
+# 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/service"
+
+require "carps/ui"
+
+module CARPS
+
+      # An invitation
+   class Invite < Message
+
+      # We are part of the protocol :)
+      protoval :master
+      protoval :mod
+      protoval :about
+      protoval :session
+
+      def initialize dm, mod, about, session
+         @dm = dm
+         @mod = mod
+         @about = about
+         @session = session
+      end
+
+      # Parse this from semi-structured text
+      def Invite.parse blob
+         dm, blob = find K.master, blob
+         mod, blob = find K.mod, blob
+         about, blob = find K.about, blob
+         session, blob = find K.session, blob
+         [Invite.new(dm, mod, about, session), blob] 
+      end
+
+      # Ask if the player wants to accept this invitation,
+      # join the game if they do
+      def ask
+         puts "You have been invited to a game!"
+         if load_mods.member? @mod
+            game = Player::GameConfig.new "", @mod, @dm, @about, @session 
+            game.display
+            if UI::confirm("Do you want to join?")
+               filename = UI::question "Enter a file name for the game:"
+               game.filename = filename
+               game.save
+               return game
+            else
+               return nil
+            end
+         else
+            puts "But it's for the mod: " + @mod 
+            puts "Which you don't have installed."
+            return nil 
+         end
+      end
+
+      def emit
+         V.master(@dm) + V.mod(@mod) + V.about(@about) + V.session(@session)
+      end
+
+   end
+
+end