scottkit 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e80e01217ac415c8a5f61c8f76e79b143bb9634c
-  data.tar.gz: bd464ca8f5bd0f4db93aae2e85c2405b87d78efe
+  metadata.gz: 6dbab5b1732fb1083bc1bde984fc949d4448221d
+  data.tar.gz: 2eefd8bcac336e7b36381047aab7bf958cfa341c
 SHA512:
-  metadata.gz: 8a2c8559a16971027c380eb6f8ebf0b013bc6e74192bef684cac5fbe6d80cea2a7dbec2e763d8065ff9a2d9b8dcc0dbeedb07aeb98beeb093518253f976500cf
-  data.tar.gz: df62ce26c9a33c8d22b8db3617b1802f02a0bb60f31410ee717380949cd828ddf3f3403a2c1eb6f685c39c38675b159bbe7920616501454f4998937e9f2fc838
+  metadata.gz: d41f64b9025f7825bcfbcc8fdd8e660e0e5a3777a4c855e2041b758efeb67790e430993eba9e9dc8c14da31a6293725c1b6906ac0f90a7843309d9a460a761c9
+  data.tar.gz: 5b70bf92bcbe3ec32c32b08efb60ed67fb6dfa9db6373f25a2414e85c0a91ddec52516eb8595a90dc8486aea32908612c60aade279f6772b015c78bb337a032b

data/ChangeLog.md

@@ -1,5 +1,14 @@
 # Revision history for Ruby gem ScottKit
 
+## 1.4.0 (Tue Oct 17 00:52:09 BST 2017)
+
+* Fix v1.3.0 bug: hasty implementation of lint meant compilation would fail if no lint option was provided. Now works correctly again.
+* Play mode no longer crashes on an empty line of input
+* Add support for opcode 84 `print_noun` (without newline).
+* Remove ScottKit version number from startup message in play mode, as it messes up regression tests. It's in the usage message now.
+* New file, `bin/md5ruby`: needed for regenerating regresssion expectations, since the `md5` program on MacOS produces different results from Ruby's MD5 digest when given non-ASCII input. Use this for regenerating `data/test/adams/*.md5`
+* The reimplementation of _Nosferatu_ is now complete in that it is possible to play the game through to a successful completion. However, it's not ready for release, as many incorrect actions still need to be handled gracefully.
+
 ## 1.3.0 (Mon Oct 16 20:27:43 BST 2017)
 
 * Support `--lint` (`-L`) command-line option. Fixes issue 1.

data/VERSION

@@ -1 +1 @@
-1.3.0
+1.4.0

data/bin/md5ruby

@@ -0,0 +1,10 @@
+#!/usr/local/bin/ruby -w
+
+# It seems we need this because the md5 program on MacOS produces
+# different results from Ruby's MD5 digest when given non-ASCII input.
+
+require 'digest/md5'
+
+file = File.open(ARGV[0], "rb")
+contents = file.read
+puts Digest::MD5.hexdigest(contents)

data/bin/scottkit

@@ -34,7 +34,8 @@ options = {}
 sleep_at_end = false
 
 opts = OptionParser.new do |x|
-  x.banner = "Usage: #$0 [options] [<data-file>]"
+  x.banner = "Usage: #$0 [options] [<data-file>]
+(ScottKit version 1.4.0)"
   x.on("-c", "--compile", "Compile <data-file> instead of loading") {
     mode = :compile
   }

data/data/nosferatu/nosferatu.regression

@@ -1,14 +1,14 @@
 19540
 55
-67
-44
+72
+45
 33
 5
 2
 1
 3
 999
-44
+49
 1
 
 750 0 0 0 0 0 9900 0
@@ -33,52 +33,57 @@
 2111 203 302 300 320 0 10812 9600
 161 322 300 0 0 0 8100 0
 162 382 260 0 0 0 8100 0
-2400 425 420 0 0 0 7966 0
+2400 425 420 0 0 0 2488 2603
 163 422 280 0 0 0 8100 0
 2714 442 921 920 980 0 8303 10950
-0 440 480 0 0 0 10817 9600
-2565 522 0 0 0 0 2788 2913
-1200 484 680 700 0 0 10820 9600
+0 440 480 0 0 0 10818 9600
+2565 522 100 0 0 0 2908 0
+100 108 1101 0 0 0 3021 3363
+100 108 1106 0 0 0 3513 0
+1200 484 680 700 0 0 10824 9600
 166 702 620 0 0 0 8100 0
-1967 562 500 0 0 0 8100 0
+1967 562 624 500 560 0 8153 0
+1967 562 524 500 560 0 8153 0
 3000 544 580 0 0 0 8100 0
 3000 584 540 0 0 0 8100 0
-1518 283 942 280 980 920 3222 11100
-3168 921 920 980 280 0 3205 10800
-3319 552 0 0 0 0 3300 0
-3319 40 0 0 0 0 3508 0
+1518 283 942 280 980 920 3822 11100
+3168 921 920 980 280 0 3805 10800
+3319 552 0 0 0 0 3900 0
+3319 40 0 0 0 0 4108 0
 3461 48 602 40 540 0 9053 10950
-0 600 620 0 0 0 10824 9600
+0 600 620 0 0 0 10828 9600
 161 622 440 0 0 0 8100 0
 3471 48 1022 40 540 0 9053 10950
-0 1020 1040 0 0 0 10824 9600
-3450 48 40 540 0 0 9053 1825
+0 1020 1040 0 0 0 10828 9600
+3450 48 40 540 0 0 9053 1829
 172 1042 660 0 0 0 8100 0
-3623 1062 0 20 0 0 1826 4112
-3774 40 0 0 0 0 4254 0
-3925 0 0 0 0 0 4350 0
-3926 104 0 0 0 0 4586 13231
-3927 103 0 0 0 0 4800 0
-3928 123 0 0 0 0 4950 0
-3908 143 0 0 0 0 5100 0
-4079 263 0 0 0 0 1835 5473
+3623 1062 0 20 0 0 1830 4712
+3774 40 0 0 0 0 4854 0
+3925 0 0 0 0 0 4950 0
+3926 104 0 0 0 0 5186 13235
+3927 103 0 0 0 0 5400 0
+3928 123 0 0 0 0 5550 0
+3908 143 0 0 0 0 5700 0
+4079 263 0 0 0 0 1839 6073
 0 260 280 80 0 0 10858 0
-2130 22 88 40 80 0 5603 8014
-2130 22 0 0 0 0 5700 0
-1531 42 40 60 0 0 5905 7950
-1532 62 0 0 0 0 6000 0
+2130 22 88 40 80 0 6203 8014
+2130 22 0 0 0 0 6300 0
+1531 42 40 60 0 0 6505 7950
+1532 62 0 0 0 0 6600 0
 4233 541 802 800 820 0 10873 0
-0 840 860 0 0 0 10821 0
+0 840 860 0 0 0 10825 0
 183 822 600 0 0 0 8100 0
 184 462 220 0 0 0 8100 0
 185 1002 640 0 0 0 8100 0
-4386 483 480 180 0 0 10821 9600
-4500 0 0 0 0 0 6150 0
-4650 0 0 0 0 0 6385 0
-2400 0 0 0 0 0 3750 0
-3000 0 0 0 0 0 6450 0
-1200 0 0 0 0 0 6600 0
-4800 0 0 0 0 0 9600 0
+4386 483 480 180 0 0 10825 9600
+4537 1062 0 0 0 0 1885 12973
+0 0 0 0 0 0 6814 0
+4650 0 0 0 0 0 6900 0
+4800 0 0 0 0 0 7135 0
+2400 0 0 0 0 0 4350 0
+3000 0 0 0 0 0 7200 0
+1200 0 0 0 0 0 7350 0
+4950 0 0 0 0 0 9600 0
 
 "AUT" "ANY"
 "WAL" "NOR"
@@ -110,13 +115,14 @@
 "DRI" "ATL"
 "CHO" "MAG"
 "LIG" "WHI"
-"HEL" "SAR"
-"EXA" "BOD"
-"LOO" "DUS"
-"*L" "THI"
-"" "HOL"
+"SAY" "SAR"
+"HEL" "BOD"
+"EXA" "DUS"
+"LOO" "THI"
+"*L" "HOL"
 "" "TUN"
 "" "LAM"
+"" "OVY"
 "" "CRO"
 "" "KEY"
 "" "KIP"
@@ -168,7 +174,7 @@
 "  Translation to ScottKit starting Saturday 14 October 2017"
 "This is a demo for the `ScottKit` adventure system --"
 "See https://github.com/MikeTaylor/scottkit/"
-"Your task is to kill the evil count Nosferatu and get back home."
+"Your task: kill the evil count Nosferatu and return home with his bloodstone."
 "I'll need a spade."
 "Nosferatu rises from his altar, and bites my neck!"
 "Huh?  What rope?"
@@ -178,10 +184,14 @@
 "Huh?"
 "I'm too heavy:
 I fall!"
-"The bus arrives."
+"Time passes..."
+"A bus arrives!"
 "The witch drinks the water, rejuvenates, drops something, and disappears!"
-"He takes them and rings a bell.  The bus starts."
-"You arrive home."
+"He takes them, the bus starts, and I'm home"
+"with Nosferatu's Bloodstone."
+"* Congratulations *"
+"You win!"
+"without Nosferatu's Bloodstone."
 "I break through to an underground chamber!"
 "OK"
 "Huh?  What axe?"
@@ -209,6 +219,7 @@ Bored with this game already, huh?"
 "The lid's too heavy!"
 "It turns to dust!"
 "It slips through my fingers"
+"Nosferatu vanishes in a cloud of smoke!"
 "You'll have to figure it out for yourself."
 "It looks like a pretty average"
 "Wheee!"
@@ -322,6 +333,9 @@ Bored with this game already, huh?"
 ""
 ""
 ""
+""
+""
+""
 "cont"
 ""
 ""
@@ -334,6 +348,8 @@ Bored with this game already, huh?"
 ""
 "We only really want to look if it was previously dark. Can do this with flags."
 ""
+"cont"
+""
 ""
 ""
 ""

data/data/nosferatu/nosferatu.sck

@@ -6,6 +6,7 @@
 # 2: THROW AXE has been issued: awaiting AT THING
 # 3: TIE ROPE has been issued: awaiting TO THING
 # 4: Whisky has been drunk
+# 5: On the bus-journey home
 
 ident 18401
 version 1
@@ -229,7 +230,7 @@ occur when !flag 1
 	print "This is a demo for the `ScottKit` adventure system --"
 	print "See https://github.com/MikeTaylor/scottkit/"
 	println
-	print "Your task is to kill the evil count Nosferatu and get back home."
+	print "Your task: kill the evil count Nosferatu and return home with his bloodstone."
 
 action DIG when !present spade
 	print "I'll need a spade."
@@ -292,8 +293,10 @@ action GO GRAVE when here grave
 	goto cave
 
 action WAIT when !here bus
+	print "Time passes..."
+	pause
+	print "A bus arrives!"
 	drop bus
-	print "The bus arrives."
 
 action GO BUS when here bus
 	goto bus
@@ -307,9 +310,17 @@ action DROP BOTTLE when here witch and carried water
 	look
 
 action GIVE COINS when here conductor
-	print "He takes them and rings a bell.  The bus starts."
-	pause
-	print "You arrive home."
+	print "He takes them, the bus starts, and I'm home"
+	set_flag 5
+
+occur when flag 5 and carried bloodstone
+	print "with Nosferatu's Bloodstone."
+	print "* Congratulations *"
+	print "You win!"
+	game_over
+
+occur when flag 5 and !carried bloodstone
+	print "without Nosferatu's Bloodstone."
 	game_over
 
 action DIG when at field
@@ -320,8 +331,13 @@ action DIG when at field
 action GO PIT when here pit
 	goto bottom
 
-action CLIMB LADDER when here ladder
+action CLIMB LADDER when here ladder and at bottom
+	goto forest
+	drop ladder
+
+action CLIMB LADDER when here ladder and at inpit
 	goto forest
+	drop ladder
 
 action JUMP when at bythicket
 	goto chasm
@@ -448,6 +464,13 @@ action LIGHT LAMP when present lamp
 	look
 	comment "We only really want to look if it was previously dark. Can do this with flags."
 
+action SAY OVYEZ when here count
+       print "OK."
+       println_noun
+       println
+       print "Nosferatu vanishes in a cloud of smoke!"
+       look
+
 action HELP:
 	print "You'll have to figure it out for yourself."
 

data/data/nosferatu/nosferatu.script

@@ -1,6 +1,6 @@
 ScottKit, a Scott Adams game toolkit in Ruby.
-Release 1.2, (C) 2010-2017 Mike Taylor <mike@miketaylor.org.uk>
-Distributed under the GNU software license
+(C) 2010-2017 Mike Taylor <mike@miketaylor.org.uk>
+Distributed under the GNU GPL version 2 license,
 
 I'm in a tall, satin-lined wooden box.
 Obvious exits: East.
@@ -449,4 +449,105 @@ Obvious exits: South.
 I can also see: sharp Axe, safety Match, entrance to cave
 
 Tell me what to do ? go entrance		(Just "n" in the original, where a new exit opens)
-Tell me what to do ? 
+Tell me what to do ? say ovyez
+OK.
+ovyez
+
+Nosferatu vanishes in a cloud of smoke!
+
+I'm in a cavern where the count sleeps.
+Obvious exits: South.
+I can also see: the count Nosferatu, stone Altar, giant *BLOODSTONE*
+
+Tell me what to do ? get bloodstone
+O.K.
+Tell me what to do ? s
+
+I'm in a subterranean cavern.
+Obvious exits: South.
+I can also see: sharp Axe, safety 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
+
+Tell me what to do ? climb ladder
+Tell me what to do ? get ladder
+O.K.
+Tell me what to do ? w
+
+I'm at the bottom of a disused cesspit.
+I can also see: golden Coins
+
+Tell me what to do ? drop ladder
+O.K.
+Tell me what to do ? drop lamp
+O.K.
+Tell me what to do ? get coins
+O.K.
+Tell me what to do ? climb ladder
+Tell me what to do ? n
+
+I'm in a sunny field.
+Obvious exits: North, South, East, West.
+I can also see: garden Spade, Pit in the ground
+
+Tell me what to do ? e
+
+I'm on a track. To my North is a bridge over a pond.
+Obvious exits: North, East, West.
+
+Tell me what to do ? e
+
+I'm in a damp swamp.
+Obvious exits: North, West.
+
+Tell me what to do ? n
+
+I'm by a fishpond ...
+Obvious exits: South, East.
+I can also see: maneating Shark!
+
+Tell me what to do ? e
+
+I'm in a rather dark yard.
+Obvious exits: North, East, West.
+
+Tell me what to do ? e
+
+I'm in the washroom.
+Obvious exits: South, East.
+I can also see: brass Key, wide open Door
+
+Tell me what to do ? e
+
+I'm in the mortuary.
+Obvious exits: North, West.
+I can also see: 7-pound Mallet
+
+Tell me what to do ? n
+
+I'm in a desolate windswept graveyard.
+Obvious exits: North, South.
+I can also see: newely dug open Grave, tombstone engraved: BEWARE THE WITCH
+
+Tell me what to do ? n
+
+I'm by a bus-stop.
+Obvious exits: South.
+
+Tell me what to do ? wait
+Time passes...
+A bus arrives!
+Tell me what to do ? go bus
+Tell me what to do ? give coins
+He takes them, the bus starts, and I'm home
+with Nosferatu's Bloodstone.
+* Congratulations *
+You win!
+The game is now over.

data/data/nosferatu/nosferatu.sol

@@ -102,3 +102,26 @@ drop match
 throw axe
 at stalactite
 go entrance		(Just "n" in the original, where a new exit opens)
+say ovyez
+get bloodstone
+s
+s
+climb ladder
+get ladder
+w
+drop ladder
+drop lamp
+get coins
+climb ladder
+n
+e
+e
+n
+e
+e
+e
+n
+n
+wait
+go bus
+give coins

data/data/test/Makefile

@@ -6,13 +6,8 @@ RUN = ruby -I ../../lib ../../bin/scottkit
 **default**:
 	@echo "Use 'make rebuild' if you are SURE that the software is correct"
 
-rebuild: rebuild-decompile rebuild-play
-
-rebuild-decompile:
-	$(RUN) -d ../adams/adv01.dat > adv01.decompile
-
-rebuild-play:
-	### Rebuild crystal, etc.
-
-.PHONY: rebuild rebuild-decompile rebuild-play
+rebuild:
+	$(RUN) -e -s 12368 -W -f crystal.solution crystal.sao > crystal.transcript
+	$(RUN) -e -s 12368 -W -f t7.solution t7.sao > t7.transcript
 
+.PHONY: rebuild

data/data/test/adams/Makefile

@@ -9,5 +9,5 @@ RUN = ruby -I ../../../lib ../../../bin/scottkit
 rebuild:
 	for i in 01 02 04; do \
 		$(RUN) -e -s 12368 -W ../../adams/adv$$i.dat < adv$$i.solution > adv$$i.transcript; \
-		md5sum adv$$i.transcript | sed 's/ .*//' > adv$$i.transcript.md5; \
+		ruby ../../../bin/md5ruby adv$$i.transcript > adv$$i.transcript.md5; \
 	done

data/data/test/adams/adv01.transcript

@@ -1,6 +1,6 @@
 ScottKit, a Scott Adams game toolkit in Ruby.
-Release 1.2, (C) 2010-2017 Mike Taylor <mike@miketaylor.org.uk>
-Distributed under the GNU software license
+(C) 2010-2017 Mike Taylor <mike@miketaylor.org.uk>
+Distributed under the GNU GPL version 2 license,
 Setting random seed 12368
 
 I'm in a forest

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

@@ -1 +1 @@
-576e575853afb08544be86a894c2eeb3
+5da0e1d1edd6e3528e3fdec3d2ac5fb5

data/data/test/adams/adv02.transcript

@@ -1,6 +1,6 @@
 ScottKit, a Scott Adams game toolkit in Ruby.
-Release 1.2, (C) 2010-2017 Mike Taylor <mike@miketaylor.org.uk>
-Distributed under the GNU software license
+(C) 2010-2017 Mike Taylor <mike@miketaylor.org.uk>
+Distributed under the GNU GPL version 2 license,
 Setting random seed 12368
 
 I'm in a Flat in london

data/data/test/adams/adv02.transcript.md5

@@ -1 +1 @@
-3bb5e7f4c0f04269c257611284916a09
+d2518916f6fee28cf82a5f17f0cde49e

data/data/test/adams/adv04.transcript

@@ -1,6 +1,6 @@
 ScottKit, a Scott Adams game toolkit in Ruby.
-Release 1.2, (C) 2010-2017 Mike Taylor <mike@miketaylor.org.uk>
-Distributed under the GNU software license
+(C) 2010-2017 Mike Taylor <mike@miketaylor.org.uk>
+Distributed under the GNU GPL version 2 license,
 Setting random seed 12368
 
 I'm in a chapel

data/data/test/adams/adv04.transcript.md5

@@ -1 +1 @@
-82ecf3d6b958ae54bb947ccbf40c55e4
+981b24607d46cdaea4b696d43439319f

data/data/test/crystal.transcript

@@ -1,6 +1,6 @@
 ScottKit, a Scott Adams game toolkit in Ruby.
-Release 1.2, (C) 2010-2017 Mike Taylor <mike@miketaylor.org.uk>
-Distributed under the GNU software license
+(C) 2010-2017 Mike Taylor <mike@miketaylor.org.uk>
+Distributed under the GNU GPL version 2 license,
 Setting random seed 12368
 
 I'm in a small wooden hut.

data/data/test/t7.transcript

@@ -1,6 +1,6 @@
 ScottKit, a Scott Adams game toolkit in Ruby.
-Release 1.2, (C) 2010-2017 Mike Taylor <mike@miketaylor.org.uk>
-Distributed under the GNU software license
+(C) 2010-2017 Mike Taylor <mike@miketaylor.org.uk>
+Distributed under the GNU GPL version 2 license,
 Setting random seed 12368
 
 I'm in a cave mouth

data/lib/scottkit/compile.rb

@@ -209,7 +209,7 @@ module ScottKit
 
 
       def generate_code(tree)
-        lintOptions = @game.options[:lint]
+        lintOptions = @game.options[:lint] || ''
         @had_errors = false
         rooms = tree.rooms
         items = tree.items

data/lib/scottkit/play.rb

@@ -15,8 +15,8 @@ module ScottKit
       @lampleft = defined?(@lamptime) ? @lamptime : 0
 
       puts "ScottKit, a Scott Adams game toolkit in Ruby."
-      puts "Release 1.2, (C) 2010-2017 Mike Taylor <mike@miketaylor.org.uk>"
-      puts "Distributed under the GNU software license"
+      puts "(C) 2010-2017 Mike Taylor <mike@miketaylor.org.uk>"
+      puts "Distributed under the GNU GPL version 2 license,"
 
       if file = options[:restore_file]
         restore(file)
@@ -44,6 +44,10 @@ module ScottKit
           break
         end
         words = line.chomp.split
+        if words.length == 0
+          puts "I don't understand your command."
+          next
+        end
         execute_command(words[0], words[1])
         if items.size > ITEM_LAMP &&
             items[ITEM_LAMP].loc != ROOM_NOWHERE && @lampleft > 0
@@ -429,7 +433,7 @@ module ScottKit
             @game.counters[which], @game.counter
         when 82 then @game.counter += args.shift
         when 83 then @game.counter -= args.shift
-        #84 print_noun unused in Adventureland/Pirate
+        when 84 then print @game.noun
         when 85 then puts @game.noun
         when 86 then puts
         when 87 then which = args.shift

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scottkit
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Mike Taylor
@@ -14,6 +14,7 @@ description: ScottKit is a toolkit for compiling, decompiling and playing advent
   games in the Scott Adams format.
 email: mike@miketaylor.org.uk
 executables:
+- md5ruby
 - scottkit
 extensions: []
 extra_rdoc_files:
@@ -26,6 +27,7 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- bin/md5ruby
 - bin/scottkit
 - data/.gitignore
 - data/adams/.gitignore