gamefic-sdk 1.5.0 → 1.6.0

data/lib/gamefic-sdk/platform/web/engine.rb

@@ -0,0 +1,41 @@
+# @hack Explicit requires for Opal
+require 'gamefic/plot/playbook'
+require 'gamefic/grammar'
+require 'gamefic/query'
+require 'gamefic/grammar/verb_set'
+require 'gamefic/grammar/conjugator'
+
+module Gamefic
+  module Engine
+    class Web < Gamefic::Engine::Base      
+      def post_initialize
+        self.user_class = Gamefic::User::Web
+      end
+
+      def run
+        connect
+        @plot.introduce @character
+        @plot.ready
+        @user.update @character.state
+      end
+
+      def turn
+        @plot.ready
+        @user.update @character.state
+        update unless @character.queue.empty?
+      end
+
+      def receive input
+        @character.queue.push input unless input.nil?
+        update
+      end
+
+      private
+
+      def update
+        @plot.update
+        turn
+      end
+    end
+  end
+end

data/lib/gamefic-sdk/platform/web/user.rb

@@ -0,0 +1,19 @@
+module Gamefic
+  module User
+    class Web < Gamefic::User::Base
+      def update state
+        `Gamefic.update(#{state.to_json});`
+      end
+
+      def save filename, data
+        data[:metadata] = GameficOpal.static_plot.metadata
+        `Gamefic.save(filename, data);`
+      end
+
+      def restore filename
+        data = `Gamefic.restore(filename);`
+        return data
+      end
+    end
+  end
+end

data/lib/gamefic-sdk/server.rb

@@ -0,0 +1,67 @@
+require 'sinatra/base'
+require 'yaml'
+
+module Gamefic
+  module Sdk
+
+    class Server < Sinatra::Base
+      set :port, 4342
+      
+      get '/' do
+        paths = config_path(settings.source_dir).script_paths + [Gamefic::Sdk::GLOBAL_SCRIPT_PATH]
+        config = YAML.load(File.read(File.join(settings.source_dir, 'config.yaml')))
+        config['name'] = 'sinatra'
+        @@plot = Gamefic::Sdk::Debug::Plot.new Source::File.new(*paths)
+        @@plot.script 'main'
+        @@plot.script 'debug'
+        sinatra = Gamefic::Sdk::Platform::Sinatra.new(settings.source_dir, config)
+        sinatra.build
+        File.read File.join(sinatra.config['target_dir'], 'index.html')
+      end
+
+      post '/start' do
+        content_type :json
+        @@character = Character.new(name: 'player', synonyms: 'me myself self you yourself', description: 'As good-looking as ever.')
+        @@character.connect User::Base.new
+        @@plot.introduce @@character
+        @@plot.ready
+        @@character.state.to_json
+      end
+
+      post '/update' do
+        content_type :json
+        @@character.queue.push params['command']
+        @@plot.update
+        @@plot.ready
+        @@character.state.merge(input: params['command']).to_json
+      end
+
+      class << self
+
+        def run!
+          start_browser if settings.browser
+          super
+        end
+        
+        def start_browser
+          Thread.new {
+            sleep 1 until Server.running?
+            `start http://localhost:#{settings.port}`
+          }
+        end
+
+      end
+
+      private
+
+      def config_path dir
+        if File.directory?(dir)
+          PlotConfig.new File.join(dir, 'config.yaml')
+        else
+          PlotConfig.new
+        end
+      end
+    end
+
+  end
+end

data/lib/gamefic-sdk/shell.rb

@@ -21,30 +21,70 @@ module Gamefic
       option :standard, type: :boolean, default: true, desc: 'Include the standard script'
       option :scripts, type: :array, aliases: [:s, :script], desc: 'Additional scripts'
       option :webskin, default: 'standard', aliases: [:w], desc: 'Skin to use for the Web platform'
+      option :webdir, aliases: [:d], desc: 'HTML directory to copy. This option overrides the webskin.'
       option :title, type: :string, aliases: [:t], desc: "The game's title"
       option :author, type: :string, aliases: [:a], desc: "The game's author"
       def init(directory_name)
-        Gamefic::Sdk::Shell::Init.new(directory: directory_name,
-          quiet: options[:quiet], scripts: options[:scripts], webskin: options[:webskin],
-          title: options[:title], author: options[:author]).run
+        Gamefic::Sdk::Shell::Init.new(
+          directory: directory_name, quiet: options[:quiet], scripts: options[:scripts],
+          webskin: options[:webskin], title: options[:title], author: options[:author],
+          webdir: options[:webdir]
+        ).run
       end
 
-      desc 'test DIRECTORY_NAME', 'Play the game in DIRECTORY_NAME'
-      def test(directory_name)
+      desc 'test [DIRECTORY_NAME]', 'Play the game in DIRECTORY_NAME'
+      def test(directory_name = '.')
         Gamefic::Sdk::Shell::Test.new(directory: directory_name).run
       end
 
-      desc 'build DIRECTORY_NAME', 'Build the game for specified platforms in DIRECTORY_NAME'
+      desc 'server [DIRECTORY_NAME]', 'Run the game in DIRECTORY_NAME in a web server'
+      option :browser, type: :boolean, aliases: :b, desc: 'Open a browser when the server starts'
+      def server(directory_name = '.')
+        Gamefic::Sdk::Server.set :source_dir, directory_name
+        Gamefic::Sdk::Server.set :browser, options[:browser]
+        pub = File.join(directory_name, 'release', 'sinatra').gsub(/\\/, '/')
+        Gamefic::Sdk::Server.set :public_folder, pub
+        Gamefic::Sdk::Server.run!
+      end
+
+      desc 'build [DIRECTORY_NAME]', 'Build the game for specified platforms in DIRECTORY_NAME'
       option :quiet, type: :boolean, aliases: :q, desc: 'Suppress output'
-      def build(directory_name)
+      def build(directory_name = '.')
         Gamefic::Sdk::Build.release(directory_name, options[:quiet])
       end
 
-      desc 'clean DIRECTORY_NAME', 'Perform cleanup of DIRECTORY_NAME'
-      def clean(directory_name)
+      desc 'clean [DIRECTORY_NAME]', 'Perform cleanup of DIRECTORY_NAME'
+      def clean(directory_name = '.')
         Gamefic::Sdk::Build.clean(directory_name)
       end
-      
+
+      desc 'import-scripts [DIRECTORY_NAME]', 'Copy external scripts to the local scripts directory'
+      def import_scripts(directory_name = '.')
+        config_yaml = File.join(directory_name, 'config.yaml')
+        if File.exist?(config_yaml)
+          config_path = PlotConfig.new config_yaml
+        else
+          config_path = PlotConfig.new
+        end
+        FileUtils.mkdir_p(File.join(directory_name, 'scripts'))
+        paths = config_path.script_paths + [Gamefic::Sdk::GLOBAL_SCRIPT_PATH]
+        plot = Gamefic::Sdk::Debug::Plot.new Source::File.new(*paths)
+        plot.script 'main'
+        plot.imported_scripts.each { |s|
+          src = File.absolute_path(s.absolute_path)
+          dst = File.absolute_path(File.join(directory_name, 'scripts', "#{s.path}.plot.rb"))
+          next if src == dst
+          puts "Importing #{s.path}"
+          FileUtils.mkdir_p(File.dirname(dst))
+          FileUtils.cp_r(src, dst)
+        }
+      end
+
+      desc 'reset-package [DIRECTORY_NAME]', 'Reset package.yaml to the default values'
+      def reset_config(directory_name = '.')
+
+      end
+
       desc 'webskins', 'List the available skins for the Web platform'
       def webskins
         Dir[File.join(Gamefic::Sdk::HTML_TEMPLATE_PATH, 'skins', '*')].sort.each { |d|

data/lib/gamefic-sdk/shell/init.rb

@@ -5,10 +5,11 @@ module Gamefic
   module Sdk
     class Shell
       class Init
-        def initialize(directory:, standard: true, quiet: false, scripts: [], webskin: 'standard', title: nil, author: nil)
+        def initialize(directory:, standard: true, quiet: false, scripts: [], webskin: 'standard', webdir: nil, title: nil, author: nil)
           @quiet = quiet
           @directory = directory
           @html = webskin
+          @webdir = webdir
           @scripts = []
           @scripts.push('standard') if standard
           @scripts += scripts if scripts
@@ -86,7 +87,11 @@ module Gamefic
 
         def copy_html_skin
           Dir.mkdir("#{@directory}/html")
-          FileUtils.cp_r(Dir[Gamefic::Sdk::HTML_TEMPLATE_PATH + '/skins/' + @html + '/*'], "#{@directory}/html")
+          if @webdir.nil?
+            FileUtils.cp_r(Dir[Gamefic::Sdk::HTML_TEMPLATE_PATH + '/skins/' + @html + '/*'], "#{@directory}/html")
+          else
+            FileUtils.cp_r(Dir[File.join(File.realpath(@webdir), '*')], "#{@directory}/html")
+          end
         end
       end
     end

data/lib/gamefic-sdk/version.rb

@@ -1,5 +1,5 @@
 module Gamefic
   module Sdk
-    VERSION = '1.5.0'
+    VERSION = '1.6.0'
   end
 end

data/scripts/autosuggest.plot.rb

@@ -22,8 +22,11 @@ class Gamefic::Character
   include Autosuggest
 end
 
-on_player_update do |actor|
-  if actor.scene == :active
+# Suggestions get updated (future suggestions become current) in
+# on_player_ready. Autosuggest gathers suggestions in on_ready so it gets
+# done first.
+on_player_ready do |actor|
+  if (actor.scene == default_scene and actor.next_scene.nil?) or actor.next_scene == default_scene
     actor.suggest "look around"
     actor.suggest "inventory"
     actor.room.children.that_are(Portal).each { |entity|
@@ -55,15 +58,6 @@ on_player_update do |actor|
     if (actor.parent != actor.room)
       actor.suggest "#{actor.parent.leave_verb} #{the actor.parent}"
     end
-    actor.children.that_are_not(:attached?).each { |entity|
-      actor.suggest "drop #{the entity}"
-      Use.siblings.context_from(actor).that_are(Supporter).each { |supporter|
-        actor.suggest "put #{the entity} on #{the supporter}"
-      }
-      Use.siblings.context_from(actor).that_are(Receptacle).each { |receptacle|
-        actor.suggest "put #{the entity} in #{the receptacle}"
-      }
-    }
     vicinity = actor.parent.children.that_are_not(Portal)
     if actor.parent != actor.room
       vicinity.concat actor.room.children.that_are_not(Portal)

data/scripts/clothing/actions/wear.plot.rb

@@ -1,4 +1,4 @@
-respond :wear, Query::Reachable.new(Clothing) do |actor, clothing|
+respond :wear, Use.family(Clothing) do |actor, clothing|
   if actor.auto_takes?(clothing)
     if clothing.attached?
       actor.tell "You're already wearing #{the clothing}."

data/scripts/clothing/entities/clothing.plot.rb

@@ -1,6 +1,6 @@
 script 'standard/entities/item'
 
-class Gamefic::Clothing < Gamefic::Item
+class Clothing < Item
   def worn?
     self.parent.kind_of?(Character) and self.attached?
   end

data/scripts/clothing/entities/coat.plot.rb

@@ -1,5 +1,5 @@
 script 'clothing/entities/clothing'
 
-class Gamefic::Coat < Gamefic::Clothing
+class Coat < Clothing
 
 end

data/scripts/clothing/entities/gloves.plot.rb

@@ -1,5 +1,5 @@
 script 'clothing/entities/clothing'
 
-class Gamefic::Gloves < Gamefic::Clothing
+class Gloves < Clothing
 
 end

data/scripts/clothing/entities/hat.plot.rb

@@ -1,5 +1,5 @@
 script 'clothing/entities/clothing'
 
-class Gamefic::Hat < Gamefic::Clothing
+class Hat < Clothing
 
 end

data/scripts/clothing/entities/pants.plot.rb

@@ -1,5 +1,5 @@
 script 'clothing/entities/clothing'
 
-class Gamefic::Pants < Gamefic::Clothing
+class Pants < Clothing
 
 end

data/scripts/clothing/entities/shirt.plot.rb

@@ -1,5 +1,5 @@
 script 'clothing/entities/clothing'
 
-class Gamefic::Shirt < Gamefic::Clothing
+class Shirt < Clothing
 
 end

data/scripts/clothing/entities/shoes.plot.rb

@@ -1,5 +1,5 @@
 script 'clothing/entities/clothing'
 
-class Gamefic::Shoes < Gamefic::Clothing
+class Shoes < Clothing
 
 end

data/scripts/save-restore.plot.rb

@@ -6,6 +6,7 @@ end
 
 meta :save, Query::Text.new() do |actor, filename|
   actor.user.save filename, save
+  actor.tell "Game saved."
 end
 
 meta :restore do |actor|

data/scripts/snapshots.plot.rb

@@ -7,7 +7,7 @@ end
 last_snapshot = nil
 
 on_player_ready do |actor|
-  if (actor.last_order.nil? or !actor.last_order.action.meta?) and !last_snapshot.nil?
+  if (actor.last_action.nil? or !actor.last_action.meta?) and !last_snapshot.nil?
     Snapshots.history.push last_snapshot
   end
   last_snapshot = save

data/scripts/standard.plot.rb

@@ -3,10 +3,10 @@
 # interactive fiction. Designed to be suitable for parser-based text
 # adventures, but easily extensible for other formats.
 
+script 'standard/queries'
 script 'standard/use'
 script 'standard/modules'
 script 'standard/direction'
 script 'standard/entities'
-script 'standard/queries'
 script 'standard/actions'
 script 'standard/pathfinder'

data/scripts/standard/actions/close.plot.rb

@@ -2,11 +2,11 @@ respond :close, Query::Text.new() do |actor, string|
   actor.tell "#{you.pronoun.Subj} #{you.contract you.verb.do + ' not'} see any \"#{string}\" here."
 end
 
-respond :close, Query::Reachable.new() do |actor, thing|
+respond :close, Use.reachable() do |actor, thing|
   actor.tell "#{you.pronoun.Subj} #{you.contract you.verb.can + ' not'} close #{the thing}."
 end
 
-respond :close, Query::Reachable.new(Gamefic::Openable) do |actor, container|
+respond :close, Use.reachable(Openable) do |actor, container|
   if !container.open?
     actor.tell "It's already closed."
   else

data/scripts/standard/actions/drop.plot.rb

@@ -1,5 +1,9 @@
-respond :drop, Query::Visible.new() do |actor, thing|
-  actor.tell "#{you.contract you.pronoun.Subj + ' ' + you.verb.be} not carrying #{the thing}."
+respond :drop, Use.family() do |actor, thing|
+  if thing.parent != actor
+    actor.tell "#{you.contract you.pronoun.Subj + ' ' + you.verb.be} not carrying #{the thing}."
+  else
+    actor.proceed
+  end
 end
 
 respond :drop, Query::Children.new() do |actor, thing|

data/scripts/standard/actions/give.plot.rb

@@ -1,21 +1,8 @@
-respond :give, Query::Reachable.new(Character), Query::Reachable.new do |actor, character, gift|
-  if gift.parent != actor
-    actor.perform :take, gift
-  end
-  if gift.parent == actor
-    actor.perform :give, character, gift
-  end
-end
-
-respond :give, Query::Reachable.new, Query::Children.new do |actor, character, gift|
+respond :give, Use.available, Query::Children.new do |actor, character, gift|
   actor.tell "Nothing happens."
 end
 
-respond :give, Query::Reachable.new, Query::Reachable.new do |actor, character, gift|
-  actor.tell "#{you.pronoun.Subj} #{you.contract(you.verb.do + ' not')} have #{the gift}."
-end
-
-respond :give, Query::Reachable.new(Character), Query::Children.new do |actor, character, gift|
+respond :give, Use.available(Character), Use.available do |actor, character, gift|
   if gift.sticky?
     actor.tell gift.sticky_message || "#{you.pronoun.Subj} #{you.verb.need} to keep #{the gift} for now."
   else
@@ -23,8 +10,16 @@ respond :give, Query::Reachable.new(Character), Query::Children.new do |actor, c
   end
 end
 
-respond :give, Query::Text.new, Query::Children.new do |actor, character, gift|
+respond :give, Use.available(Character), Use.available do |actor, character, gift|
+  if gift.parent == actor
+    actor.proceed
+  else
+    actor.tell "#{you.pronoun.Subj} #{you.contract(you.verb.do + ' not')} have #{the gift}."
+  end
+end
+
+respond :give, Use.text, Use.available do |actor, character, gift|
   actor.tell "#{you.pronoun.Subj} #{you.contract(you.verb.do + ' not')} see any \"#{character}\" here."
 end
 
-xlate "give :gift to :character", "give :character :gift"
+interpret "give :gift to :character", "give :character :gift"