gamefic-sdk 1.6.0 → 1.7.0

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

@@ -2,54 +2,54 @@ require 'erb'
 
 module Gamefic
   module Sdk
-		class Gamefic::Sdk::Platform::Web::AppConfig
-		  include Plot::Theater
-		  attr_reader :javascripts, :stylesheets, :resource_paths, :source_dir, :config, :html_dir
-		  #expose :javascripts, :stylesheets, :resource_paths
-		  
-		  # @param source_dir [String] The directory containing the resources (config file, HTML template, etc.) for this build
-		  def initialize source_dir, config, js
-		    @javascripts = []
-		    @stylesheets = []
-		    @source_dir = source_dir
-		    @config = config
-		    @html_dir = resolve_html_dir
-		    @game_config = PlotConfig.new("#{source_dir}/config.yaml")
-		    @resource_paths = ["#{html_dir}", Gamefic::Sdk::HTML_TEMPLATE_PATH]
-		    config_file = "#{html_dir}/index.rb"
-		    stage File.read(config_file), config_file
-		    javascripts.concat js
-		  end
-		  
-		  # @return [BuildConfig::Data]
-		  def data
-		    Data.new @game_config, @javascripts, @stylesheets
-		  end
-		  
-		  # Render HTML using the build config data
-		  #
-		  # @return [String] The resulting HTML
-		  def render
-		    erb = ERB.new(File.read(html_dir + "/index.html.erb"))
-		    erb.result data.get_binding
-		  end
-		  
-		  private
-		  
-		  def resolve_html_dir
-		    dir = "#{source_dir}/html"
-		    if !File.directory?(dir) and config['html_skin'].to_s != ''
-		      dir = "#{Gamefic::Sdk::HTML_TEMPLATE_PATH}/skins/#{config['html_skin']}"
-		    end
-		    if !File.directory?(dir)
-		      dir = "#{Gamefic::Sdk::HTML_TEMPLATE_PATH}/skins/minimal"
-		    end
-		    if !File.directory?(dir)
-		      raise "Could not resolve HTML directory"
-		    end
-		    dir
-		  end
-		end
+    class Gamefic::Sdk::Platform::Web::AppConfig
+      include Plot::Theater
+      attr_reader :javascripts, :stylesheets, :resource_paths, :source_dir, :config, :html_dir
+      #expose :javascripts, :stylesheets, :resource_paths
+      
+      # @param source_dir [String] The directory containing the resources (config file, HTML template, etc.) for this build
+      def initialize source_dir, config, js
+        @javascripts = []
+        @stylesheets = []
+        @source_dir = source_dir
+        @config = config
+        @html_dir = resolve_html_dir
+        #@game_config = PlotConfig.new("#{source_dir}/config.yaml")
+        @resource_paths = ["#{html_dir}", Gamefic::Sdk::HTML_TEMPLATE_PATH]
+        config_file = "#{html_dir}/index.rb"
+        stage File.read(config_file), config_file
+        javascripts.concat js
+      end
+      
+      # @return [BuildConfig::Data]
+      def data
+        Data.new config, @javascripts, @stylesheets
+      end
+      
+      # Render HTML using the build config data
+      #
+      # @return [String] The resulting HTML
+      def render
+        erb = ERB.new(File.read(html_dir + "/index.html.erb"))
+        erb.result data.get_binding
+      end
+      
+      private
+      
+      def resolve_html_dir
+        dir = "#{source_dir}/html"
+        if !File.directory?(dir) and config.data['html_skin'].to_s != ''
+          dir = "#{Gamefic::Sdk::HTML_TEMPLATE_PATH}/skins/#{config['html_skin']}"
+        end
+        if !File.directory?(dir)
+          dir = "#{Gamefic::Sdk::HTML_TEMPLATE_PATH}/skins/standard"
+        end
+        if !File.directory?(dir)
+          raise "Could not resolve HTML directory"
+        end
+        dir
+      end
+    end
   end
 end
 

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

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

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

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

data/lib/gamefic-sdk/server.rb

@@ -6,23 +6,21 @@ module Gamefic
 
     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'
+        config = Gamefic::Sdk::Config.load(settings.source_dir)
+        paths = [config.script_path, config.import_path, Gamefic::Sdk::GLOBAL_SCRIPT_PATH]
         @@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)
+        #@@plot.script 'debug'
+        sinatra = Gamefic::Sdk::Platform::Sinatra.new(config: config)
         sinatra.build
-        File.read File.join(sinatra.config['target_dir'], 'index.html')
+        File.read File.join(sinatra.release_target, '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
+        @@character = @@plot.player_class.new(name: 'player', synonyms: 'me myself self you yourself', description: 'As good-looking as ever.')
         @@plot.introduce @@character
         @@plot.ready
         @@character.state.to_json
@@ -36,6 +34,16 @@ module Gamefic
         @@character.state.merge(input: params['command']).to_json
       end
 
+      post '/restore' do
+        content_type :json
+        snapshot = JSON.parse(params['snapshot'], symbolize_names: true)
+        @@plot.restore snapshot
+        @@character.cue @@plot.default_scene
+        @@plot.update
+        @@plot.ready
+        @@character.state.to_json
+      end
+
       class << self
 
         def run!
@@ -51,16 +59,6 @@ module Gamefic
         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

data/lib/gamefic-sdk/shell.rb

@@ -9,7 +9,8 @@ module Gamefic
 
       map %w[--version -v] => :version
       map [:create, :new] => :init
-      
+      map ['scripts'] => :script
+
       desc "--version, -v", "Print the version"
       def version
         puts "gamefic-sdk #{Gamefic::Sdk::VERSION}"
@@ -58,31 +59,32 @@ module Gamefic
         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]
+      desc 'import [DIRECTORY_NAME]', 'Copy external scripts to the project'
+      option :quiet, type: :boolean, aliases: :q, desc: 'Suppress output'
+      def import(directory_name = '.')
+        config = Gamefic::Sdk::Config.load directory_name
+        FileUtils.remove_entry_secure config.import_path if File.exist?(config.import_path)
+        FileUtils.mkdir_p config.import_path
+        paths = [config.script_path, Gamefic::Sdk::GLOBAL_SCRIPT_PATH]
         plot = Gamefic::Sdk::Debug::Plot.new Source::File.new(*paths)
         plot.script 'main'
         plot.imported_scripts.each { |s|
+          next unless s.absolute_path.start_with?(Gamefic::Sdk::GLOBAL_SCRIPT_PATH)
           src = File.absolute_path(s.absolute_path)
-          dst = File.absolute_path(File.join(directory_name, 'scripts', "#{s.path}.plot.rb"))
+          dst = File.absolute_path(File.join(directory_name, 'imports', "#{s.path}.plot.rb"))
           next if src == dst
-          puts "Importing #{s.path}"
+          puts "Importing #{s.path}" unless options[:quiet]
           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 = '.')
-
+      desc 'default-config [DIRECTORY_NAME]', 'Create or overwrite config.yml with default values'
+      def default_config(directory_name = '.')
+        File.open(File.join(directory_name, 'config.yml'), 'w') do |file|
+          file << Gamefic::Sdk::Config.generate
+        end
+        puts "Default config.yml created."
       end
 
       desc 'webskins', 'List the available skins for the Web platform'
@@ -91,6 +93,56 @@ module Gamefic
           puts File.basename(d)
         }
       end
+
+      desc 'script [PATH]', 'List or document the scripts in the SDK'
+      def script path = nil
+        if path.nil?
+          s = []
+          Dir[File.join GLOBAL_SCRIPT_PATH, '**', '*.rb'].each { |f|
+            c = File.read(f)
+            c.each_line { |l|
+              match = l.match(/[\s]*#[\s]*@gamefic.script[ ]+([a-z0-9\/]+)/)
+              unless match.nil?
+                s.push(match[1])
+              end
+            }
+          }
+          puts s.sort.join("\n")
+        else
+          document_script path
+        end
+      end
+
+      private
+
+      def document_script path
+        f = File.join(GLOBAL_SCRIPT_PATH, "#{path}.plot.rb")
+        if File.exist?(f)
+          c = File.read(f)
+          doc = ''
+          in_comment = false
+          c.each_line { |l|
+            if in_comment
+              break unless l.start_with?('#')
+              doc += "#{l[2..-1]}"
+            else
+              match = l.match(/[\s]*#[\s]*@gamefic.script[ ]+([a-z0-9\/]+)/)
+              in_comment = true unless match.nil?
+            end
+          }
+          if in_comment
+            puts ''
+            puts path
+            puts ''
+            puts doc unless doc == ''
+            puts '' unless doc == ''
+          else
+            puts "Path '#{path}' is not documented."
+          end
+        else
+          puts "Script path '#{path}' does not exist."
+        end
+      end
     end
   end
 end

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

@@ -22,7 +22,6 @@ module Gamefic
           make_game_directories
           write_main_script
           write_test_script
-          write_build_yaml
           write_config_yaml
           write_uuid_file
           copy_html_skin
@@ -40,6 +39,7 @@ module Gamefic
           end
 
           Dir.mkdir(File.join(@directory, 'scripts'))
+          Dir.mkdir(File.join(@directory, 'imports'))
           Dir.mkdir(File.join(@directory, 'media'))
         end
 
@@ -58,25 +58,9 @@ module Gamefic
           end
         end
 
-        def write_build_yaml
-          File.open("#{@directory}/build.yaml", 'w') do |file|
-            file.puts "web:",
-            "  platform: Web",
-            "gfic:",
-            "  platform: Gfic",
-            "  filename: game.gfic"
-          end
-        end
-
         def write_config_yaml
-          File.open("#{@directory}/config.yaml", 'w') do |file|
-            file.puts "title: #{@title || 'Untitled'}",
-            "author: #{@author || 'Anonymous'}",
-            "",
-            "script_paths:",
-            "  - ./scripts",
-            "media_paths:",
-            "  - ./media"
+          File.open("#{@directory}/config.yml", 'w') do |file|
+            file << Gamefic::Sdk::Config.generate
           end
         end
 

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

@@ -1,4 +1,3 @@
-require 'gamefic-sdk/plot_config'
 require 'gamefic/engine/tty'
 
 module Gamefic
@@ -8,29 +7,25 @@ module Gamefic
         def initialize(directory:)
           @path = directory
           raise "Invalid path: #{@path}" unless File.exist?(@path)
-          puts "Loading..."
         end
 
         def run
-          paths = config_path.script_paths + [Gamefic::Sdk::GLOBAL_SCRIPT_PATH]
+          puts "Loading..."
+          config = Gamefic::Sdk::Config.new(@path)
+          if config.auto_import?
+            puts "Importing scripts..."
+            Shell.start ['import', @path, '--quiet']
+          end
+          paths = [config.script_path, config.import_path, Gamefic::Sdk::GLOBAL_SCRIPT_PATH]
           plot = Gamefic::Sdk::Debug::Plot.new Source::File.new(*paths)
           plot.script 'main'
-          plot.script 'debug'
+          # @todo Debug is temporarily disabled.
+          #plot.script 'debug'
           engine = Engine::Tty.new plot
           engine.connect
           puts "\n"
           engine.run
         end
-
-        private
-
-        def config_path
-          if File.directory?(@path)
-            PlotConfig.new File.join(@path, 'config.yaml')
-          else
-            PlotConfig.new
-          end
-        end
       end
     end
   end

data/lib/gamefic-sdk/version.rb

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

data/scripts/save-restore-undo.plot.rb

@@ -0,0 +1,25 @@
+# @gamefic.script save-restore-undo
+#   SAVE, RESTORE, and UNDO actions.
+
+script 'snapshots'
+
+respond :save do |actor|
+  snap = save
+  actor.user.save 'save.dat', snap
+  actor.tell "Game saved."
+end
+
+respond :restore do |actor|
+  actor.user.restore 'save.dat'
+  actor.tell "Game restored."
+end
+
+respond :undo do |actor|
+  snap = Snapshots.history.last
+  if snap.nil?
+    actor.tell "Nothing to undo."
+  else
+    restore snap
+    actor.tell "Last action undone."
+  end
+end