gamefic-standard 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 19ce8e79ae8e8b3a1a23e5a2636fc722e8359e690cf67d02ad96233a9f6da94d
+  data.tar.gz: 205bb6b6be8854bca3ac924d6d69b4ca1298392efa6edcb7b6f741db684b65fd
+SHA512:
+  metadata.gz: 94ea55f35e275f08ef95795e42c087692095f457d2ccae6968a837fe6b3397c993081a6df0e7e3bd0f5e9c159cece48b07d43936a403f4f370bf1617144cb56e
+  data.tar.gz: 27d37ab19bf8ef41da80320b9d1f804906decc2bc98509b34b6f07b56c2ef7e1e14312c2a96722cf9a9a3eea3638a193a07f5b4f493d6e284f425ea75e0ddee6

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--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/.vscode/launch.json

@@ -0,0 +1,20 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "ruby-debug",
+            "request": "launch",
+            "name": "RSpec (Active File)",
+            "program": "rspec",
+            "programArgs": [
+                "-I",
+                "${workspaceFolder}",
+                "${file}"
+            ],
+            "useBundler": true
+        }
+    ]
+}

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gamefic-standard.gemspec
+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,60 @@
+# Gamefic Standard
+
+The standard library for the Gamefic interactive fiction framework.
+
+Gamefic Standard provides common useful components for adventure games. [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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gamefic-standard'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gamefic-standard
+
+## Usage
+
+Require the library in your game scripts:
+
+```ruby
+require 'gamefic'
+require 'gamefic-standard'
+
+Gamefic.script do
+  @office = make Room, name: 'office'
+  @desk = make Fixture, name: 'desk', parent: @office
+
+  introduction do |actor|
+    actor.parent = @office
+    actor.tell "You're in an office."
+  end
+end
+```
+
+Go to the [Gamefic website](https://gamefic.com) or the [SDK repo](https://github.com/castwide/gamefic-sdk)
+for more information about using 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-standard.
+
+## 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/standard"
+
+# 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-standard.gemspec

@@ -0,0 +1,44 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gamefic-standard/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gamefic-standard"
+  spec.version       = Gamefic::Standard::VERSION
+  spec.authors       = ["Fred Snyder"]
+  spec.email         = ["fsnyder@castwide.com"]
+
+  spec.summary       = %q{The Gamefic standard script library.}
+  spec.description   = %q{A collection of components for building games and interactive fiction in Gamefic.}
+  spec.homepage      = "http://gamefic.com"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.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."
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'gamefic', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.14'
+end

data/lib/gamefic-standard.rb

@@ -0,0 +1,10 @@
+require 'gamefic'
+
+require 'gamefic-standard/version'
+require 'gamefic-standard/grammar'
+require 'gamefic-standard/articles'
+require 'gamefic-standard/queries'
+require 'gamefic-standard/modules'
+require 'gamefic-standard/direction'
+require 'gamefic-standard/entities'
+require 'gamefic-standard/actions'

data/lib/gamefic-standard/actions.rb

@@ -0,0 +1,13 @@
+require 'gamefic-standard/actions/nil'
+require 'gamefic-standard/actions/drop'
+require 'gamefic-standard/actions/enter'
+require 'gamefic-standard/actions/go'
+require 'gamefic-standard/actions/insert'
+require 'gamefic-standard/actions/inventory'
+require 'gamefic-standard/actions/leave'
+require 'gamefic-standard/actions/look'
+require 'gamefic-standard/actions/place'
+require 'gamefic-standard/actions/quit'
+require 'gamefic-standard/actions/take'
+require 'gamefic-standard/actions/talk'
+require 'gamefic-standard/actions/wait'

data/lib/gamefic-standard/actions/drop.rb

@@ -0,0 +1,21 @@
+Gamefic.script do
+  respond :drop, Use.family() do |actor, thing|
+    if thing.parent != actor
+      actor.tell "You're not carrying #{the thing}."
+    else
+      actor.proceed
+    end
+  end
+
+  respond :drop, Use.children do |actor, thing|
+    if thing.sticky?
+      actor.tell thing.sticky_message || "You need to keep #{the thing} for now."
+    else
+      thing.parent = actor.parent
+      actor.tell "You drop #{the thing}."
+    end
+  end
+
+  interpret "put down :thing", "drop :thing"
+  interpret "put :thing down", "drop :thing"
+end

data/lib/gamefic-standard/actions/enter.rb

@@ -0,0 +1,21 @@
+Gamefic.script do
+  respond :enter, Use.siblings do |actor, thing|
+    actor.tell "#{The thing} can't accommodate you."
+  end
+
+  respond :enter, Use.siblings(Enterable, :enterable?) do |actor, supporter|
+    actor.parent = supporter
+    actor.tell "You get in #{the supporter}."
+  end
+
+  respond :enter, Use.parent do |actor, container|
+    actor.tell "You're already in #{the container}."
+  end
+
+  respond :enter, Use.parent(Supporter) do |actor, supporter|
+    actor.tell "You're inside #{the supporter} already."
+  end
+
+  interpret "get on :thing", "enter :thing"
+  interpret "get in :thing", "enter :thing"
+end

data/lib/gamefic-standard/actions/go.rb

@@ -0,0 +1,56 @@
+Gamefic.script do
+  respond :go, Use.siblings(Portal) do |actor, portal|
+    if actor.parent != actor.room
+      actor.perform :leave
+    end
+    if actor.parent == actor.room
+      if portal.destination.nil?
+        actor.tell "That portal leads nowhere."
+      else
+        actor.parent = portal.destination
+        if !portal.direction.nil?
+          actor.tell "You go #{portal.direction}."
+        end
+        actor.tell "<strong>#{actor.room.name.cap_first}</strong>"
+        actor.execute :_describe_destination
+        actor.execute :_itemize_room
+      end
+    end
+  end
+
+  meta :_describe_destination do |actor|
+    actor.tell actor.room.description if actor.room.has_description?
+  end
+
+  respond :go, Use.text do |actor, string|
+    actor.tell "You don't see any exit \"#{string}\" from here."
+  end
+
+  respond :go do |actor|
+    actor.tell "Where do you want to go?"
+  end
+
+  xlate "north", "go north"
+  xlate "south", "go south"
+  xlate "west", "go west"
+  xlate "east", "go east"
+  xlate "up", "go up"
+  xlate "down", "go down"
+  xlate "northwest", "go northwest"
+  xlate "northeast", "go northeast"
+  xlate "southwest", "go southwest"
+  xlate "southeast", "go southeast"
+
+  xlate "n", "go north"
+  xlate "s", "go south"
+  xlate "w", "go west"
+  xlate "e", "go east"
+  xlate "u", "go up"
+  xlate "d", "go down"
+  xlate "nw", "go northwest"
+  xlate "ne", "go northeast"
+  xlate "sw", "go southwest"
+  xlate "se", "go southeast"
+
+  interpret "go to :place", "go :place"
+end

data/lib/gamefic-standard/actions/insert.rb

@@ -0,0 +1,38 @@
+# script 'standard'
+Gamefic.script do
+  respond :insert, Use.available, Use.available do |actor, thing, target|
+    actor.tell "You can't put #{the thing} inside #{the target}."
+  end
+
+  respond :insert, Use.children, Use.available(Receptacle) do |actor, thing, receptacle|
+    if thing.sticky?
+      actor.tell thing.sticky_message || "You need to keep #{the thing} for now."
+    else
+      actor.tell "You put #{the thing} in #{the receptacle}."
+      thing.parent = receptacle
+    end
+  end
+
+  respond :insert, Use.available, Use.available(Receptacle) do |actor, thing, receptacle|
+    if thing.parent == actor
+      actor.proceed
+    else
+      actor.tell "You don't have #{the thing}."
+    end
+  end
+
+  interpret "drop :item in :container", "insert :item :container"
+  interpret "put :item in :container", "insert :item :container"
+  interpret "place :item in :container", "insert :item :container"
+  interpret "insert :item in :container", "insert :item :container"
+
+  interpret "drop :item inside :container", "insert :item :container"
+  interpret "put :item inside :container", "insert :item :container"
+  interpret "place :item inside :container", "insert :item :container"
+  interpret "insert :item inside :container", "insert :item :container"
+
+  interpret "drop :item into :container", "insert :item :container"
+  interpret "put :item into :container", "insert :item :container"
+  interpret "place :item into :container", "insert :item :container"
+  interpret "insert :item into :container", "insert :item :container"
+end

data/lib/gamefic-standard/actions/inventory.rb

@@ -0,0 +1,11 @@
+Gamefic.script do
+  respond :inventory do |actor|
+    if actor.children.length > 0
+      actor.tell "You are carrying #{actor.children.join_and}."
+    else
+      actor.tell "You aren't carrying anything."
+    end
+  end
+
+  interpret "i", "inventory"
+end

data/lib/gamefic-standard/actions/leave.rb

@@ -0,0 +1,32 @@
+Gamefic.script do
+  respond :leave, Use.parent do |actor, thing|
+    actor.tell "There's no way out of #{the thing}."
+  end
+
+  respond :leave, Use.parent(Enterable, :enterable?) do |actor, thing|
+    actor.tell "You leave #{the thing}."
+    actor.parent = thing.parent
+  end
+
+  respond :leave, Use.room do |actor, room|
+    portals = room.children.that_are(Portal)
+    if portals.length == 0
+      actor.tell "You don't see any obvious exits."
+    elsif portals.length == 1
+      actor.perform :go, portals[0]
+    else
+      actor.tell "I don't know which way you want to go: #{portals.join_or}."
+    end
+  end
+
+  respond :leave do |actor|
+    actor.perform :leave, actor.parent
+  end
+
+  interpret "exit", "leave"
+  interpret "exit :supporter", "leave :supporter"
+  interpret "get on :supporter", "enter :supporter"
+  interpret "get off :supporter", "leave :supporter"
+  interpret "get out :container", "leave :container"
+  interpret "get out of :container", "leave :container"
+end

data/lib/gamefic-standard/actions/look.rb

@@ -0,0 +1,117 @@
+Gamefic.script do
+  respond :look, Use.text do |actor, string|
+    if string == 'around'
+      actor.perform :look, actor.room
+    elsif string =~ /self|myself|me/
+      actor.tell actor.description
+      actor.perform :inventory
+    else
+      actor.tell "You don't see any \"#{string}\" here."
+    end
+  end
+
+  respond :look, Use.itself do |actor, thing|
+    actor.tell actor.description
+    actor.perform :inventory
+  end
+
+  respond :look, Use.available(Thing) do |actor, thing|
+    actor.tell thing.description
+    thing.children.that_are(:attached?).that_are(:itemized?).each { |item|
+      actor.tell "#{An item} is attached to #{the thing}."
+    }
+  end
+
+  respond :look, Use.available(Supporter) do |actor, thing|
+    if thing.accessible?
+      itemized = thing.children.that_are_not(:attached?).that_are(:itemized?)
+      # If the supporter does not have a description but it does contain
+      # itemized things, avoid saying there's nothing special about it.
+      actor.proceed if thing.has_description? or itemized.empty?
+      actor.tell "You see #{itemized.join_and} on #{the thing}." unless itemized.empty?
+    else
+      actor.proceed
+    end
+  end
+
+  respond :look, Use.available(Receptacle) do |actor, thing|
+    actor.proceed
+    if thing.accessible?
+      itemized = thing.children.that_are_not(:attached?).that_are(:itemized?)
+      actor.tell "You see #{itemized.join_and} in #{the thing}." unless itemized.empty?
+    end
+  end
+
+  respond :look, Use.parent(Supporter, :enterable?) do |actor, supporter|
+    actor.proceed
+    actor.tell "You are currently on #{the supporter}."
+  end
+
+  respond :look, Use.room do |actor, room|
+    actor.tell "<strong>#{room.name.cap_first}</strong>"
+    actor.tell room.description if room.has_description?
+    actor.execute :_itemize_room
+  end
+
+  meta :_itemize_room do |actor|
+    room = actor.room
+    next if room.nil?
+    with_locales = []
+    chars = room.children.that_are(Character).that_are(:itemized?) - [actor]
+    charsum = []
+    chars.each { |char|
+      if char.locale_description.nil?
+        charsum.push char
+      else
+        with_locales.push char
+      end
+    }
+    if charsum.length > 0
+      actor.tell "#{charsum.join_and.cap_first} #{charsum.length == 1 ? 'is' : 'are'} here."
+    end
+    items = room.children.that_are(:itemized?) - [actor] - room.children.that_are(Character) - room.children.that_are(Portal)
+    itemsum = []
+    items.each { |item|
+      if item.locale_description.nil?
+        itemsum.push item
+      else
+        with_locales.push item
+      end
+    }
+    if itemsum.length > 0
+      actor.tell "You see #{itemsum.join_and}."
+    end
+    with_locales.each { |entity|
+      actor.tell entity.locale_description
+    }
+    if room.explicit_exits?
+      portals = room.children.that_are(Portal).that_are(:itemized?)
+      if portals.length > 0
+        if portals.length == 1
+          p = portals[0]
+          actor.tell "There is an exit #{p.instruction}."
+        else
+          dirs = []
+          portals.each { |p|
+            dirs.push p.instruction
+          }
+          actor.tell "There are exits #{dirs.join_and(', ')}."
+        end
+      end
+    end
+    if actor.parent.kind_of?(Supporter)
+      actor.tell "You are on #{the actor.parent}."
+      actor.parent.children.that_are_not(actor).each { |s|
+        actor.tell "#{A s} is on #{the actor.parent}."
+      }
+    end
+  end
+
+  interpret "look", "look around"
+  interpret "l", "look around"
+
+  interpret "look at :thing", "look :thing"
+  interpret "l :thing", "look :thing"
+  interpret "examine :thing", "look :thing"
+  interpret "x :thing", "look :thing"
+end