gamefic-sdk 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce08abec9929267cbcd41b95da9a7bd313e3449ce3160277b26160aadd8437bf
-  data.tar.gz: 1e7c8e9827b24816addfec88ff81f1c9d9e8112f9e5422f045a2ef07471375b1
+  metadata.gz: ab948f913c148992dc91b0ec1b4c5b8a605661b4f542bb17b7eee91648d17fd2
+  data.tar.gz: 2bc3d80372c32eaaa9106f4aa1dc57aacf211745d7f902c660d58ab9ffed69b8
 SHA512:
-  metadata.gz: 1dc60435ac2e35ed97f76de2d2ba8494c5dad6a54b6aeb943b4767159c866cdd799e21763f29ed1b9360e117a8b2912934ad607b6b343d986cac9c4769d004bd
-  data.tar.gz: 76c10bcf57491365f4b61b78f2f076d3bdd9bab43b0d46a6ed838b612c2a7c82026cb6d2ef5d94bc7f0fa817fe364ff3325b1550e8de7bfc49b5e95e47a4d910
+  metadata.gz: af98a3ceedfed1d026b848950eb4eeadd17ab84d5c0f61675e5500d2a6cf36e69e2f7bf38a5e435c831b828b7fc0f5dc2ab048661373c7751b38f4ec49229358
+  data.tar.gz: ba3a8485e4a5f240d63238fa8498cab2e8495f5fd92d16b7394a249708b6b57f5d32df7e48fcdbe757048f149c808826e13576a8ec4cbe33b3073c3738368c06

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/guides/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Fred Snyder
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,146 @@
+# 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 main script for your narrative is `main.rb` in your project's root
+directory. It should look something like this:
+
+```ruby
+GAMEFIC_UUID = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
+require 'gamefic-standard'
+
+Gamefic.script do
+  introduction do |actor|
+    actor.tell "Hello, world!"
+  end
+end
+```
+
+`GAMEFIC_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.
+
+`Gamefic.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:
+
+```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.'
+  @living_room.connect @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."
+  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:4342` 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
+`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.
+
+Note: building the web app requires [Node.js](https://nodejs.org).
+
+### Example Projects
+
+The gamefic-sdk repo includes several example projects that provide more
+more complete demonstrations of Gamefic's features. To run an example, copy
+its `main.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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +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__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gamefic-sdk.gemspec

@@ -0,0 +1,42 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gamefic-sdk/version'
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name          = 'gamefic-sdk'
+  s.version       = Gamefic::Sdk::VERSION
+  s.date          = Date.today.strftime("%Y-%m-%d")
+  s.summary       = "Gamefic SDK"
+  s.description   = "Development and command-line tools for Gamefic"
+  s.authors       = ["Fred Snyder"]
+  s.email         = 'fsnyder@gamefic.com'
+  s.homepage      = 'http://gamefic.com'
+  s.license       = 'MIT'
+
+  # 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.
+  s.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|examples|guides)/}) }
+  end
+  s.executables   = ['gamefic']
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 2.3.0'
+
+  s.add_runtime_dependency 'gamefic', '~> 2.0'
+  s.add_runtime_dependency 'gamefic-standard', '~> 2.0'
+  s.add_runtime_dependency 'gamefic-tty', '~> 2.0'
+  s.add_runtime_dependency 'listen', '~> 3.0'
+  s.add_runtime_dependency 'opal', '~> 1.0'
+  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', '~> 3'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency 'selenium-webdriver', '~> 3.13'
+  s.add_development_dependency 'simplecov', '~> 0.14'
+end

data/lib/gamefic-sdk/version.rb

@@ -1,5 +1,5 @@
 module Gamefic
   module Sdk
-    VERSION = '2.0.0'
+    VERSION = '2.0.1'
   end
 end

data/scaffolds/library/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

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

@@ -0,0 +1,14 @@
+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'
+end

data/scaffolds/library/lib/__name__.rb

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

data/scaffolds/project/.gitignore

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

data/scaffolds/project/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem 'gamefic'
+gem 'gamefic-standard'
+
+group :development do
+  gem 'gamefic-sdk'
+  gem 'gamefic-tty'
+  gem 'rake'
+end

data/scaffolds/project/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'gamefic-sdk'
+
+# Add the default Gamefic tasks for building and running games
+# Run `rake --tasks` for a list of commands and descriptions
+Gamefic::Sdk::Tasks.define_all

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

@@ -0,0 +1,9 @@
+GAMEFIC_UUID = '<%= SecureRandom.uuid %>'
+require 'gamefic'
+require 'gamefic-standard'
+
+Gamefic.script do
+  introduction do |actor|
+    actor.tell "Hello, world!"
+  end
+end

data/scaffolds/react/.babelrc

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

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

@@ -0,0 +1,34 @@
+{
+  "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 --env=production -p",
+    "develop": "webpack --env=development -d"
+  },
+  "devDependencies": {
+    "babel-core": "^6.26.3",
+    "babel-loader": "^7.1.5",
+    "babel-preset-env": "^1.7.0",
+    "babel-preset-react": "^6.24.1",
+    "copy-webpack-plugin": "^4.5.3",
+    "css-loader": "^1.0.0",
+    "file-loader": "^3.0.1",
+    "opal-webpack-bundler": "^0.0.1",
+    "style-loader": "^0.23.1",
+    "url-loader": "^1.1.2",
+    "webpack": "^4.20.2",
+    "webpack-cli": "^3.1.2"
+  },
+  "dependencies": {
+    "gamefic-driver": "^0.2.0",
+    "react": "^16.5.2",
+    "react-dom": "^16.5.2",
+    "react-gamefic": "^0.2.0"
+  }
+}

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

@@ -0,0 +1,11 @@
+<!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

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

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

@@ -0,0 +1,7 @@
+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

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

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

@@ -0,0 +1,17 @@
+import React from 'react';
+import { render } from 'react-dom';
+import { Console, Terminal } from 'react-gamefic';
+import { driver } from 'driver';
+import 'react-gamefic/styles/ebook';
+import './style.css';
+
+render(
+	<Console driver={driver}>
+		<Terminal />
+	</Console>,
+	document.getElementById('root')
+);
+
+driver.start().then((state) => {
+	driver.notify(state);
+});

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

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

data/scaffolds/react/webpack.config.js

@@ -0,0 +1,69 @@
+const path = require('path');
+const CopyWebpackPlugin = require('copy-webpack-plugin');
+
+module.exports = (env) => {
+  var config = {
+    entry: path.resolve(__dirname, 'web', 'src', 'index.js'),
+    output: {
+      filename: 'bundle.js',
+      path: path.resolve(__dirname, "builds", "web", env)
+    },
+    resolve: {
+      alias: {
+        driver: path.join(__dirname, 'web', 'src', 'driver', env)
+      }
+    },
+    plugins: [
+        new CopyWebpackPlugin([
+            {
+                from: path.resolve(__dirname, 'web', 'public')
+            },
+        ])
+    ],
+    module: {
+        rules: [
+            {
+                test: /\.css$/,
+                use: ['style-loader', 'css-loader']
+            },
+            {
+              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 (env == '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;
+};

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gamefic-sdk
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Fred Snyder
@@ -213,7 +213,17 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
 - bin/gamefic
+- bin/setup
+- gamefic-sdk.gemspec
 - lib/gamefic-sdk.rb
 - lib/gamefic-sdk/diagram.rb
 - lib/gamefic-sdk/scaffold.rb
@@ -224,6 +234,22 @@ files:
 - lib/gamefic-sdk/tasks/ruby.rb
 - lib/gamefic-sdk/tasks/web.rb
 - lib/gamefic-sdk/version.rb
+- scaffolds/library/Gemfile
+- scaffolds/library/__name__.gemspec.gf.erb
+- scaffolds/library/lib/__name__.rb
+- scaffolds/project/.gitignore
+- scaffolds/project/Gemfile
+- scaffolds/project/Rakefile
+- 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/style.css
+- scaffolds/react/webpack.config.js
 homepage: http://gamefic.com
 licenses:
 - MIT