carps 0.2.1

data/GEM_DESCRIPTION

@@ -0,0 +1,10 @@
+CARPS, the Computer Assisted Role-Playing Game System,
+is a tool for playing pen and paper RPGs over the internet.
+ 
+CARPS is:
+
+extensible; game rules are provided by extensions to CARPS.
+ 
+decentralized; CARPS' protocol is a layer on top of email. 
+
+secure; CARPS messages are cryptographically signed to prevent spoofing.

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-09-29
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,156 @@
+COPYING
+GEM_DESCRIPTION
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+bin/carps
+bin/carps_init
+bin/carps_ipc_test
+bin/carps_mod_saver_test
+bin/carps_mod_test
+config/website.yml
+features/character_sheet.feature
+features/crash.feature
+features/crypt.feature
+features/dice.feature
+features/dm.feature
+features/dmll.feature
+features/edit.feature
+features/email.feature
+features/interface.feature
+features/ipc.feature
+features/mailbox.feature
+features/mod.feature
+features/parser.feature
+features/persistent_protocol.feature
+features/player.feature
+features/player_turn.feature
+features/random.feature
+features/rule.feature
+features/safety.feature
+features/sessions.feature
+features/start_dm.feature
+features/start_player.feature
+features/step_definitions/common_steps.rb
+features/steps/character_sheet.rb
+features/steps/crash.rb
+features/steps/crypt.rb
+features/steps/dice.rb
+features/steps/dm.rb
+features/steps/dmll.rb
+features/steps/edit.rb
+features/steps/email.rb
+features/steps/general.rb
+features/steps/interface.rb
+features/steps/ipc.rb
+features/steps/mailbox.rb
+features/steps/mod.rb
+features/steps/parser.rb
+features/steps/persistent_protocol.rb
+features/steps/player.rb
+features/steps/player_turn.rb
+features/steps/random.rb
+features/steps/rule.rb
+features/steps/safety.rb
+features/steps/sessions.rb
+features/steps/start_dm.rb
+features/steps/start_player.rb
+features/steps/timeout.rb
+features/steps/type_verification.rb
+features/steps/wizard.rb
+features/support/common.rb
+features/support/env.rb
+features/support/matchers.rb
+features/timeout.feature
+features/type_verification.feature
+features/wizard.feature
+lib/carps.rb
+lib/carps/crypt.rb
+lib/carps/crypt/accept_handshake.rb
+lib/carps/crypt/default_messages.rb
+lib/carps/crypt/handshake.rb
+lib/carps/crypt/mailbox.rb
+lib/carps/crypt/mailer.rb
+lib/carps/crypt/peer.rb
+lib/carps/crypt/public_key.rb
+lib/carps/email.rb
+lib/carps/email/config.rb
+lib/carps/email/imap.rb
+lib/carps/email/smtp.rb
+lib/carps/email/string.rb
+lib/carps/mod.rb
+lib/carps/mod/action.rb
+lib/carps/mod/answers.rb
+lib/carps/mod/client_turn.rb
+lib/carps/mod/dice.rb
+lib/carps/mod/dm/interface.rb
+lib/carps/mod/dm/mod.rb
+lib/carps/mod/dm/reporter.rb
+lib/carps/mod/dm/resource.rb
+lib/carps/mod/dm/room.rb
+lib/carps/mod/interface.rb
+lib/carps/mod/launch.rb
+lib/carps/mod/mod.rb
+lib/carps/mod/player/interface.rb
+lib/carps/mod/player/mod.rb
+lib/carps/mod/question.rb
+lib/carps/mod/rule.rb
+lib/carps/mod/sheet/character.rb
+lib/carps/mod/sheet/editor.rb
+lib/carps/mod/sheet/new_sheet.rb
+lib/carps/mod/sheet/schema.rb
+lib/carps/mod/sheet/type.rb
+lib/carps/mod/sheet/verifier.rb
+lib/carps/mod/status_report.rb
+lib/carps/protocol.rb
+lib/carps/protocol/keyword.rb
+lib/carps/protocol/message.rb
+lib/carps/service.rb
+lib/carps/service/client_parser.rb
+lib/carps/service/dm/config.rb
+lib/carps/service/dm/mailer.rb
+lib/carps/service/dm/new_game.rb
+lib/carps/service/dm/start.rb
+lib/carps/service/game.rb
+lib/carps/service/interface.rb
+lib/carps/service/invite.rb
+lib/carps/service/mod.rb
+lib/carps/service/player/config.rb
+lib/carps/service/player/mailer.rb
+lib/carps/service/player/start.rb
+lib/carps/service/server_parser.rb
+lib/carps/service/session.rb
+lib/carps/service/start/config.rb
+lib/carps/service/start/interface.rb
+lib/carps/service/start/mailer.rb
+lib/carps/test.rb
+lib/carps/ui.rb
+lib/carps/ui/colour.rb
+lib/carps/ui/error.rb
+lib/carps/ui/highlight.rb
+lib/carps/ui/question.rb
+lib/carps/ui/warn.rb
+lib/carps/util.rb
+lib/carps/util/config.rb
+lib/carps/util/editor.rb
+lib/carps/util/error.rb
+lib/carps/util/files.rb
+lib/carps/util/init.rb
+lib/carps/util/process.rb
+lib/carps/util/timeout.rb
+lib/carps/util/windows.rb
+lib/carps/wizard.rb
+lib/carps/wizard/dm.rb
+lib/carps/wizard/player.rb
+lib/carps/wizard/steps.rb
+lib/carps/wizard/wizard.rb
+permission
+script/console
+script/destroy
+script/generate
+tasks/readme_site.rake
+test/test_carps.rb
+test/test_helper.rb
+website/index.html

data/PostInstall.txt

@@ -0,0 +1,20 @@
+=========================================================================
+
+                                         0
+                                         O
+                                         o
+                              ><> ><> ><>
+
+                  Thank you for installing CARPS 0.2.1
+
+                             For help, run:
+
+                                carps -h
+
+                                  
+                      CARPS is hosted on github at
+                     http://github.com/elginer/carps
+
+                  CARPS is copyright John Morrice 2010
+
+=========================================================================

data/README.rdoc

@@ -0,0 +1,141 @@
+= CARPS, the Computer Assisted Role-Playing Game System
+
+== CARPS is hosted on github:
+
+* http://github.com/elginer/carps
+
+== Description:
+
+CARPS, the Computer Assisted Role-Playing Game System,
+is a tool for playing pen and paper RPGs over the internet.
+
+CARPS differs from other such systems because CARPS is not a 'real-time' system.  It suits people who want to log on once or twice a day, take a turn, and then log out again.  While _OpenRPG_ could be described as being similar to a chat-room, CARPS is more similar to an email client.
+
+CARPS is an extensible system: game rules are provided by 'mods'.
+
+CARPS supports these mods by providing:
+
+* Text-mode user interfaces for the players and the dungeon master.
+
+* An easy to use probabilistic API which not only rolls the dice, but can report the probability of various game events occurring.
+
+* Automated static character sheet verification, according to a schema defined in YAML.  For example, a game might require your strength to be an integer.  
+
+* Support for the semantic validation of character sheets according to game rules.  For example, a game might require the sum of character's attributes to be below a certain maximum value.
+
+* Together the validation features allow a mod writer to encode game rules cleanly, as they do not need to consider the possibility of receiving an invalid sheet.
+
+CARPS has other strengths:
+
+* *Anyone* can play or host a CARPS game!  All you need is an email account.
+
+* CARPS is designed to be secure.  Multiple email security options are supported, and all CARPS messages are cryptographically signed to prevent spoofing.
+
+* You can instruct CARPS to use your favourite text editor and terminal emulator.
+
+* CARPS is easy to configure because it includes a wizard.
+
+*However*, CARPS is new and the following features, which you might take for granted, are not yet supported:
+
+* No GUI
+
+* No support for maps
+
+* No chat - all communication goes through the Game Master.
+
+* Games are currently invite only, at the discretion of the Game Master.
+
+* Security mechanisms are *not* well audited.
+
+== Requirements:
+
+For users:
+
+* ruby 1.9
+
+* rubygems
+
+* openssl
+
+* highline
+
+For developing CARPS, you will also need:
+
+* hoe
+
+* rake
+
+* newgem
+
+* cucumber
+
+== To Install:
+
+<tt># Install the gem</tt>
+
+<tt>sudo gem install carps</tt>
+
+<tt># Initialize the carps user directory.  Run this as your everyday user.</tt>
+
+<tt>carps_init</tt>
+
+== Basic Instructions:
+
+Run carps -h for help
+
+The first time CARPS is run, it will launch a wizard to help you configure
+your email settings, and choose a text editor and a terminal emulator.
+
+It is a good idea to specify a terminal emulator, as then CARPS can launch a
+mod in a new window (or similar).  Then the first CARPS window will act as an
+email logger, letting you see when you receive mails, without interfering with
+the text you type into the new window.
+
+You're also going to need to install a mod to play CARPS.  See the example 'fools' mod:
+
+* http://fools.rubyforge.org
+
+
+== Campaigns (For the DM):
+
+When you set up a new game, CARPS will ask for you to enter the name of a campaign.
+
+This allows you to create game resources prior to starting a game.
+
+For example, the following applies if your mod is called foo, the campaign is called bar, and your carps user data directory is /home/user/carps
+
+You should create the following directories
+
+the campaign directory: 
+
+<tt>/home/user/carps/dm/campaigns/foo/bar</tt>
+
+the NPCSs directory: 
+
+<tt>/home/user/carps/dm/campaigns/foo/bar/npcs</tt>
+
+the rooms directory: 
+
+<tt>/home/user/carps/dm/campaigns/foo/bar/rooms</tt>
+
+NPCs are defined as YAML files, according to the mod's schema.  Put them in the NPCs directory.  They MUST have the <tt>.yaml</tt> extension.
+
+Rooms are defined as text files.  These are just predefined pieces of prose that the DM will send to the players when they enter a room, for instance.  Put them in the rooms directory.  They MUST have the <tt>.txt</tt> extension.
+
+
+== License:
+
+Copyright 2010 John Morrice
+ 
+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/.

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+$IN_RAKE = true
+require './lib/carps'
+
+Hoe.plugin :newgem
+Hoe.plugin :website
+Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'carps' do
+  self.developer 'John Morrice', 'spoon@killersmurf.com'
+  self.post_install_message = File.read 'PostInstall.txt'
+  self.rubyforge_name       = self.name
+  self.description          = File.read "GEM_DESCRIPTION"
+  self.summary              = "Computer Assisted Role-Playing Game System" 
+  self.extra_deps           = [['highline','>= 1.6.1']]
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/bin/carps

@@ -0,0 +1,123 @@
+#!/usr/local/bin/ruby
+# 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 "optparse"
+
+require "carps"
+
+include CARPS
+
+# Set up the email
+def setup_email parser, session
+   config = EmailConfig.load
+   config.connect!
+   config.mailer parser, session
+end
+
+# Launch a CARPS session for a given role
+def play_role config, role
+   wizard = role::Wizard.new
+   if wizard.first_time?
+      wizard.create_files
+      wizard.create_directories
+      config = true
+   end
+   if config
+      wizard.run
+   else
+      CARPS::init
+      session = SessionManager.new
+      mailer = setup_email role::parser, session
+      role::StartInterface.start_game_interface mailer, role::GameConfig, session
+   end
+end
+
+# Run CARPS
+def carps
+   # The user is a player
+   player = false
+   # The user is a dungeon master
+   dm = false
+   # Configure CARPS
+   config = false
+
+   opts = OptionParser.new do |opts|
+
+      opts.banner = "Usage: carps [OPTION]"
+
+      opts.separator ""
+      opts.separator "Game options:"
+
+      opts.on "-p", "--player", "Play a game." do
+         player = true
+      end
+
+      opts.on "-m", "--master", "Host a game." do
+         dm = true
+      end
+
+      opts.separator ""
+      opts.separator "Other options:"
+
+      opts.on "-w", "--wizard", "Use this option to configure your settings.  Use with either --master or --player." do
+         config = true
+      end
+
+      opts.on "-h", "--help", "Print help." do
+         puts opts
+         exit
+      end
+
+      opts.on "-v", "--version", "Print version number." do
+         puts VERSION
+         exit
+      end
+
+      opts.on "-d", "--debug", "Debug mode." do
+         $DEBUG = true
+      end
+
+   end
+
+   begin
+      opts.parse! ARGV
+   rescue StandardError => e
+      puts e.to_s
+      puts opts
+      exit 1
+   end
+
+
+   if player and not dm
+      CARPS::config_dir "player"
+      play_role config, Player
+
+   elsif dm and not player
+      CARPS::config_dir "dm"
+      play_role config, DM
+   else
+      puts opts
+      exit 1
+   end
+end
+
+
+# Run CARPS, emitting a nice crash report if it fails
+CARPS::with_crash_report do
+   carps
+end

data/bin/carps_init

@@ -0,0 +1,29 @@
+#!/usr/local/bin/ruby
+# 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/>.
+
+# Create the user directory for carps
+
+require "carps"
+
+require "fileutils"
+
+root = CARPS::root_config
+FileUtils.mkdir root
+FileUtils.mkdir root + "player/"
+FileUtils.mkdir root + "dm/"
+FileUtils.touch root + "mods.yaml"

data/bin/carps_ipc_test

@@ -0,0 +1,44 @@
+#!/usr/local/bin/ruby
+# 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/>.
+
+# Test CARPS IPC.  Used for unit testing and as part of the wizard. 
+require "drb"
+
+require "highline"
+
+require "carps/util"
+
+DRb.start_service
+
+url = ARGV.shift
+
+puts "Listening on " + url
+puts "Waiting to see if it triggers a race condition bug..."
+sleep 2
+
+begin
+   mut = DRbObject.new nil, url
+   mut.mutate!
+   puts mut.works?
+rescue StandardError => e
+   puts "ERROR:"
+   puts e
+   CARPS::enter_quit 1
+end
+
+CARPS::enter_quit

data/bin/carps_mod_saver_test

@@ -0,0 +1,71 @@
+#!/usr/local/bin/ruby
+# 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/>.
+
+# Test that a mod running in another process can save its state via CARPS. 
+
+require "carps"
+
+class Saver
+
+   def mailer= mailer
+      @mailer = mailer
+   end
+
+   def initialize
+      @state = 99
+   end
+
+   def inc
+      @state += 1
+      puts "Saver: state now #{@state}"
+      @mailer.save self
+   end
+
+end
+
+module SaverMod
+
+   module Player      
+      
+      def Player::create_mod
+         Saver.new
+      end
+
+      def Player::launch mod
+         mod.inc
+      end
+
+   end
+
+   module DM
+
+      def DM::create_mod campaign
+         Saver.new
+      end
+
+      def DM::launch mod
+         mod.inc
+      end
+
+   end
+
+end
+
+CARPS::Launcher.launch SaverMod
+
+CARPS::enter_quit

data/bin/carps_mod_test

@@ -0,0 +1,62 @@
+#!/usr/local/bin/ruby
+# 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/>.
+
+# Test CARPS mod launching.  Used for unit testing and as part of the wizard. 
+
+require "carps"
+
+module TestMod
+
+   module Player      
+      
+      class Mod < CARPS::Player::Mod
+
+      end
+
+      def Player::create_mod
+         puts "Creating Player mod with"
+         Mod.new
+      end
+
+      def Player::launch mod
+         puts "Launching mod: #{mod.class}"
+      end
+
+   end
+
+   module DM
+
+      class Mod < CARPS::DM::Mod
+      end
+
+      def DM::create_mod campaign
+         puts "Creating DM mod running campaign: #{campaign}"
+         Mod.new CARPS::Resource.new campaign
+      end
+
+      def DM::launch mod
+         puts "Launching mod: #{mod.class}"
+      end
+
+   end
+
+end
+
+CARPS::Launcher.launch TestMod
+
+CARPS::enter_quit

data/config/website.yml

@@ -0,0 +1,2 @@
+host: spoon@rubyforge.org
+remote_dir: /var/www/gforge-projects/carps