gamefic-sdk 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 415641494cfa86591a96b85167ac9cba4f1a013d79da063e82d1c561e9435bb3
-  data.tar.gz: d44f03b6d4c6d3af3b532b84dc5347a19c04f40affeb6ca6f9691ce4442feb79
+  metadata.gz: 7fa038497ffa370ceb79dc943824850c60d6cf67b71c39191ab0220a4277b72e
+  data.tar.gz: 83891f88d0ccad744ca541fb235ed531b11bc525f2814a8766f423d12fcea21f
 SHA512:
-  metadata.gz: 53e1393eae8835b4c69ab12c99a24d39095577665c2fc02aa52ab7aa457c2f69593cea18d28727ee2aabc72808568cc82f22dc839bb94c5b3cc37f3ae1bf9cab
-  data.tar.gz: 46c7288a4a3246c20a7b5d4af70054f89a058658bd1ed73e8c7cc02e8f8d817534f21429881ac4a2c2032e2824266c764e92e0903ebc7a30dddf905bc881990a
+  metadata.gz: 6b0851ee5fa6100379e88fbf866060a8360b18bc6f294e8d358f833aae68ba057111a97651bda50aea7c61be40bd22696d8ff5f52bd6c2d379f9c3331abd420a
+  data.tar.gz: 49c7b1e652fe7482b6bce546877a8073189546d7ebf09a29fe091729b28b65008f90a1060bd4a4a44daab3310d8e9b676c2476c629640d8ddc9c2483d0916542

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-## 3.3.0
+## 3.4.0 - October 19, 2024
+- Reorder project requires
+- Add Common module to project scaffold
+- Lock gamefic-sdk-3 to react-gamefic-1
+
+## 3.3.0 - September 10, 2024
 - Add chapter to project scaffold
 - Remove superfluous no_scripts calls
 

data/README.md

@@ -1,158 +1,158 @@
-# Gamefic SDK
-
-**A Ruby Interactive Fiction Framework**
-
-The Gamefic SDK provides development tools for writing games and interactive fiction with Gamefic.
-
-## Installation
-
-Install the gem:
-
-    $ gem install gamefic-sdk
-
-## Usage
-
-This section provides a fast and simple introduction to using the SDK. Go to
-the [Gamefic website](https://gamefic.com) for in-depth guides and
-documentation.
-
-### Creating a New Project
-
-Create a new project and go to its directory:
-
-    $ gamefic init my_game
-    $ cd my_game
-
-Test the project by running the game on the command line:
-
-    $ rake ruby:run
-
-The Ruby game works like a traditional text adventure:
-
-    Hello, world!
-    >
-
-You can enter commands at the `>` prompt, but you haven't written any content,
-so there's not much to do yet. Enter `QUIT` to exit the game.
-
-### The Script Code
-
-The plot for your narrative is defined in the `plot.rb` file. It should look
-something like this:
-
-```ruby
-module Example
-  class Plot < Gamefic::Plot
-    UUID = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
-
-    include Gamefic::Standard
-
-    script do
-      introduction do |actor|
-        actor.tell "Hello, world!"
-      end
-    end
-  end
-end
-```
-
-`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.
-
-['gamefic-standard'](https://github.com/castwide/gamefic-standard) is a collection
-of baseline features that are frequently useful for interactive fiction. [Inform](http://inform7.com/)
-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.
-
-`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 `plot.rb` with the following:
-
-```ruby
-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
-```
-
-Enter `rake ruby:run` to test the game. Now that it has rooms and objects, you
-can perform in-game commands like `LOOK AROUND`, `GO NORTH`, and `TAKE THE BACKPACK`.
-
-### Making Games for the Web
-
-The default game project includes tasks for building "web" apps using HTML,
-CSS, and JavaScript. Generate the code for a web build with the following
-command:
-
-```
-$ rake web:generate
-```
-
-Test the game in a browser by starting a server:
-
-```
-$ rake web:run
-```
-
-Open `http://localhost:9000` to run the game in debug mode.
-
-Build a standalone web game:
-
-```
-$ rake web:build
-```
-
-The game's HTML file and related assets will be generated in the
-`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).
-
-### Example Projects
-
-The gamefic-sdk repo includes several example projects that provide more
-complete demonstrations of Gamefic's features. To run an example, copy
-its `plot.rb` file to your own project.
-
-### Learning More
-
-Go to the [Gamefic website](https://gamefic.com) for more information about
-developing and building apps with Gamefic.
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/castwide/gamefic-sdk.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# Gamefic SDK
+
+**A Ruby Interactive Fiction Framework**
+
+The Gamefic SDK provides development tools for writing games and interactive fiction with Gamefic.
+
+## Installation
+
+Install the gem:
+
+    $ gem install gamefic-sdk
+
+## Usage
+
+This section provides a fast and simple introduction to using the SDK. Go to
+the [Gamefic website](https://gamefic.com) for in-depth guides and
+documentation.
+
+### Creating a New Project
+
+Create a new project and go to its directory:
+
+    $ gamefic init my_game
+    $ cd my_game
+
+Test the project by running the game on the command line:
+
+    $ rake ruby:run
+
+The Ruby game works like a traditional text adventure:
+
+    Hello, world!
+    >
+
+You can enter commands at the `>` prompt, but you haven't written any content,
+so there's not much to do yet. Enter `QUIT` to exit the game.
+
+### The Script Code
+
+The plot for your narrative is defined in the `plot.rb` file. It should look
+something like this:
+
+```ruby
+module Example
+  class Plot < Gamefic::Plot
+    UUID = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
+
+    include Gamefic::Standard
+
+    script do
+      introduction do |actor|
+        actor.tell "Hello, world!"
+      end
+    end
+  end
+end
+```
+
+`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.
+
+['gamefic-standard'](https://github.com/castwide/gamefic-standard) is a collection
+of baseline features that are frequently useful for interactive fiction. [Inform](http://inform7.com/)
+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.
+
+`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 `plot.rb` with the following:
+
+```ruby
+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
+```
+
+Enter `rake ruby:run` to test the game. Now that it has rooms and objects, you
+can perform in-game commands like `LOOK AROUND`, `GO NORTH`, and `TAKE THE BACKPACK`.
+
+### Making Games for the Web
+
+The default game project includes tasks for building "web" apps using HTML,
+CSS, and JavaScript. Generate the code for a web build with the following
+command:
+
+```
+$ rake web:generate
+```
+
+Test the game in a browser by starting a server:
+
+```
+$ rake web:run
+```
+
+Open `http://localhost:9000` to run the game in debug mode.
+
+Build a standalone web game:
+
+```
+$ rake web:build
+```
+
+The game's HTML file and related assets will be generated in the
+`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).
+
+### Example Projects
+
+The gamefic-sdk repo includes several example projects that provide more
+complete demonstrations of Gamefic's features. To run an example, copy
+its `plot.rb` file to your own project.
+
+### Learning More
+
+Go to the [Gamefic website](https://gamefic.com) for more information about
+developing and building apps with Gamefic.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/castwide/gamefic-sdk.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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

@@ -12,7 +12,7 @@ module Gamefic
 
         # Generate a web app using NPM.
         #
-        def generate version = '@latest'
+        def generate version = '@1.6.1'
           puts "Node version #{check_for_npm} detected. Preparing the web app..."
           web_path = File.join(absolute_path, 'web')
           FileUtils.mkdir_p web_path

data/lib/gamefic-sdk/version.rb

@@ -2,6 +2,6 @@
 
 module Gamefic
   module Sdk
-    VERSION = '3.3.0'
+    VERSION = '3.4.0'
   end
 end

data/scaffolds/project/lib/__name__/chapter.rb.gf.erb

@@ -7,6 +7,6 @@ module <%= camelcase(name) %>
   # the plot.
   #
   class Chapter < Gamefic::Chapter
-    include Gamefic::Standard
+    include Common
   end
 end

data/scaffolds/project/lib/__name__/common.rb.gf.erb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module <%= camelcase(name) %>
+  # A single container for modules that are shared among plots, chapters, and
+  # subplots.
+  #
+  module Common
+    extend Gamefic::Scriptable
+
+    include Gamefic::Standard
+    # Add more shared modules here
+  end
+end

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

@@ -6,12 +6,10 @@ module <%= camelcase(name) %>
   class Plot < Gamefic::Plot
     UUID = 'fe5d62a7-7036-45c0-b5cb-39c336bf1b5a'
 
-    include Gamefic::Standard
+    include Common
 
-    script do
-      introduction do |actor|
-        actor.tell "Hello, world!"
-      end
+    introduction do |actor|
+      actor.tell "Hello, world!"
     end
   end
 end

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

@@ -7,6 +7,6 @@ module <%= camelcase(name) %>
   # branch.
   #
   class Subplot < Gamefic::Subplot
-    include Gamefic::Standard
+    include Common
   end
 end

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

@@ -4,7 +4,8 @@ require 'gamefic'
 require 'gamefic-standard'
 
 module <%= camelcase(name) %>
-  require '<%= name %>/plot'
+  require '<%= name %>/common'
   require '<%= name %>/chapter'
+  require '<%= name %>/plot'
   require '<%= name %>/subplot'
 end

data/scaffolds/project/spec/__name__/plot_spec.rb.gf.erb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe <%= camelcase(name) %>::Plot do
   let(:plot) { <%= camelcase(name) %>::Plot.new }
 

data/scaffolds/project/spec/__name__/subplot_spec.rb.gf.erb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe <%= camelcase(name) %>::Subplot do
   let(:plot) { <%= camelcase(name) %>::Plot.new }
 

data/scaffolds/project/spec/gameplay_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe 'gameplay' do
   let(:plot) { GAMEFIC_PLOT_CLASS.new }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamefic-sdk
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-10 00:00:00.000000000 Z
+date: 2024-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gamefic
@@ -248,6 +248,7 @@ files:
 - scaffolds/project/Rakefile.gf.erb
 - scaffolds/project/lib/__name__.rb.gf.erb
 - scaffolds/project/lib/__name__/chapter.rb.gf.erb
+- scaffolds/project/lib/__name__/common.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