story-teller 1.1.3

data/README.md

@@ -0,0 +1,188 @@
+# Story Teller
+
+[![License](https://img.shields.io/badge/license-GPLv3-blue.svg?style=flat)](license-gpl)
+
+
+
+**The Story Teller** for Ruby is a command-line interface software
+runtime program for playing interactive-fiction games which use the
+[Inform 6 Ruby Port].
+
+The Story Teller is intended to be used to play a game specified by a
+path to a directory or file.  The game file or directory specifies the
+source code for a game file written using the Inform 6 Ruby Port.
+
+
+## Install mise-en-place
+
+The [mise] CLI tool used to manage multiple runtime versions.
+
+See: https://mise.jdx.dev/getting-started.html
+
+```sh
+curl https://mise.run/zsh | sh
+mise --version
+```
+
+
+## Install required runtime software
+
+```sh
+mise install
+```
+
+Now install the `bundler` for managing project dependencies.
+
+```sh
+gem install bundler
+gem update --system
+```
+
+
+Install the latest version of [PostgreSQL].
+
+```sh
+mise use postgres@latest
+mise install
+```
+
+
+## Setup
+
+Install some gem dependencies.
+
+```sh
+bundle update --bundler
+bundle install
+```
+
+
+## Run
+
+Execute the `inform.rb` program. It will play the included example game.
+
+```sh
+bundle exec inform.rb
+```
+
+```
+Welcome to...
+
+EXAMPLE
+An Interactive Example
+Copyright (c) 2025 by Nels N. Nelson.
+Release 1 / Serial number 251006 / inform.rb v1.0.3 Library 6/11N 
+
+Field
+You are standing in a field in front of a small 19th century house which stands just to the east of you. The house hardly stands up to the stiff wind rolling down from the north.
+You can see a small toy top here.
+
+>quit
+Are you sure you want to quit? yes
+[Hit enter to exit.]
+```
+
+
+## Linting
+
+```sh
+bundle exec rake lint
+```
+
+
+## Testing
+
+```sh
+bundle exec rake test
+```
+
+
+## Project file tree
+
+Here is a bird's-eye view of the project layout.
+
+```sh
+# date && tree -A -I "game|logs|vendor|tmp|Gemfile.lock"
+Sat Dec 13 22:05:24 CST 2025
+.
+├── config
+│   └── database.yml
+├── CONTRIBUTING.md
+├── exe
+│   └── inform.rb
+├── Gemfile
+├── inform-runtime.gemspec
+├── lib
+│   ├── runtime
+│   │   ├── articles.rb
+│   │   ├── builtins.rb
+│   │   ├── color.rb
+│   │   ├── command.rb
+│   │   ├── config.rb
+│   │   ├── context.rb
+│   │   ├── daemon.rb
+│   │   ├── database.rb
+│   │   ├── events.rb
+│   │   ├── experimental
+│   │   │   └── handler_dsl.rb
+│   │   ├── game_loader.rb
+│   │   ├── game.rb
+│   │   ├── grammar_parser.rb
+│   │   ├── helpers.rb
+│   │   ├── history.rb
+│   │   ├── inflector.rb
+│   │   ├── io.rb
+│   │   ├── kernel.rb
+│   │   ├── library_loader.rb
+│   │   ├── library.rb
+│   │   ├── link.rb
+│   │   ├── logging.rb
+│   │   ├── mixins.rb
+│   │   ├── module.rb
+│   │   ├── object.rb
+│   │   ├── options.rb
+│   │   ├── persistence.rb
+│   │   ├── plurals.rb
+│   │   ├── prototype.rb
+│   │   ├── publication.rb
+│   │   ├── runtime.rb
+│   │   ├── session.rb
+│   │   ├── snapshots.rb
+│   │   ├── stdlib.rb
+│   │   ├── subscription.rb
+│   │   ├── tag.rb
+│   │   ├── tree.rb
+│   │   ├── version.rb
+│   │   └── world_tree.rb
+│   └── runtime.rb
+├── LICENSE
+├── Rakefile
+├── README.md
+├── roller2.jpg
+├── scripts
+│   ├── backup.rb
+│   ├── clone.rb
+│   ├── delete.rb
+│   ├── init.rb
+│   ├── rebuild.rb
+│   └── restore.rb
+└── spec
+    ├── game_spec.rb
+    ├── inform_spec.rb
+    ├── inform_system_spec.rb
+    ├── object_spec.rb
+    ├── parser_spec.rb
+    ├── spec_helper.rb
+    ├── verblib_spec.rb
+    └── verify_gem_spec.rb
+
+7 directories, 63 files
+```
+
+Thanks!
+
+[Inform 6 Ruby Port]: https://gitlab.com/nelsnelson/inform6lib-ruby
+[license-gpl]: https://gitlab.com/nelsnelson/inform6/blob/master/LICENSE
+[mise]: https://mise.jdx.dev/
+[PostgreSQL]: https://postgresql.org/download
+

data/Rakefile

@@ -0,0 +1,58 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+require 'fileutils'
+require 'rake'
+require 'rake/clean'
+require 'shellwords'
+
+unless defined?(StoryTeller::PROJECT)
+# Ensure StoryTeller module constants
+module StoryTeller
+  PROJECT = File.basename(File.expand_path(__dir__))
+end
+end
+
+load "#{StoryTeller::PROJECT}.gemspec"
+
+CLEAN.add File.join('tmp', '**', '*'), 'tmp'
+CLOBBER.add '*.gem', 'pkg'
+
+task default: %i[package]
+
+desc 'Run the rubocop linter'
+task :lint do
+  system('bundle', 'exec', 'rubocop') or abort
+end
+
+desc 'Run the spec tests'
+task :test do
+  system('bundle', 'exec', 'rspec', '--format=documentation') or abort
+end
+task test: :lint
+
+desc 'Package the gem'
+task :package do
+  system('gem', 'build') or abort
+end
+task package: %i[clean clobber test]
+
+desc 'Verify the gem'
+task :verify do
+  system('bundle', 'exec', 'rspec', 'spec/verify_gem_spec.rb') or abort
+  system('bundle', 'exec', 'rake', 'clean')
+end
+task verify: :package
+
+desc 'Publish the gem'
+task :publish do
+  system('gem', 'push', latest_gem) or abort
+end
+task publish: :verify
+
+def latest_gem
+  Dir["#{StoryTeller::PROJECT}*.gem"].max_by { |p| File.mtime(p) }
+end

data/config/database.yml

@@ -0,0 +1,37 @@
+
+default:
+  adapter: postgres
+  database: postgres
+  username: postgres
+  host: localhost
+  pool: 5
+
+development:
+  adapter: postgres
+  database: example
+  username: example
+  password: example
+  host: localhost
+  pool: 5
+  timeout: 5000
+
+test:
+  adapter: sqlite
+
+docker:
+  adapter: postgres
+  database: example
+  username: example
+  password: example
+  host: postgres
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: postgres
+  database: example
+  username: example
+  password: example
+  host: localhost
+  pool: 5
+  timeout: 5000

data/exe/inform.rb

@@ -0,0 +1,6 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: false
+
+require_relative '../lib/story_teller_cli'
+
+Object.new.extend(StoryTeller::Cli).main

data/game/config.yml

@@ -0,0 +1,5 @@
+# Configuration for game module
+
+---
+game_name: example
+environment: production

data/game/example.inf

@@ -0,0 +1,90 @@
+
+! ----------------------------------------------------------------------------
+!  Example
+! ----------------------------------------------------------------------------
+
+! DEBUG = true
+Constant Story = "EXAMPLE";
+Constant Headline = "^An Interactive Example^
+  Copyright (c) 2025 by Nels N. Nelson.^";
+
+Replace DrawStatusLine;
+
+Include "Parser";
+Include "VerbLib";
+
+Attribute male;
+
+Object Field "Field"
+  with description
+           "You are standing in a field.  A small 19th century house stands 
+           to the east, hardly standing up to the stiff wind rolling down 
+           from the north.",
+       e_to HouseFoyer,
+       w_to Shingle
+  has  light;
+
+Object -> "man wearing an old ragged military uniform"
+  with name 'uniformed' 'man'
+       description
+           "The man who stands before you is middle-aged, but somehow
+           older. His uniform is old, ragged, dingy and faded. It is not
+           clear which military he served in, but he almost certainly
+           does not belong to any regiment any longer.",
+  has  animate male;
+
+Object HouseFoyer "Foyer"
+  with description
+           "You stand in the foyer of this
+           ancient structure.  A draft swirls through
+           the hallway to the east.",
+    out_to Field,
+    w_to Field
+  has light;
+
+Property weight;
+
+Object -> "small toy top"
+  with name 'small' 'toy' 'top',
+       before [;
+         Examine:
+           print "A totem, somehow familiar, made of brass";
+           if (self in player) {
+             print " and heavy in your hand";
+           }
+           ".";
+       ],
+       weight 15; ! grams
+
+Object Shingle "Shingle"
+  with description
+           "You seem to be only a small child
+           playing on a sea-shore, and diverting yourself
+           in finding a smoother pebble or a prettier shell
+           than ordinary, whilst the great ocean of
+           truth lies all undiscovered before you.",
+    e_to Field
+  has light;
+
+[ Initialise;
+  location = Field;
+  "^^^^^Welcome to...^";
+];
+
+[ DrawStatusLine;
+   @split_window 1; @set_window 1; @set_cursor 1 1; style reverse;
+   spaces (0->33)-1;
+   @set_cursor 1 2;  PrintShortName(location);
+   @set_cursor 1 60; print "(as ";
+   @print_obj player;
+   print ")"; ! There ya are.
+   @set_cursor 1 1; style roman; @set_window 0;
+];
+
+Include "Grammar";
+
+Verb meta 'example'
+    *                                           -> Example;
+Verb 'smile'
+    *                                           -> Smile;
+

data/game/example.rb

@@ -0,0 +1,105 @@
+
+# ----------------------------------------------------------------------------
+#  Example
+# ----------------------------------------------------------------------------
+
+# DEBUG = true
+Story = "EXAMPLE"
+Headline = "\nAn Interactive Example\n" \
+           "Copyright (c) 2025 by Nels N. Nelson.\n"
+Release = 1
+
+def DrawStatusLine; end
+
+Include "Parser"
+Include "VerbLib"
+
+Field = Object("Field") {
+  with {
+    description "You are standing in a field in " \
+      "front of a small 19th century house which " \
+      "stands just to the east of you. The house " \
+      "hardly stands up to the stiff wind rolling " \
+      "down from the north."
+    e_to :HouseFoyer
+    w_to :Shingle
+  }
+  has :light
+}
+
+Field > Object("man wearing an old ragged military uniform") {
+  description "The man who stands before you is " \
+    "middle-aged, but somehow older. His uniform " \
+    "is old, ragged, dingy and faded. It is not " \
+    "clear which military he served in, but he " \
+    "almost certainly does not belong to any " \
+    "regiment any longer."
+  has :animate, :male
+  mod 'Huggable'
+}
+
+HouseFoyer = Object("Foyer") {
+  with {
+    description "You stand in the foyer of this " \
+      "ancient structure.  A draft swirls through " \
+      "the hallway to the east."
+    out_to :Field; w_to :Field
+  }
+  has :light
+}
+
+Property :weight
+
+# Note that the "with" directive here is vestigial and
+# can be discarded altogether, but is supported for
+# ease of transition/adoption.
+#
+# Field > Object("small toy top") {
+#   with {
+#     def before_examine
+#       "A totem, somehow familiar, made of brass" +
+#       (self.parent == player ? " and heavy in your hand" : '') + "."
+#     end
+#     weight 15 # grams
+#   }
+# }
+HouseFoyer > Object("small toy top") {
+  def before_examine
+    print "A totem, somehow familiar, made of brass"
+    print " and heavy in your hand" if self.parent == player
+    "."
+  end
+  weight 15 # grams
+}
+
+Shingle = Object("Shingle") {
+  with {
+    description "You seem to be only a small child " \
+      "playing on a sea-shore, and diverting yourself " \
+      "in finding a smoother pebble or a prettier shell " \
+      "than ordinary, whilst the great ocean of " \
+      "truth lies all undiscovered before you."
+    e_to :Field
+  }
+  has :light
+}
+
+class InformLibrary
+def Initialise
+  @location = Field
+  "\n\n\n\n\nWelcome to...\n"
+end
+end
+
+Include "Grammar"
+
+Inform::Grammar <<~EOT
+Verb meta 'example'
+    *                                           -> Example;
+Verb 'smile'
+    *                                           -> Smile;
+Extend only 'hug' replace
+    * noun                                      -> Hug;
+EOT
+
+# log.info "Finished loading example game file: #{__FILE__} #<#{self.class}:#{self.object_id}>"

data/game/forms/example_form.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+# frozen_string_literal: false

data/game/grammar/admin.inf.rb

@@ -0,0 +1,185 @@
+# game/grammar/admin.inf.rb
+# encoding: utf-8
+# frozen_string_literal: false
+
+# vi: set ft=ruby :
+# -*- mode: ruby -*-
+
+# Copyright Nels Nelson 2008-2025 but freely usable (see license)
+#
+# This file is part of the StoryTeller.
+#
+# The StoryTeller is free software: you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# The StoryTeller is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the StoryTeller.  If not, see <http://www.gnu.org/licenses/>.
+
+Verb meta 'admin' 'admins'
+    *                                           -> Admins;
+Verb meta 'as'
+    * id text                                   -> Action
+    * noun text                                 -> Action;
+Verb meta 'become'
+    * creature                                  -> Become;
+Verb meta 'bell'
+    *                                           -> Bell;
+Verb meta 'cache' 'cached'
+    *                                           -> Cache;
+Verb meta 'cat' 'concatenate'
+    * text                                      -> Concatenate;
+Verb meta 'characters'
+    *                                           -> Characters
+    * text                                      -> Characters;
+Verb meta 'classes'
+    *                                           -> Classes;
+Verb meta 'active' 'activities' 'events'
+    *                                           -> Active;
+Verb meta 'objects'
+    *                                           -> Objects
+    * 'as' special                              -> Objects;
+Extend meta only 'clear' first
+    *                                           -> Clear;
+Verb meta 'color' 'colors'
+    *                                           -> Color;
+Verb meta 'convert'
+    * topic 'to' special                        -> Color;
+Verb meta 'combat'
+    *                                           -> DebugCombat;
+Verb meta 'cpu'
+    *                                           -> Cpu;
+Verb meta 'create'
+    * 'account'/'user' text                     -> CreateUser;
+Verb meta 'debug'
+    *                                           -> Debug
+    * number                                    -> Debug;
+Verb meta 'export'
+    * id                                        -> Export
+    * noun                                      -> Export
+    * id 'as' special                           -> Export
+    * noun 'as' special                         -> Export;
+Verb meta 'import'
+    * text                                      -> Import;
+Verb meta 'flush'
+    *                                           -> Flush;
+Verb meta 'frequency'
+    *                                           -> Frequency
+    * number                                    -> Frequency;
+Verb meta 'grammars'
+    *                                           -> Grammars;
+Verb meta 'git'
+    * 'save'                                    -> GitSave
+    * 'save' text                               -> GitSave
+    * 'pull'                                    -> GitPull;
+Verb meta 'heal'
+    * number creature                           -> RestoreHealth
+    * creature text                             -> RestoreHealth
+    * creature                                  -> RestoreHealth
+    * noun=ABodyPart                            -> RestoreHealth;
+Verb meta 'host'
+    *                                           -> Host;
+Verb meta 'htop'
+    *                                           -> Htop;
+Verb meta 'id' 'identify'
+    * noun                                      -> Identify;
+Verb meta 'identities'
+    *                                           -> Identities;
+Verb meta 'interrupt'
+    *                                           -> Interrupt
+    * noun                                      -> Interrupt;
+Verb meta 'libraries'
+    *                                           -> Libraries;
+Verb meta 'library'
+    * 'methods'                                 -> LibraryMethods;
+Verb meta 'ls'
+    *                                           -> ListStats
+    * text                                      -> ListStats;
+Verb meta 'list'
+    * 'stats'                                   -> ListStats
+    * 'stats' text                              -> ListStats;
+Verb meta 'locate'
+    * scope=PlayerScope                         -> Locate;
+Verb meta 'logs'
+    *                                           -> Logs
+    * number                                    -> Logs;
+Verb meta 'memobjs'
+    *                                           -> EphemeralObjects;
+Verb meta 'method'
+    * special                                   -> Method
+    * noun special                              -> Method;
+Verb meta 'os'
+    *                                           -> Os;
+Verb meta 'peace'
+    *                                           -> Peace
+    * noun                                      -> Peace;
+Verb meta 'pid'
+    *                                           -> Pid;
+Extend meta 'random'
+    * number                                    -> SpecificallyPredictable;
+Verb meta 'prepositions'
+    *                                           -> Prepositions;
+Verb meta 'procs'
+    *                                           -> Procs;
+Verb meta 'profile'
+    *                                           -> Profile
+    * special                                   -> Profile;
+Verb meta 'gc'
+    *                                           -> GarbageCollection;
+Verb meta 'reload'
+    *                                           -> Reload;
+Verb meta 'reset'
+    * id                                        -> Reset
+    * noun                                      -> Reset;
+Extend meta 'restart' replace
+    *                                           -> Restart
+    * 'at' time                                 -> Restart
+    * 'in'/'after' duration                     -> Restart
+    * number                                    -> Restart;
+Verb meta 'resurrect'
+    * creature                                  -> Resurrect
+    * noun=ACorpse                              -> Resurrect;
+Verb 'res' = 'resurrect';
+Verb meta 'sessions'
+    *                                           -> Sessions;
+Verb meta 'shutdown'
+    *                                           -> Shutdown
+    * 'at' time                                 -> Shutdown
+    * 'in'/'after' duration                     -> Shutdown
+    * number                                    -> Shutdown;
+Verb meta 'solve'
+    * 'for' special 'where' text                -> Solve;
+Verb meta 'spells'
+    *                                           -> Spells;
+Verb meta 'state'
+    *                                           -> State
+    * scope=PlayerScope                         -> State
+    * scope=PlayerScope special                 -> State
+    * noun                                      -> State
+    * noun special                              -> State
+    * id                                        -> State
+    * id special                                -> State
+    * special                                   -> State;
+Verb meta 'stacktrace'
+    *                                           -> StackTrace;
+Verb meta 'system'
+    *                                           -> SystemSpecs
+    * 'reset'                                   -> ResetRuntime;
+Verb meta 'qwerty'
+    *                                           -> Test;
+Verb meta 'test'
+    *                                           -> Test
+    * special                                   -> Test
+    * number special                            -> Test;
+Verb meta 'thread'
+    *                                           -> Thread;
+Verb meta 'threads'
+    *                                           -> Threads;
+Verb meta 'vocabulary' 'dictionary' 'words'
+    *                                           -> Vocabulary;