gamefic-sdk 2.5.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d5077a8c894877c7b1d5796e0bae8f22eba29232163f8bdd7b971c4f7d435c7
-  data.tar.gz: 21586177dedd557bdb616eacad0fe7c8280a52b0fb9225c2d8115c9ad748d7d0
+  metadata.gz: a65534f07f1678a5e82275ec3a8e8158e8d96096d4adcf8e1d4277ab8961a5dd
+  data.tar.gz: fd315e465a03350354a2c0f795088d63d14b16ec55a83a7025eef28dca35017f
 SHA512:
-  metadata.gz: 7953c0cf54322ab0d263f6c5100d71cf4b6e086cfff04cc47eb7282212f04eaeab431d67e2aab9eae1a2d438a2a0ef9bc0de8765e39f3f19b0b906de91a28583
-  data.tar.gz: 8fca0a40c79f530ecbc141ef44d0783795ceebab81d7612688bb2058f3ae62dd1ff9a6f1f9babab21659ca0ac7abbb041e33f3ceb0b0f8645256edc873af4f8b
+  metadata.gz: 452327933e7a5f43100f4331a324b77b45e585187d9f470e15c4c4fb4cf3414105551430e340c4ae07f9e9c73ff082444d6840940a039478282cf71f517e8193
+  data.tar.gz: 6f2dacd9c0f9273baebb359a25397ac5e3589c85ae1081a9e12d5472ee4f575d7edc6cab940654b2581ac75076bda01aaf92be56215707dbbcf37141e36c92a1

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 3.0.0 - January 27, 2024
+- Deprecate broken/redundant commands
+- Improved serialization
+- Queries use proxies for static entities
+- All scripted blocks get evaluated on stage
+- Use create-react-gamefic for web scaffolds
+- Modular projects and libraries
+- New project scaffold
+
 ## 2.5.0 - February 11, 2023
 - Update dependencies
 - Improve tests and examples

data/bin/console

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "gamefic/sdk"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gamefic-sdk"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/gamefic-sdk.gemspec

@@ -24,17 +24,17 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.7.0'
 
-  s.add_runtime_dependency 'gamefic', '~> 2.4'
-  s.add_runtime_dependency 'gamefic-standard', '~> 2.4'
-  s.add_runtime_dependency 'gamefic-tty', '~> 2.0', '>= 2.0.2'
+  s.add_runtime_dependency 'gamefic', '~> 3.0'
+  s.add_runtime_dependency 'gamefic-standard', '~> 3.0'
+  s.add_runtime_dependency 'gamefic-tty', '~> 3.0'
   s.add_runtime_dependency 'listen', '~> 3.0'
   s.add_runtime_dependency 'opal', '~> 1.1'
+  s.add_runtime_dependency 'puma', '~> 6'
   s.add_runtime_dependency 'sinatra', '~> 2'
   s.add_runtime_dependency 'thor', '~> 1.0'
 
   s.add_development_dependency 'bundler', '~> 2.0'
   s.add_development_dependency 'capybara', '~> 3.3'
-  s.add_development_dependency 'puma', '~> 6'
   s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'selenium-webdriver', '~> 4.2'

data/lib/gamefic-sdk/diagram.rb

@@ -3,6 +3,8 @@ require 'json'
 module Gamefic
   module Sdk
     class Diagram
+      DIAGRAMMABLE = %w[entities responses verbs syntaxes commands scenes].freeze
+
       class Position
         attr_accessor :x, :y
 
@@ -53,31 +55,28 @@ module Gamefic
       end
 
       def entities
-        plot.initial_state[:entities].map do |e|
-          e.transform_keys do |k|
-            str = k.to_s
-            if str.start_with?('@')
-              str[1..-1]
-            else
-              str
-            end
-          end
+        plot.entities.map do |ent|
+          {
+            name: ent.name,
+            type: ent.class,
+            parent: ent.parent&.name
+          }
         end
       end
 
-      def actions
-        plot.actions.map do |act|
+      def responses
+        plot.playbook.responses.map do |act|
           {
             verb: act.verb,
             meta: act.meta?,
-            signature: act.signature
+            # signature: act.signature
           }
         end
       end
 
       def commands
         {
-          actions: actions,
+          responses: responses,
           verbs: verbs,
           syntaxes: syntaxes
         }
@@ -92,14 +91,23 @@ module Gamefic
           {
             template: syn.template,
             command: syn.command,
-            first_word: syn.first_word,
+            synonym: syn.synonym,
             verb: syn.verb
           }
         end
       end
 
+      def scenes
+        plot.scenebook.scenes.map do |scene|
+          {
+            name: scene.name,
+            type: scene.type
+          }
+        end
+      end
+
       def valid? type
-        %w[rooms entities actions verbs syntaxes commands].include?(type)
+        DIAGRAMMABLE.include?(type)
       end
 
       private

data/lib/gamefic-sdk/scaffold.rb

@@ -8,8 +8,16 @@ module Gamefic
   module Sdk
     module Scaffold
       class Binder < OpenStruct
+        def camelcase string
+          string.split(/[_\s\-]+/).collect(&:capitalize).join
+        end
+
+        def snake_case string
+          string.split(/[_\s\-]+/).collect(&:downcase).join('_')
+        end
+
         def get_binding
-          binding()
+          binding
         end
       end
 
@@ -23,7 +31,7 @@ module Gamefic
 
       def custom_copy origin, destination, data
         FileUtils.mkdir_p File.dirname(destination)
-        if destination.end_with?('.gf.erb')
+        if origin.end_with?('.gf.erb')
           File.write destination[0..-8], render(origin, data)
         else
           FileUtils.cp_r origin, destination
@@ -33,18 +41,17 @@ module Gamefic
       def build name, destination
         dir = File.join(SCAFFOLDS_PATH, name)
         raise LoadError, "Scaffold `#{name}` does not exist" unless File.directory?(dir)
+
         path = Pathname.new('.').join(destination).realdirpath
         data = Binder.new(name: File.basename(path))
         files = Dir.glob(File.join(dir, '**', '*'), File::FNM_DOTMATCH).select { |entry| File.file?(entry) }
         map = {}
         files.each do |file|
-          rename = File.join(File.dirname(file), File.basename(file).gsub('__name__', data.name))
+          rename = File.join(File.dirname(file), File.basename(file)).gsub('__name__', data.name)
           dst = File.join(destination, rename[dir.length..-1])
-          if File.file?(dst)
-            raise "Gamefic generation would overwrite existing file #{rename}"
-          else
-            map[file] = dst
-          end
+          raise "Gamefic generation would overwrite existing file #{rename}" if File.file?(dst)
+
+          map[file] = dst
         end
         map.each_pair { |src, dst| custom_copy src, dst, data }
         system "cd #{Shellwords.escape(destination)} && bundle install"

data/lib/gamefic-sdk/server.rb

@@ -1,11 +1,12 @@
 require 'sinatra/base'
 require 'yaml'
+require 'puma'
 
 module Gamefic
   module Sdk
     class Server < Sinatra::Base
       set :port, 4342
-      set :server, :webrick
+      set :server, :puma
 
       get '/' do
         File.read File.join(settings.public_folder, 'index.html')
@@ -31,19 +32,18 @@ module Gamefic
       end
 
       get '/snapshot' do
-        content_type :json
-        @@plot.save.to_json
+        content_type :text
+        snapshot = @@plot.save
+        snapshot
       end
 
       post '/restore' do
         content_type :json
-        start_plot
         # The snapshot needs to be received as a JSON string because of issues
         # with IndifferentHash malforming arrays.
         snapshot = JSON.parse(params['snapshot'])
-        @@plot.restore snapshot
-        @@character.cue @@plot.default_scene
-        @@plot.update
+        @@plot = Gamefic::Plot.restore snapshot
+        @@character = @@plot.players.first
         @@plot.ready
         @@character.output.to_json
       end
@@ -52,7 +52,7 @@ module Gamefic
         reset_features
         load File.join(settings.source_dir, 'main.rb')
         @@plot = Gamefic::Plot.new
-        @@character = @@plot.get_player_character
+        @@character = @@plot.make_player_character
         @@plot.introduce @@character
         @@plot.ready
       end

data/lib/gamefic-sdk/tasks/common.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'pathname'
+require 'yaml'
 
 module Gamefic
   module Sdk
@@ -15,6 +18,18 @@ module Gamefic
         def absolute_path
           @absolute_path ||= Pathname.new(directory).realpath.to_s
         end
+
+        def plot_class
+          GAMEFIC_PLOT_CLASS
+        end
+
+        def string_to_constant string
+          space = Object
+          string.split('::').each do |part|
+            space = space.const_get(part)
+          end
+          space
+        end
       end
     end
   end

data/lib/gamefic-sdk/tasks/ruby.rb

@@ -16,7 +16,7 @@ module Gamefic
         #
         def run
           require_relative File.join(absolute_path, 'main')
-          Gamefic::Tty::Engine.run
+          Gamefic::Tty::Engine.run(plot: plot_class.new)
         end
 
         # Build a distributable Ruby app.
@@ -36,8 +36,8 @@ module Gamefic
             files[rel] = Base64.encode64(Zlib::Deflate.deflate(File.read(full)))
           end
           program = program_code(files)
-          FileUtils.mkdir_p File.join(absolute_path, 'builds', 'ruby')
-          File.write(File.join(absolute_path, 'builds', 'ruby', "#{File.basename(absolute_path)}.rb"), program)
+          FileUtils.mkdir_p File.join(absolute_path, 'ruby', 'build')
+          File.write(File.join(absolute_path, 'ruby', 'build', "#{File.basename(absolute_path)}.rb"), program)
         end
 
         private
@@ -89,7 +89,7 @@ Dir.mktmpdir do |tmp|
   require 'gamefic-tty'
   require 'main'
   puts "\n"
-  Gamefic::Tty::Engine.run
+  Gamefic::Tty::Engine.run(plot: #{plot_class}.new)
 end
 )
         end

data/lib/gamefic-sdk/tasks/web.rb

@@ -11,42 +11,36 @@ module Gamefic
         # Generate a web app using NPM.
         #
         def generate
-          Dir.chdir absolute_path do
-            nv = `npm -v`.strip
-            puts "Node version #{nv} detected. Preparing the web app..."
-            Gamefic::Sdk::Scaffold.build 'react', '.'
-            puts 'The web app scaffold is ready.'
-            puts 'Run `npm install` to download the dependencies.'
+          puts "Node version #{check_for_npm} detected. Preparing the web app..."
+          web_path = File.join(absolute_path, 'web')
+          FileUtils.mkdir_p web_path
+          Dir.chdir web_path do
+            name = File.basename(absolute_path)
+            system 'npx', 'react-gamefic', '--name', name, '--class', 'GAMEFIC_PLOT_CLASS'
+            puts 'The web app is ready.'
+            puts 'Run `rake web:run` to start the app in dev mode.'
           end
-        rescue Errno::ENOENT => e
-          STDERR.puts "#{e.class}: #{e.message}"
-          STDERR.puts "Web app generation requires Node (https://nodejs.org)."
         end
 
         # Run the web app in a server.
         #
         def run
           check_for_web_build
-          build_development
-          listener = Listen.to(File.join(absolute_path, 'web')) do |_mod, _add, _rem|
-            build_development
+          Dir.chdir File.join(absolute_path, 'web') do
+            system 'npm start'
           end
-          listener.start
-          # @todo Get the public folder from a config?
-          Gamefic::Sdk::Server.run! source_dir: absolute_path, public_folder: File.join(absolute_path, 'builds', 'web', 'development')
         end
 
         # Build a distributable web app using NPM.
         #
         def build
           check_for_web_build
-          Dir.chdir absolute_path do
-            pid = Process.spawn 'npm run build'
-            Process.wait pid
+          Dir.chdir File.join(absolute_path, 'web') do
+            system 'npm run build'
           end
         rescue Errno::ENOENT => e
-          STDERR.puts "#{e.class}: #{e.message}"
-          STDERR.puts "Web app building requires Node (https://nodejs.org)."
+          warn "#{e.class}: #{e.message}"
+          warn 'Web app building requires Node (https://nodejs.org).'
         end
 
         private
@@ -55,7 +49,7 @@ module Gamefic
         #
         # @return [Boolean]
         def web_build_exists?
-          File.exist?(File.join(absolute_path, 'package.json'))
+          File.exist?(File.join(absolute_path, 'web', 'package.json'))
         end
 
         # Check if a web build exists.
@@ -64,16 +58,18 @@ module Gamefic
         # @return [void]
         def check_for_web_build
           return if web_build_exists?
+
           puts 'This project does not appear to be configured for web builds.'
           puts 'Try running `rake web:generate` first.' if Rake::Task.task_defined?('web:generate')
           raise LoadError, 'package.json not found'
         end
 
-        def build_development
-          Dir.chdir absolute_path do
-            pid = Process.spawn('npm run develop')
-            Process.wait pid
-          end
+        def check_for_npm
+          `npm -v`.strip
+        rescue Errno::ENOENT => e
+          warn "#{e.class}: #{e.message}"
+          warn 'Web app generation requires Node (https://nodejs.org).'
+          raise
         end
       end
     end

data/lib/gamefic-sdk/tasks.rb

@@ -33,6 +33,7 @@ module Gamefic::Sdk::Tasks
 
   def define_task name, desc, &block
     return if Rake::Task.task_defined?(name)
+
     # @type [Rake::Task]
     task = Rake::Task.define_task(name, &block)
     task.add_description desc

data/lib/gamefic-sdk/version.rb

@@ -1,5 +1,5 @@
 module Gamefic
   module Sdk
-    VERSION = '2.5.0'
+    VERSION = '3.0.0'
   end
 end

data/scaffolds/library/__name__.gemspec.gf.erb

@@ -1,14 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/<%= name %>/version"
+
 Gem::Specification.new do |spec|
-  spec.name          = '<%= name %>'
-  spec.version       = '1.0.0'
-  spec.summary       = 'A Gamefic library'
-  spec.authors       = ['Anomynous']
-  spec.license       = 'MIT'
-  spec.files         = Dir['lib/**/*.rb']
-
-  spec.add_runtime_dependency 'gamefic', '~> 2.0'
-  spec.add_runtime_dependency 'gamefic-standard', '~> 2.0'
-
-  spec.add_development_dependency 'gamefic-sdk', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.name = "<%= name %>"
+  spec.version = <%= camelcase(name) %>::VERSION
+  spec.authors = ["TODO: Author name(s)"]
+  spec.email = ["TODO: Author email(s)"]
+
+  spec.summary = "TODO: Write a short summary, because RubyGems requires one."
+  spec.description = "TODO: Write a longer description or delete this line."
+  spec.homepage = "TODO: Put your gem's website or public repo URL here."
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'gamefic', '~> 3.0'
+  spec.add_dependency 'gamefic-standard', '~> 3.0'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
 end

data/scaffolds/library/lib/__name__/version.rb.gf.erb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module <%= camelcase(name) %>
+  VERSION = '0.1.0'
+end

data/scaffolds/library/lib/__name__.rb.gf.erb

@@ -0,0 +1,10 @@
+require 'gamefic'
+require 'gamefic-standard'
+require '<%= name %>/version'
+
+module %<= camelcase(name) %>
+  extend Gamefic::Scriptable
+  include Gamefic::Standard
+
+  # Game code goes here
+end

data/scaffolds/project/README.md.gf.erb

@@ -14,7 +14,7 @@ A Gamefic game project
 
     $ rake ruby:build
 
-The script will be saved in the `builds/ruby` directory.
+The script will be saved in the `ruby/build` directory.
 
 ## Web-Based Games
 
@@ -37,7 +37,7 @@ Open http://localhost:4342 in a browser.
 
     $ rake web:build
 
-The application will be saved in the `builds/web/production` directory.
+The application will be saved in the `web/build` directory.
 
 ## More Information
 

data/scaffolds/project/__name__/plot.rb.gf.erb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module <%= camelcase(name) %>
+  # The main plot.
+  #
+  class Plot < Gamefic::Plot
+    UUID = 'fe5d62a7-7036-45c0-b5cb-39c336bf1b5a'
+
+    include Gamefic::Standard
+
+    script do
+      introduction do |actor|
+        actor.tell "Hello, world!"
+      end
+    end
+  end
+end

data/scaffolds/project/__name__/subplot.rb.gf.erb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module <%= camelcase(name) %>
+  # The base subplot.
+  #
+  # Authors should extend subclasses to create subplots that the plot can
+  # branch.
+  #
+  class Subplot < Gamefic::Subplot
+    include Gamefic::Standard.no_scripts
+  end
+end

data/scaffolds/project/main.rb.gf.erb

@@ -1,9 +1,10 @@
-GAMEFIC_UUID = '<%= SecureRandom.uuid %>'
+# frozen_string_literal: true
+
 require 'gamefic'
 require 'gamefic-standard'
 
-Gamefic.script do
-  introduction do |actor|
-    actor.tell "Hello, world!"
-  end
-end
+require_relative '<%= name %>/plot'
+require_relative '<%= name %>/subplot'
+
+# The Gamefic SDK uses this constant to select the main Plot for game engines.
+GAMEFIC_PLOT_CLASS = <%= camelcase(name) %>::Plot

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamefic-sdk
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-11 00:00:00.000000000 Z
+date: 2024-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gamefic
@@ -16,48 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: gamefic-standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: gamefic-tty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -142,20 +150,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
-- !ruby/object:Gem::Dependency
-  name: puma
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -245,26 +239,15 @@ files:
 - scaffolds/library/Gemfile
 - scaffolds/library/README.md.gf.erb
 - scaffolds/library/__name__.gemspec.gf.erb
-- scaffolds/library/lib/__name__.rb
+- scaffolds/library/lib/__name__.rb.gf.erb
+- scaffolds/library/lib/__name__/version.rb.gf.erb
 - scaffolds/project/.gitignore
 - scaffolds/project/Gemfile
 - scaffolds/project/README.md.gf.erb
 - scaffolds/project/Rakefile
+- scaffolds/project/__name__/plot.rb.gf.erb
+- scaffolds/project/__name__/subplot.rb.gf.erb
 - scaffolds/project/main.rb.gf.erb
-- scaffolds/react/.babelrc
-- scaffolds/react/package.json.gf.erb
-- scaffolds/react/web/public/index.html.gf.erb
-- scaffolds/react/web/src/driver/development.js
-- scaffolds/react/web/src/driver/opal.rb
-- scaffolds/react/web/src/driver/production.js
-- scaffolds/react/web/src/index.js
-- scaffolds/react/web/src/scenes/Activity.jsx
-- scaffolds/react/web/src/scenes/Conclusion.jsx
-- scaffolds/react/web/src/scenes/MultipleChoice.jsx
-- scaffolds/react/web/src/scenes/Pause.jsx
-- scaffolds/react/web/src/scenes/index.js
-- scaffolds/react/web/src/style.css
-- scaffolds/react/webpack.config.js
 homepage: http://gamefic.com
 licenses:
 - MIT

data/scaffolds/library/lib/__name__.rb

@@ -1,5 +0,0 @@
-require 'gamefic-standard'
-
-Gamefic.script do
-  # Game code goes here
-end

data/scaffolds/react/.babelrc

@@ -1,3 +0,0 @@
-{
-	"presets" : ["@babel/preset-env", "@babel/preset-react"]
-}

data/scaffolds/react/package.json.gf.erb

@@ -1,34 +0,0 @@
-{
-  "name": "<%= name %>",
-  "version": "1.0.0",
-  "description": "A Gamefic web app",
-  "keywords": [],
-  "author": "Anonymous",
-  "license": "UNLICENSED",
-  "private": true,
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "webpack --mode production",
-    "develop": "webpack --mode development"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.12.0",
-    "babel-loader": "^8.2.2",
-    "@babel/preset-env": "^7.12.10",
-    "@babel/preset-react": "^7.12.10",
-    "copy-webpack-plugin": "^7.0.0",
-    "css-loader": "^5.0.1",
-    "file-loader": "^6.2.0",
-    "opal-webpack-bundler": "^0.0.1",
-    "style-loader": "^0.23.1",
-    "url-loader": "^4.1.1",
-    "webpack": "^5.10.1",
-    "webpack-cli": "^4.2.0"
-  },
-  "dependencies": {
-    "gamefic-driver": "^0.2.1",
-    "react": "^16.5.2",
-    "react-dom": "^16.5.2",
-    "react-gamefic": "^0.5.0"
-  }
-}

data/scaffolds/react/web/public/index.html.gf.erb

@@ -1,11 +0,0 @@
-<!DOCTYPE html>
-<html>
-	<head>
-	  <meta charset="utf-8">
-	  <title><%= name %></title>
-	</head>
-	<body>
-		<div id="root" />
-	  <script src="bundle.js" type="text/javascript"></script>
-	</body>
-</html>

data/scaffolds/react/web/src/driver/development.js

@@ -1,4 +0,0 @@
-import { WebDriver } from 'gamefic-driver';
-
-const driver = new WebDriver('http://localhost:4342');
-export { driver };

data/scaffolds/react/web/src/driver/opal.rb

@@ -1,7 +0,0 @@
-require 'opal'
-require 'gamefic'
-require 'main'
-
-$plot = Gamefic::Plot.new
-$character = $plot.get_player_character
-$plot.introduce $character

data/scaffolds/react/web/src/driver/production.js

@@ -1,5 +0,0 @@
-import './opal.rb';
-import { OpalDriver } from 'gamefic-driver';
-  
-const driver = new OpalDriver(Opal);
-export { driver };

data/scaffolds/react/web/src/index.js

@@ -1,28 +0,0 @@
-import React from 'react';
-import { render } from 'react-dom';
-import { Console, Terminal } from 'react-gamefic';
-
-import { driver } from 'driver';
-
-import { Activity, Pause, MultipleChoice, Conclusion } from './scenes';
-import 'react-gamefic/styles/ebook';
-import './style.css';
-
-const sceneComponents = {
-	Activity: Activity,
-	Pause: Pause,
-	MultipleChoice: MultipleChoice,
-	YesOrNo: MultipleChoice,
-	Conclusion: Conclusion
-}
-
-render(
-	<Console driver={driver}>
-		<Terminal sceneComponents={sceneComponents} autoScroll={true} />
-	</Console>,
-	document.getElementById('root')
-);
-
-driver.start().then((state) => {
-	driver.notify(state);
-});

data/scaffolds/react/web/src/scenes/Activity.jsx

@@ -1,13 +0,0 @@
-import React from 'react';
-import { ActivityScene, Output, CommandForm } from 'react-gamefic';
-
-export class Activity extends React.Component {
-	render() {
-		return (
-			<ActivityScene>
-				<Output {...this.props} transcribe={true} />
-				<CommandForm prompt={this.props.state.prompt} />
-			</ActivityScene>
-		);
-	}
-}

data/scaffolds/react/web/src/scenes/Conclusion.jsx

@@ -1,12 +0,0 @@
-import React from 'react';
-import { ConclusionScene, Output } from 'react-gamefic';
-
-export class Conclusion extends React.Component {
-	render() {
-		return (
-			<ConclusionScene>
-				<Output {...this.props} transcribe={true} />
-			</ConclusionScene>
-		);
-	}
-}

data/scaffolds/react/web/src/scenes/MultipleChoice.jsx

@@ -1,13 +0,0 @@
-import React from 'react';
-import { MultipleChoiceScene, ChoiceList } from 'react-gamefic';
-
-export class MultipleChoice extends React.Component {
-	render() {
-		return (
-			<MultipleChoiceScene>
-				<Output {...this.props} transcribe={true} />,
-				<ChoiceList options={this.props.state.options} prompt={this.props.state.prompt} />
-			</MultipleChoiceScene>
-		);
-	}
-}

data/scaffolds/react/web/src/scenes/Pause.jsx

@@ -1,13 +0,0 @@
-import React from 'react';
-import { PauseScene, Output, CommandLink } from 'react-gamefic';
-
-export class Pause extends React.Component {
-	render() {
-		return (
-			<PauseScene>
-				<Output {...this.props} transcribe={true} />
-				<CommandLink command="">Continue</CommandLink>
-			</PauseScene>
-		);
-	}
-}

data/scaffolds/react/web/src/scenes/index.js

@@ -1,11 +0,0 @@
-import { Activity } from './Activity.jsx';
-import { Pause } from './Pause.jsx';
-import { MultipleChoice } from './MultipleChoice.jsx';
-import { Conclusion } from './Conclusion.jsx';
-
-export {
-    Activity,
-    Pause,
-    MultipleChoice,
-    Conclusion
-}

data/scaffolds/react/web/src/style.css

@@ -1,3 +0,0 @@
-html {
-    background-color: #EFEFEF;
-}

data/scaffolds/react/webpack.config.js

@@ -1,74 +0,0 @@
-const path = require('path');
-const CopyWebpackPlugin = require('copy-webpack-plugin');
-
-module.exports = (_env, argv) => {
-  var config = {
-    entry: path.resolve(__dirname, 'web', 'src', 'index.js'),
-    output: {
-      filename: 'bundle.js',
-      path: path.resolve(__dirname, "builds", "web", argv.mode)
-    },
-    resolve: {
-      alias: {
-        driver: path.join(__dirname, 'web', 'src', 'driver', argv.mode)
-      }
-    },
-    plugins: [
-      new CopyWebpackPlugin({
-        patterns: [
-          {
-            from: path.resolve(__dirname, 'web', 'public')
-          }
-        ]
-      })
-    ],
-    module: {
-      rules: [
-        {
-          test: /\.css$/,
-          use: [
-            'style-loader',
-            { loader: 'css-loader', options: { esModule: false } }
-          ]
-        },
-        {
-          test: /\.(png|jp(e*)g|svg)$/,
-          use: [{
-            loader: 'url-loader',
-            options: {
-              limit: 8000, // Convert images < 8kb to base64 strings
-              name: 'images/[hash]-[name].[ext]'
-            }
-          }]
-        },
-        {
-          test: /\.jsx?/,
-          include: path.resolve(__dirname, 'web'),
-          use: 'babel-loader'
-        }
-      ]
-    }
-  }
-
-  if (argv.mode == 'production') {
-    config.module.rules.push(
-      {
-        // opal-webpack-bundler will compile and include ruby files in the pack
-        test: /\.rb$/,
-        use: [
-          {
-            loader: 'opal-webpack-bundler',
-            options: {
-              useBundler: true,
-              paths: [path.resolve(__dirname), path.resolve(__dirname, 'lib')],
-              sourceMap: false,
-              root: path.resolve(__dirname)
-            }
-          }
-        ]
-      }
-    );
-  }
-
-  return config;
-};