scottkit 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6ee662e7fc97cdc7e349881932a08aa03c42d97
-  data.tar.gz: cde6d91a06116aa1c6cdb1d8b70f3b0ff6a5f155
+  metadata.gz: 58c4dae4b211e99dcccfd7b82cb0aa473aad1f68
+  data.tar.gz: f9edf19e1fd205974b290696aa5c702ec1674510
 SHA512:
-  metadata.gz: cec7ff05174bf3a85e809d05b9def638f56a414af2d1af5d34963cd68dc6a3f455011222783eb9aafec6a7950f8fb58e0dca07e16563e9091537dced62086df0
-  data.tar.gz: 97ee4663a82814e7f194874f05048a1cfec396dad4ff166efe8fae466c01af8e66465866220bab1c7f207fb36a6c62fbdd26062a5a2f32d40a46997741b2376d
+  metadata.gz: 2d4b434a5c7f9e55aa7ff6aaaef2f4276d3397566e7080f363e67832050b0f2c6cedb2a1d8d241f1e5651eec354d909a1884a06bdfbf5fb3e42f095b8b91fa77
+  data.tar.gz: f0717581ccbeab53a630db6e1a32048077fa6d04cbdf234138e64e8302a966427eaf508b7808c5782313f95b0f6fc7cf5f639b278e63da0d6be15b987a45828c

data/.travis.yml

@@ -0,0 +1,9 @@
+dist: trusty
+language: ruby
+rvm:
+- 2.0
+- 2.1
+- 2.2
+- 2.3
+- 2.4
+cache: bundler

data/.yardopts

@@ -1 +1 @@
---no-private bin/scottkit lib/**/.rb - ChangeLog.md GPL-2.txt notes/Definition.txt notes/Definition-saved-game.txt manual/reference.md
+--no-private bin/scottkit lib/**/.rb - ChangeLog.md GPL-2.txt docs/notes/Definition.txt docs/notes/Definition-saved-game.txt docs/reference.md

data/ChangeLog.md

@@ -1,11 +1,22 @@
 # Revision history for Ruby gem ScottKit
 
+## 1.6.0 (Wed Oct 25 00:19:29 BST 2017)
+
+* Emit "Your light is growing dim" message every five turns when less than 25 left.
+* When moving into a dark room, the description is no longer displayed before "It's too dark" message. Fixes #7.
+* Use a saved, non-moving copy of `t6.sck` in regression-tests. Avoids pointless failures when I work on the tutorials.
+* Do not omit scottkit.gemspec from git repo. Fixes #9.
+* Add support for Travis CI. Fixes #12.
+* Refactor main play loop to facilitate external driver code. Fixes #8.
+* Move all documentation into new `docs` directory. Fixes #17.
+* Rename `data` directory to `games`, and adjust test-suite etc. accordingly. Fixes #20.
+
 ## 1.5.0 (Fri Oct 20 00:38:57 BST 2017)
 
 * Improvements to _Nosferatu_. This game is now as close as I can make it to the 1982 original, including bug-compatibility for mis-spellings and the behaviour of water.
 * Minor improvements to tutorial map 4 and subsequent.
-* Add '--teleport' command-line option, which generates `teleport ROOM` actions for every room. For use in game development and debugging. Fixes issue #4.
-* Add '--superget' command-line option, which generates `sg ITEM` actions for every item. For use in game development and debugging. Fixes issue #5.
+* Add '--teleport' command-line option, which generates `teleport ROOM` actions for every room. For use in game development and debugging. Fixes #4.
+* Add '--superget' command-line option, which generates `sg ITEM` actions for every item. For use in game development and debugging. Fixes #5.
 * The `refill_lamp` action now works correctly. It seems it never did work, but I didn't notice because my walkthroughs of _Adventureland_ were too efficient to require lamp-refilling!
 
 ## 1.4.0 (Tue Oct 17 00:52:09 BST 2017)
@@ -19,7 +30,7 @@
 
 ## 1.3.0 (Mon Oct 16 20:27:43 BST 2017)
 
-* Support `--lint` (`-L`) command-line option. Fixes issue 1.
+* Support `--lint` (`-L`) command-line option. Fixes #1.
   Argument is a string of characters:
   * `e` -- check for rooms with no exits (traps)
   * `E` -- check for rooms with only one exit (dead ends)
@@ -94,4 +105,3 @@
 * Ensure that the right files are built by `YARD`
 * Maybe modify to run against GLK using the Glkx driver
 * File inclusion
-* "Your light is growing dim." -- see ScottFree

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gem "rake", "~> 12.0"
+gem "jeweler", "~> 2.0"
+gem "test-unit", "~> 3.2.0"

data/README.md

@@ -62,11 +62,11 @@ Unit testing can be done as follows:
 Game format
 -----------
 
-The file [`notes/Definition-scottfree-1.14.txt`](notes/Definition-scottfree-1.14.txt) is copied from the
+The file [`docs/notes/Definition-scottfree-1.14.txt`](docs/notes/Definition-scottfree-1.14.txt) is copied from the
 ScottFree package, which contains another interpreter for Scott Adams
 games.  I got this file from release 1.14-9 of ScottFree.
-[`notes/Definition.txt`](notes/Definition.txt) is my modified version of this file, since the
-original had several mistakes.  [`notes/Definition-saved-game.txt`](notes/Definition-saved-game.txt) is
+[`docs/notes/Definition.txt`](docs/notes/Definition.txt) is my modified version of this file, since the
+original had several mistakes.  [`docs/notes/Definition-saved-game.txt`](docs/notes/Definition-saved-game.txt) is
 my own analysis of the format of saved games from ScottFree.  (Saved
 games from ScottFree and ScottKit can be freely interchanged.)
 
@@ -102,13 +102,14 @@ in room 50 of 36.  None of Scott's own games is so sloppy.
 Documentation
 -------------
 
-* [ScottKit Tutorial](data/tutorial/tutorial.md)
-* [The ScottKit format reference manual](manual/reference.md)
+* [ScottKit Tutorial](docs/tutorial.md)
+* [The ScottKit format reference manual](docs/reference.md)
 * A series of blog-posts about ScottKit:
   * [Scottkit is born! Only seven and a half years late!](https://reprog.wordpress.com/2017/10/12/scottkit-is-born-only-seven-and-a-half-years-late/)
   * [Building adventure games with ScottKit](https://reprog.wordpress.com/2017/10/13/building-adventure-games-with-scottkit/)
   * [Rooms and items in ScottKit](https://reprog.wordpress.com/2017/10/14/rooms-and-items-in-scottkit/)
   * [Actions in ScottKit](https://reprog.wordpress.com/2017/10/16/actions-in-scottkit/)
   * [Occurrences (or daemons) in ScottKit](https://reprog.wordpress.com/2017/10/17/occurrences-or-daemons-in-scottkit/)
+  * [Darkness and light in ScottKit](https://reprog.wordpress.com/2017/10/21/darkness-and-light-in-scottkit/)
 
 

data/Rakefile

@@ -39,8 +39,6 @@ rescue LoadError
   end
 end
 
-task :test => :check_dependencies
-
 task :default => :test
 
 require 'rdoc/task'

data/VERSION

@@ -1 +1 @@
-1.5.0
+1.6.0

data/bin/scottkit

@@ -1,4 +1,5 @@
-#!/usr/local/bin/ruby -w
+#!/usr/bin/env ruby
+$VERBOSE = true
 
 # Command-line driver for the ScottKit toolkit, allowing Scott
 # Adams-format adventure games to be compiled, decompiled and played.
@@ -35,7 +36,7 @@ sleep_at_end = false
 
 opts = OptionParser.new do |x|
   x.banner = "Usage: #$0 [options] [<data-file>]
-(ScottKit version 1.4.0)"
+(ScottKit version 1.5.0)"
   x.on("-c", "--compile", "Compile <data-file> instead of loading") {
     mode = :compile
   }

data/{manual → docs}/reference.md

@@ -903,7 +903,7 @@ first.
 ## See also
 
 * The top-level [README](../README.md)
-* [The ScottKit tutorial](../data/tutorial/tutorial.md)
+* [The ScottKit tutorial](tutorial.md)
 * The Perl module [Games::ScottAdams](http://search.cpan.org/~mirk/Games-ScottAdams/)
 
 

data/{data/tutorial → docs}/tutorial.md

@@ -249,7 +249,7 @@ occur 25% when here vampire and !carried cross
 	game_over
 	comment "vampire can attack unless cross is carried"
 
-action get key when present vampire and !carried cross
+action get key when here vampire and !carried cross
 	print "I'm not going anywhere near that vampire!"
 ```
 
@@ -269,7 +269,7 @@ This stage uses the directives from the previous stage, plus `lightsource`, `occ
 		|		|
 		|		|
 Cave Mouth------Chamber---------Dungeon
-		[cross]		[door]
+[station]	[cross]		[door]
 				=
 				|
 				Cell
@@ -287,6 +287,11 @@ action score: score
 action inventory: inventory
 action look: look
 
+occur when !flag 1
+	print "Welcome to the Tutorial adventure."
+	print "You must find a gold coin and store it."
+	set_flag 1
+
 room cave "cave mouth"
 	exit east chamber
 
@@ -298,7 +303,32 @@ item sign "Sign says: leave treasure here, then say SCORE"
 item lamp "old-fashioned brass lamp"
 	called "lamp"
 
-lightsource lamp
+item lit_lamp "lit lamp"
+	called "lamp" nowhere
+
+item empty_lamp "empty lamp"
+	called "lamp" nowhere
+
+lightsource lit_lamp
+lighttime 10
+
+action light lamp when present lamp
+	swap lamp lit_lamp
+	print "OK, lamp is now lit and will burn for 10 turns."
+	look
+
+occur when flag 16
+	clear_flag 16
+	swap lit_lamp empty_lamp
+	look
+	comment "The engine sets flag 16 when the lamp runs out"
+
+item station "lamp-refilling station" at cave
+
+action refill lamp when here station and present empty_lamp
+	destroy empty_lamp
+	refill_lamp
+	print "The lamp is now full and lit."
 
 room chamber "square chamber"
 	exit east dungeon
@@ -356,29 +386,29 @@ room crypt "damp, dismal crypt"
 
 item vampire "Vampire"
 
-occur 25% when here vampire and !carried cross
-	print "Vampire bites me!  I'm dead!"
-	game_over
-	comment "vampire can attack unless cross is carried"
+occur when here vampire and carried cross
+	print "Vampire cowers away from the cross!"
 
 occur when here vampire and !carried cross
 	print "Vampire looks hungrily at me."
 
-occur when here vampire and carried cross
-	print "Vampire cowers away from the cross!"
+occur 25% when here vampire and !carried cross
+	print "Vampire bites me!  I'm dead!"
+	game_over
+	comment "vampire can attack unless cross is carried"
 
-action get key when present vampire and !carried cross
+action get key when here vampire and !carried cross
 	print "I'm not going anywhere near that vampire!"
 
-verbgroup take get
-verbgroup leave drop
+verbgroup get take g
+verbgroup drop leave
 noungroup lamp lantern
 ```
 
 
 ## Caveats
 
-This tutorial skips a lot of details. [The reference manual](../../manual/reference.md) is indispensible for filling in the gaps.
+This tutorial skips a lot of details. [The reference manual](../../docs/reference.md) is indispensible for filling in the gaps.
 
 The following directives are not yet discussed: `ident`, `version`, `wordlen`, `maxload`, `lighttime`.
 

data/{data → games}/crystal/crystal.map

@@ -30,12 +30,16 @@ Hut-------------Clearing--------Glade--->CLIMB, <Down---Top of Beech
 		[bear]		[pool]
 		|		vGO POOL, ^Up
 		|		|
-		Forest Path	In Pool
-		[vase]		[inflow]
-	 ______/(why here?!)	vGO INFLOW
+		Forest Path	On pool
+		[vase]		|
+	 ______/(why here?!)	|
 	/			|
-	Inside vase		River1
-	[key]			|
+	Inside vase		In Pool
+	[key]			[inflow]
+				vGO INFLOW
+				|
+				River1
+				|
 				|
 				|
 				River2
@@ -110,3 +114,13 @@ single-location maze
 
 giant frogs bars your way.  kiss => turns to prince
 
+---
+
+"The stoat was broken into five pieces. We were going to scatter them
+across the kingdom, but we never go around to it, so they're all in
+this cupboard."
+
+But you'll need some glue
+
+And it turns out to be two-part epoxy
+

data/{data/test → games/crystal}/crystal.sck

@@ -9,7 +9,6 @@ ident 18400
 version 1
 wordlen 3
 maxload 5
-lighttime 100
 start hut
 treasury hut
 
@@ -17,7 +16,7 @@ treasury hut
 verbgroup go enter follow run walk
 verbgroup take get
 verbgroup leave drop
-#verbgroup cut chop ### currently causes a collision
+verbgroup cut chop
 verbgroup batter ram
 
 # ----------------------------------------------------------------------------
@@ -30,13 +29,13 @@ action save game: save_game
 action look: look
 
 # The path is dark; nowhere else is
-occur when "at" path
+occur when "at" path and !flag 15
 	set_dark
-	###look # Hard to make this work right in a non-curses driver
+	look
 
-occur when !at path
+occur when !at path and flag 15
 	clear_dark
-	###look # Hard to make this work right in a non-curses driver
+	look
 
 occur when !flag 1
 	set_flag 1
@@ -484,7 +483,7 @@ room forest2 "forest"
 item pool "Bubbling pool"
 
 action go pool when here pool
-	goto pool
+	goto onpool
 	look2
 
 action hold breath when counter_gt 0
@@ -494,8 +493,13 @@ action hold breath
 	set_counter 6
 	print "OK"
 
+room onpool "bubbling pool, treading water"
+	exit north forest2
+	exit down pool
+
 room pool "bubbling pool, just below the water level"
-	exit up forest2
+	exit up onpool
+	exit south river1
 
 item inflow "inflow from the south"
 

data/{data → games}/crystal/crystal.solution

@@ -55,8 +55,9 @@ get vase
 north
 east
 examine vase
-hold breath
 go pool
+hold breath
+down
 go inflow
 south
 drop vase
@@ -80,6 +81,7 @@ north
 north
 up
 north
+north
 west
 west
 drop stoat

data/{data → games}/nosferatu/nosferatu.transcript

@@ -150,12 +150,12 @@ I'm in the kitchen.
 Obvious exits: North, South.
 
 Tell me what to do ? n
+I feel weaker.
 
 I'm in the washroom.
 Obvious exits: South, East.
 I can also see: locked Door
 
-I feel weaker.
 Tell me what to do ? open door
 OK.
 
@@ -480,11 +480,6 @@ Tell me what to do ? drop ladder
 O.K.
 Tell me what to do ? go tunnel
 
-I'm in a subterranean cavern.
-Obvious exits: South.
-I can also see: Stalactites hanging from the ceiling
-
-
 I can't see. It is too dark!
 
 Tell me what to do ? light lamp
@@ -531,10 +526,6 @@ I can also see: sharp Axe, spent Match, entrance to cave
 
 Tell me what to do ? s
 
-I'm at the bottom of a deep hole.
-I can also see: tall Ladder, secret Tunnel
-
-
 I'm at the bottom of a deep hole.
 I can also see: tall Ladder, secret Tunnel
 

data/{data → games}/test/adams/adv01.transcript

@@ -167,9 +167,6 @@ I can't see. It is too dark!
 Tell me what to do ? up
 Dangerous to move in the dark!
 
-I can't see. It is too dark!
-
-
 I'm in a semi-dark hole by the root chamber
 Obvious exits: Up.
 I can also see: Open door with a hallway beyond
@@ -270,11 +267,6 @@ Obvious exits: Up, Down.
 
 Tell me what to do ? u
 
-I'm in a semi-dark hole by the root chamber
-Obvious exits: Up.
-I can also see: Open door with a hallway beyond
-
-
 I'm in a semi-dark hole by the root chamber
 Obvious exits: Up.
 I can also see: Open door with a hallway beyond
@@ -423,11 +415,6 @@ Obvious exits: Up, Down.
 
 Tell me what to do ? u
 
-I'm in a semi-dark hole by the root chamber
-Obvious exits: Up.
-I can also see: Open door with a hallway beyond
-
-
 I'm in a semi-dark hole by the root chamber
 Obvious exits: Up.
 I can also see: Open door with a hallway beyond
@@ -579,11 +566,6 @@ Obvious exits: Up, Down.
 
 Tell me what to do ? u
 
-I'm in a semi-dark hole by the root chamber
-Obvious exits: Up.
-I can also see: Open door with a hallway beyond
-
-
 I'm in a semi-dark hole by the root chamber
 Obvious exits: Up.
 I can also see: Open door with a hallway beyond
@@ -767,12 +749,12 @@ I can also see: Large outdoor Advertisement, Hole
 
 Tell me what to do ? w
 
+I'm bitten by chiggers.
+
 I'm in a dismal swamp
 Obvious exits: North, East, West.
 I can also see: -HOLLOW- stump and remains of a felled tree, Evil smelling mud, Swamp gas, Patches of "OILY" slime, Chiggers
 
-
-I'm bitten by chiggers.
 Tell me what to do ? take mud
 O.K.
 OK

data/games/test/adams/adv01.transcript.md5

@@ -0,0 +1 @@
+b4ba5e712ab8b5350d5d24580f427587