gamefic-sdk 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35c508e4dd9e43547d441742324b0cc6b0ec4a65
-  data.tar.gz: 0f27b939bb4792bfb2089d60fe501d390db3cdad
+  metadata.gz: 7395294d50944bd37c3f1876c55c6a946bbcf9ee
+  data.tar.gz: fdf9b3cbb95019b3279687b987522edc0ff3794f
 SHA512:
-  metadata.gz: 7ad44738b0f41716518caa6e47d17bf48246ff1adf9a8a5db34abc1c11e07b86d575007665ed748080dee9ff33e0e25de8b5b914f6bf97afd6032f1d8a99830b
-  data.tar.gz: 68f1a505049cd573c61c611247f89a85cfae8d50c2abc82dbe39acedd16c41a04103383bf5be371a7920ac059aad321236cd4520a9840f80026e0f4095918c0e
+  metadata.gz: b760a05656461913ac13ce5623c21c30ab8918e8afe822d3365811cb10d0e011064f4e4b7c6055d20c79586dfd395c2b9cfc3b771553d558dcd84cec17091f20
+  data.tar.gz: 86b311a43a5658c4fad44f8180c56ab5b1b32b5312aa3172d652a890d2c86f07c116010ee0272ddee200a1285df089ee69decabd7d5d21919ea26685a7d108c4

data/html/core/engine.js

@@ -1,45 +1,114 @@
 var Gamefic = (function() {
 	var updateCallbacks = [];
 	var startCallbacks = [];
+	var loggingUrl = null;
+	var logId = null;
+	var logAlias = null;
+	var lastPrompt = null;
+	var lastInput = null;
+
+	var _start = function() {
+		startCallbacks.forEach((callback) => {
+			callback();
+		});
+		Opal.gvars.engine.$run();
+	}
+
+	var _canLog = function() {
+		if (!loggingUrl) {
+			return false;
+		}
+		var a = document.createElement('a');
+		a.href = loggingUrl;
+		return (a.host == window.location.host);
+	}
+
+	var _logAlias = function(name) {
+		logAlias = name || logAlias || 'anonymous';
+		return logAlias;
+	}
 	return {
+		enableLogging: function(url) {
+			loggingUrl = url || '//gamefic.com/game/log';
+			return loggingUrl;
+		},
+
+		logAlias: function(name) {
+			return _logAlias(name);
+		},
+
+		canLog: function() {
+			return _canLog();
+		},
+
 		start: function() {
-			startCallbacks.forEach((callback) => {
-				callback();
-			});
-			Opal.gvars.engine.$run();
+			if (loggingUrl) {
+				if (_canLog()) {
+					$.post(loggingUrl, { alias: _logAlias() }, function(response) {
+						logId = response.id;
+						_start();
+					}).fail(function(response) {
+						console.warn('Logging failed.');
+						console.warn(response);
+						_start();
+					});
+				} else {
+					console.warn('Logging was not activated for ' + loggingUrl);
+					_start();
+				}
+			} else {
+				_start();
+			}
 		},
-		update: function(response) {
-			console.log('Called the Gamefic update');
-			var state = JSON.parse(response);
-			console.log('Output: ' + state.output);
+
+		update: function(json) {
+			var state = JSON.parse(json);
+			state.last_prompt = lastPrompt;
+			state.last_input = lastInput;
+			if (logId) {
+				$.post(loggingUrl + '/' + logId + '.json', { _method: 'PUT', state: state }, function(response) {
+
+				}).fail(function(response) {
+					console.warn('Logging update failed.');
+					console.warn(response);
+					logId = null;
+				});
+			}
 			updateCallbacks.forEach(function(callback) {
 				callback(state);
 			});
+			lastPrompt = state.prompt;
 		},
+
 		receive: function(input) {
+			lastInput = input;
 			Opal.gvars.engine.$receive(input);
 		},
+
 		onStart: function(callback) {
 			startCallbacks.push(callback);
 		},
+
 		onUpdate: function(callback) {
 			updateCallbacks.push(callback);
 		},
+
 		save: function(filename, data) {
-			var json = Opal.JSON.$generate(data);
-			localStorage.setItem(filename, json);
-			Opal.GameficOpal.$static_character().$tell('Game saved.');
+			localStorage.setItem(filename, Opal.JSON.$generate(data));
 		},
+
 		restore: function(filename) {
-			var data = Opal.JSON.$parse(localStorage.getItem(filename));
-			var metadata = data.$fetch('metadata');
-			// HACK Converting hashes to strings for JavaScript comparison
-			if (metadata.$to_s() != Opal.GameficOpal.$static_plot().$metadata().$to_s()) {
-				Opal.GameficOpal.$static_character().$tell('The saved data is not compatible with this version of the game.');
-				return Opal.nil;
-			} else {
-				return data;
-			}
+			var json = localStorage.getItem(filename);
+			var snapshot = Opal.JSON.$parse(json);
+			Opal.gvars.plot.$restore(snapshot);
+			Opal.gvars.engine.$user().$character().$flush();
+			Opal.gvars.engine.$user().$character().$cue(Opal.gvars.plot.$default_scene());
+			Opal.gvars.plot.$update();
+			Opal.gvars.plot.$ready();
+			Opal.gvars.engine.$user().$character().$tell('Game restored to last available turn.');
+			var state = Opal.gvars.engine.$user().$character().$state();
+			var json = state.$to_json();
+			this.update(json);
 		}
 	}
 })();

data/html/sinatra/engine.js

@@ -2,6 +2,18 @@ var Gamefic = (function() {
 	var startCallbacks = [];
 	var updateCallbacks = [];
 	return {
+		enableLogging: function() {
+
+		},
+
+		logAlias: function() {
+
+		},
+
+		canLog: function() {
+			return false;
+		},
+
 		start: function() {
 			var that = this;
       $.post('/start', function(response) {
@@ -11,41 +23,43 @@ var Gamefic = (function() {
 				that.update(response);
       });
 		},
+
 		update: function(response) {
 			updateCallbacks.forEach(function(callback) {
 				callback(response);
 			});
 		},
+
 		receive: function(input) {
 			var that = this;
 			$.post('/update', {command: input}, function(response) {
-				console.log(JSON.stringify(response));
 				that.update(response);
 			}).fail(function(response) {
 				console.log('An error occurred');
 			});
 		},
+
 		onUpdate: function(callback) {
 			updateCallbacks.push(callback);
 		},
+
 		onStart: function(callback) {
 			updateCallbacks.push(callback);
 		},
+
 		save: function(filename, data) {
-			var json = Opal.JSON.$generate(data);
-			localStorage.setItem(filename, json);
-			Opal.GameficOpal.$static_character().$tell('Game saved.');
+			console.log('Saving ' + data);
+			localStorage.setItem(filename, data);
 		},
+
 		restore: function(filename) {
-			var data = Opal.JSON.$parse(localStorage.getItem(filename));
-			var metadata = data.$fetch('metadata');
-			// HACK Converting hashes to strings for JavaScript comparison
-			if (metadata.$to_s() != Opal.GameficOpal.$static_plot().$metadata().$to_s()) {
-				Opal.GameficOpal.$static_character().$tell('The saved data is not compatible with this version of the game.');
-				return Opal.nil;
-			} else {
-				return data;
-			}
+			var json = localStorage.getItem(filename);
+			var data = JSON.parse(json);
+			var that = this;
+			$.post('/restore', {snapshot: JSON.stringify(data)}, function(response) {
+				console.log('Restored a snapshot.');
+				that.update(response);
+			});
 		}
 	}
 })();

data/html/skins/hypertext/index.html

@@ -81,7 +81,6 @@
 							});
 							$('#objects a, #incidentals a').each(function() {
 								var name = $(this).text().replace(/^(a |an |the )/i, '');
-								console.log('Object: ' + name);
 								var regexp = new RegExp(name, 'g');
 								var command = $(this).attr('data-command');
 								html.find('*').each(function() {
@@ -93,7 +92,6 @@
 							});
 							$('#portals a').not('.disabled').each(function() {
 								var name = $(this).attr('id').replace(/^(a |an |the )/i, '');
-								console.log('Object: ' + name);
 								var regexp = new RegExp(name, 'g');
 								var command = $(this).attr('data-command');
 								html.find('*').each(function() {

data/html/skins/standard/play.js

@@ -7,78 +7,12 @@ $(function() {
 		$('#gamefic_command').val('');
 		$('#gamefic_controls').removeClass('working');
 	});
-	/*Gamefic.onStart(function(response) {
-		var prompt = response.prompt;
-		if (prompt == '>') {
-			prompt = 'What do you want to do?'
-		}
-		$('#gamefic_prompt').html(prompt);
-		$('#gamefic_output a[rel="gamefic"]').addClass('disabled');
-	});
-	Gamefic.onInput(function(response) {
-		if (response.input != null) {
-			$('#gamefic_output').append('<p><kbd>' + response.prompt + ' ' + response.input + '</kbd></p>');
-		}
-		$('#gamefic_controls').addClass('working');
-	});
-	Gamefic.onFinish(function(response) {
-		if (!response.busy) {
-			$('#gamefic_controls').removeClass('working');
-		}
-		$('#gamefic_command').val('');
-		$('#gamefic_command').focus();
-		var outputElement = document.getElementById('gamefic_output');
-		$('#gamefic_output').animate({
-			scrollTop: outputElement.scrollHeight
-		}, 500);
-	});
-	Gamefic.handleResponse('Active', function(response) {
-		$('#gamefic_output').append(response.output);
-	});
-	Gamefic.handleResponse('YesOrNo', function(response) {
-		$('#gamefic_output').append(response.output);
-		$('#gamefic_output').append('<p>(<a href="#" rel="gamefic" data-command="yes">Yes</a> or <a href="#" rel="gamefic" data-command="no">No</a>)</p>');
-	});
-	Gamefic.handleResponse('MultipleChoice', function(response) {
-		var jq = $('<div/>');
-		jq.html(response.output);
-		jq.find('ol.multiple_choice li').each(function() {
-			var item = $(this).text();
-			var link = $('<a/>');
-			link.attr('href', '#');
-			link.attr('rel', 'gamefic');
-			link.attr('data-command', item);
-			link.text(item);
-			$(this).html(link);
-		});
-		$('#gamefic_output').append(jq);
-	});
-	Gamefic.handleResponse('Conclusion', function(response) {
-		if (response.input != null) {
-			$('#gamefic_output').append('<p><kbd>' + response.prompt + ' ' + response.input + '</kbd></p>');
-		}
-		$('#gamefic_console').addClass('concluded');
-		$('#gamefic_output').append(response.output);
-		$('#gamefic_controls').hide();
-	});
-	$('#gamefic_output').on('click', 'a[rel="gamefic"]', function(event) {
-		event.preventDefault();
-		if (!$(this).hasClass('disabled')) {
-			Gamefic.update($(this).attr('data-command'));
-		}
-	});*/
 	Gamefic.onUpdate((state) => {
-		console.log('Doing the update with ' + state['output']);
-		console.log(JSON.stringify(state));
 		$('#gamefic_output').append(state['output']);
 		if (state.scene == 'Conclusion') {
 			$('#gamefic_console').addClass('concluded');
 		}
 	});
-	console.log('Starting Gamefic');
 	Gamefic.start();
-	//console.log('Started!');
 	$('#gamefic_controls').removeClass('working');
-	//$('#gamefic_command').focus();
-	console.log('finished play');
 });

data/lib/gamefic-sdk.rb

@@ -1,11 +1,12 @@
 require 'gamefic'
 require 'gamefic-sdk/platform'
-require 'gamefic-sdk/plot_config'
+#require 'gamefic-sdk/plot_config'
 require 'gamefic-sdk/debug'
 require 'gamefic-sdk/version'
 
 module Gamefic::Sdk
   autoload :Server, 'gamefic-sdk/server'
+  autoload :Config, 'gamefic-sdk/config'
 
   HTML_TEMPLATE_PATH = File.realpath(File.dirname(__FILE__) + "/../html/")
   GLOBAL_SCRIPT_PATH = File.realpath(File.dirname(__FILE__) + "/../scripts/")

data/lib/gamefic-sdk/build.rb

@@ -4,34 +4,26 @@ module Gamefic::Sdk
 
   module Build
     def self.release directory, quiet = false
-      config = YAML.load(File.read(File.join(directory, 'config.yaml')))
-      uuid_file = File.join(directory, '.uuid')
-      if File.file?(uuid_file)
-        config['uuid'] = File.read(uuid_file).strip
+      config = Gamefic::Sdk::Config.load(directory)
+      if config.auto_import?
+        puts "Importing scripts..."
+        Shell.start ['import', directory, '--quiet']
       end
-      build_file = File.join(directory, 'build.yaml')
-      platforms = YAML.load(File.read(build_file))
-      platforms.each_pair { |k, v|
-        v['name'] = k
-        cls = Gamefic::Sdk::Platform.const_get(v['platform'])
-        plat = cls.new(directory, v)
+      config.targets.each_pair { |k, v|
         puts "Building #{k}..." unless quiet
+        plat = Gamefic::Sdk::Platform.load(config, k)
         plat.build
       }
-      puts "Build#{platforms.length > 1 ? 's' : ''} complete." unless quiet
+      puts "Build#{config.targets.length > 1 ? 's' : ''} complete." unless quiet
     end
     def self.clean directory
-      build_file = File.join(directory, 'build.yaml')
-      config = YAML.load(File.read(build_file))
-      config.each_pair { |k, v|
-        v['name'] = k
+      config = Gamefic::Sdk::Config.load(directory)
+      config.targets.each_pair { |k, v|
         puts "Cleaning #{k}..."
-        build_dir = "#{directory}/build/#{k}"
-        platform_dir = File.join(directory, "release", k)
-        cls = Gamefic::Sdk::Platform.const_get(v['platform'])
-        plat = cls.new(directory, v)
+        plat = Gamefic::Sdk::Platform.load(config, k)
         plat.clean
       }
+      puts "Done."
     end
   end
 

data/lib/gamefic-sdk/config.rb

@@ -0,0 +1,126 @@
+require 'yaml'
+require 'pathname'
+
+module Gamefic
+  module Sdk
+    class Config
+      attr_reader :source_dir
+      attr_reader :data
+
+      def initialize directory, data = {}
+        @source_dir = directory
+        @data = data
+
+        @source_dir.freeze
+        @data.freeze
+      end
+
+      # The game's title.
+      #
+      # @return [String]
+      def title
+        @title ||= (data['title'] || 'Untitled')
+      end
+
+      # The game's author.
+      #
+      # @return [String]
+      def author
+        @author ||= (data['author'] || 'Anonymous')
+      end
+
+      # The absolute path to the project's script directory.
+      #
+      # @return [String]
+      def script_path
+        @script_paths ||= Pathname.new(source_dir).join(data['script_path'] || './scripts').to_s
+      end
+
+      # The absolute path to the project's import directory.
+      #
+      # @return [String]
+      def import_path
+        @import_paths ||= Pathname.new(source_dir).join(data['import_path'] || './imports').to_s
+      end
+
+      # The absolute path to the project's media directory.
+      #
+      # @return [String]
+      def media_path
+        @media_path ||= Pathname.new(source_dir).join(data['media_path'] || './media').to_s
+      end
+
+      # The absolute path to the project's build directory.
+      #
+      # @return [String]
+      def build_path
+        @build_path ||= Pathname.new(source_dir).join(data['build_path'] || './build').to_s
+      end
+
+      # The absolute path to the project's release directory.
+      #
+      # @return [String]
+      def release_path
+        @release_path ||= Pathname.new(source_dir).join(data['release_path'] || './release').to_s
+      end
+
+      def auto_import?
+        @auto_import ||= (data['auto_import'] || true)
+      end
+
+      # A hash of each target's name and its configuration options.
+      #
+      # @return [Hash]
+      def targets
+        @targets ||= (data['targets'] || {})
+      end
+
+      # A universal unique identifier for the project.
+      #
+      # @return [String]
+      def uuid
+        if @uuid.nil?
+          if File.file?(File.join source_dir, '.uuid')
+            @@uuid = File.read(File.join source_dir, '.uuid').strip
+          end
+        end
+        @uuid
+      end
+
+      # @return [Gamefic::Sdk::Config]
+      def self.load directory
+        config = {}
+        ['config.yml', 'config.yaml'].each do |cy|
+          config_file = File.join(directory, cy)
+          if File.exist?(config_file)
+            config = YAML.load(File.read(config_file))
+            break
+          end
+        end
+        Config.new(directory, config)
+      end
+
+      def self.generate author = 'Anonymous', title = 'Untitled'
+<<-EOS
+title: #{title}
+author: #{author}
+
+script_path: ./scripts
+import_path: ./imports
+media_path: ./media
+
+build_path: ./build
+release_path: ./release
+
+targets:
+  web:
+    platform: Web
+    html: ./html
+  gfic:
+    platform: Gfic
+    filename: game.gfic
+EOS
+      end
+    end
+  end
+end