gamefic-sdk 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a65534f07f1678a5e82275ec3a8e8158e8d96096d4adcf8e1d4277ab8961a5dd
-  data.tar.gz: fd315e465a03350354a2c0f795088d63d14b16ec55a83a7025eef28dca35017f
+  metadata.gz: a1a52e09b3e29c8c869f67561d732d54493043a4ee04e75a49eade71d4396ddf
+  data.tar.gz: 8085b05a412924f4c4783bdcc09d9a6f9e97ef5aadc719257ed9a34b0a77e5a0
 SHA512:
-  metadata.gz: 452327933e7a5f43100f4331a324b77b45e585187d9f470e15c4c4fb4cf3414105551430e340c4ae07f9e9c73ff082444d6840940a039478282cf71f517e8193
-  data.tar.gz: 6f2dacd9c0f9273baebb359a25397ac5e3589c85ae1081a9e12d5472ee4f575d7edc6cab940654b2581ac75076bda01aaf92be56215707dbbcf37141e36c92a1
+  metadata.gz: 4b0f9ac162876dd92ed56ae979d9f4fcaa16ae49e0aa1550be1f5c61a82ba486190c22cff45b1617eb1e275af4141cef4393a6c352dd26e2e356f51ab06a33c8
+  data.tar.gz: d263b78b4dca96bb0994bc8a9b3ff1d9734ac84380e312e3987f3ac7747f9374660c64ccda2c642a72e8c86dd33bb08d9e3557b9f29d2485984809bd403a70f7

data/CHANGELOG.md

@@ -1,9 +1,17 @@
+## 3.1.0 - July 13, 2024
+- Plot and Subplot classes in scaffold
+- Scaffold requires ostruct
+- Support for lib path in web project
+
+## 3.0.1 - April 10, 2024
+- Updates to README in project scaffold
+
 ## 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
+- Use react-gamefic for web scaffolds
 - Modular projects and libraries
 - New project scaffold
 

data/README.md

@@ -37,21 +37,26 @@ so there's not much to do yet. Enter `QUIT` to exit the game.
 
 ### The Script Code
 
-The main script for your narrative is `main.rb` in your project's root
-directory. It should look something like this:
+The plot for your narrative is defined in the `plot.rb` file. It should look
+something like this:
 
 ```ruby
-GAMEFIC_UUID = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
-require 'gamefic-standard'
+module Example
+  class Plot < Gamefic::Plot
+    UUID = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
 
-Gamefic.script do
-  introduction do |actor|
-    actor.tell "Hello, world!"
+    include Gamefic::Standard
+
+    script do
+      introduction do |actor|
+        actor.tell "Hello, world!"
+      end
+    end
   end
 end
 ```
 
-`GAMEFIC_UUID` is a globally unique identifier. It can be useful if you want to
+`UUID` is a globally unique identifier. It can be useful if you want to
 add your game to online catalogs, such as the [Interactive Fiction Database](https://ifdb.tads.org/),
 but it's safe to delete if you don't need it.
 
@@ -61,26 +66,34 @@ developers should find it similar to Inform's Standard Rules. It defines common
 components like Rooms and Characters, along with in-game commands like `GO`,
 `GET`, and `DROP` to enable basic interactivity.
 
-`Gamefic.script` is where you write the story itself. In the starter project,
+`script` is where you write the story itself. In the starter project,
 the only thing in the script is an introductory message.
 
 ### Modifying the Script
 
-Replace the contents of `main.rb` with the following:
+Replace the contents of `plot.rb` with the following:
 
 ```ruby
-require 'gamefic-standard'
-
-Gamefic.script do
-  @living_room = make Room, name: 'living room', description: 'This is your living room.'
-  @bedroom = make Room, name: 'bedroom', description: 'This is your bedroom.'
-  connect @living_room, @bedroom, 'north'
-  @backpack = make Room, name: 'backpack', description: 'Your trusty backpack.', parent: @bedroom
-  @book = make Room, name: 'book', description: 'Your favorite novel.', parent: @living_room
-
-  introduction do |actor|
-    actor.parent = @living_room
-    actor.tell "You're in your house."
+module Example
+  class Plot < Gamefic::Plot
+    UUID = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
+
+    include Gamefic::Standard
+
+    seed do
+      @living_room = make Room, name: 'living room', description: 'This is your living room.'
+      @bedroom = make Room, name: 'bedroom', description: 'This is your bedroom.'
+      connect @living_room, @bedroom, 'north'
+      @backpack = make Room, name: 'backpack', description: 'Your trusty backpack.', parent: @bedroom
+      @book = make Room, name: 'book', description: 'Your favorite novel.', parent: @living_room
+    end
+
+    script do
+      introduction do |actor|
+        actor.parent = @living_room
+        actor.tell "You're in your house."
+      end
+    end
   end
 end
 ```
@@ -104,7 +117,7 @@ Test the game in a browser by starting a server:
 $ rake web:run
 ```
 
-Open `http://localhost:4342` to run the game in debug mode.
+Open `http://localhost:9000` to run the game in debug mode.
 
 Build a standalone web game:
 
@@ -113,10 +126,9 @@ $ rake web:build
 ```
 
 The game's HTML file and related assets will be generated in the
-`builds/web/production` directory. The SDK uses
-[opal](https://github.com/opal/opal) to compile Ruby code to JavaScript, so the
-web build does not require a Ruby interpreter. Open `index.html` in a browser
-to play the game.
+`web/build` directory. The SDK uses opal](https://github.com/opal/opal)
+to compile Ruby code to JavaScript, so the web build does not require a
+Ruby interpreter. Open `index.html` in a browser to play the game.
 
 Note: building the web app requires [Node.js](https://nodejs.org).
 
@@ -124,7 +136,7 @@ Note: building the web app requires [Node.js](https://nodejs.org).
 
 The gamefic-sdk repo includes several example projects that provide more
 complete demonstrations of Gamefic's features. To run an example, copy
-its `main.rb` file to your own project.
+its `plot.rb` file to your own project.
 
 ### Learning More
 

data/lib/gamefic-sdk/scaffold.rb

@@ -1,5 +1,6 @@
 require 'fileutils'
 require 'erb'
+require 'ostruct'
 require 'pathname'
 require 'securerandom'
 require 'shellwords'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'gamefic-tty'
 require 'tmpdir'
 require 'zlib'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'listen'
 
 module Gamefic
@@ -16,7 +18,7 @@ module Gamefic
           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'
+            system 'npx', 'react-gamefic', '--name', name, '--class', 'GAMEFIC_PLOT_CLASS', '--path', '../lib'
             puts 'The web app is ready.'
             puts 'Run `rake web:run` to start the app in dev mode.'
           end

data/lib/gamefic-sdk/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Gamefic
   module Sdk
-    VERSION = '3.0.0'
+    VERSION = '3.1.0'
   end
 end

data/scaffolds/project/.gitignore

@@ -1,2 +1,2 @@
-builds
+build
 node_modules

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

@@ -31,7 +31,7 @@ To run the app in debug mode:
 
     $ rake web:run
 
-Open http://localhost:4342 in a browser.
+Open http://localhost:9000 in a browser.
 
 ## Building a Web Game
 

data/scaffolds/project/{__name__ → lib/__name__}/subplot.rb.gf.erb

@@ -3,7 +3,7 @@
 module <%= camelcase(name) %>
   # The base subplot.
   #
-  # Authors should extend subclasses to create subplots that the plot can
+  # Authors should extend this class to create subplots that the plot can
   # branch.
   #
   class Subplot < Gamefic::Subplot

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

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+lib = File.expand_path('./lib', File.dirname(__FILE__))
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'gamefic'
 require 'gamefic-standard'
 
-require_relative '<%= name %>/plot'
-require_relative '<%= name %>/subplot'
+require '<%= name %>/plot'
+require '<%= 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: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-27 00:00:00.000000000 Z
+date: 2024-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gamefic
@@ -245,8 +245,8 @@ files:
 - 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/lib/__name__/plot.rb.gf.erb
+- scaffolds/project/lib/__name__/subplot.rb.gf.erb
 - scaffolds/project/main.rb.gf.erb
 homepage: http://gamefic.com
 licenses: