scottkit 0.4.0 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 26ccefb089e59a1db6c06ff509373ed0c9f97ee1
+  data.tar.gz: ff2d2488c57754958e723dfa49274cbcb102aff6
+SHA512:
+  metadata.gz: 988ec02e55c50a140b2347b3134e5be8d7abe69a3e6f6837c04be2ef32a792d6146f352663ffd90523c0c9d61af565911db52696615021ac7a99f4106088d6ea
+  data.tar.gz: f9bdc3f3aded8deb5f67cdef493f40294cb8ba90796ff612a0d39db5f1efa7f51453e1f50f01ad4950ce948d0327da8c2210ae5065657d5d57bc25e7ec8c835d

data/.yardopts

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

data/ChangeLog.md

@@ -0,0 +1,50 @@
+Revision history for Ruby gem ScottKit
+======================================
+
+1.0.0 (IN PROGRESS)
+-------------------
+* Finish translating reference guide from POD to MarkDown.
+* Update reference guide to describe ScottKit format rather then Games::ScottAdams format.
+* Fix handling of darkness when playing games.
+* Support unquoted "carried" and "at" in conditions
+
+0.4.0 (Mon Mar  1 22:20:09 GMT 2010)
+------------------------------------
+* Move towards using YARD for documentation instead of Rdoc.  This
+  includes changes to things like the format of the Changes file.  Far
+  from perfect so far: for example, plain-text documentation like
+  `doc/Definition` gets mangled.
+
+0.3.0 (February 28, 2010)
+-------------------------
+* Move ScottKit out of its sub-siubdirectory in the 9Gb `mike`
+  git module into its own git module.
+* Move repository hosting to github.
+* Arrange for formatted documentation to appear at
+  [http://rdoc.info/projects/MikeTaylor/scottkit](http://rdoc.info/projects/MikeTaylor/scottkit)
+
+0.2.0 (February 28, 2010)
+-------------------------
+* Add `-z` option to sleep after finishing - useful when running in a
+  DOS Shell under Windows, so that error messages can be seen.
+* Add facility to load a game while playing, using `#load`
+
+0.1.0 (February 28, 2010)
+-------------------------
+* Add `-p` option to compile and play a game from source.
+
+0.0.0 (February 28, 2010)
+-------------------------
+* Initial release.
+
+
+Still to do
+===========
+
+* Tweak compiler to break actions when they need too many arguments as
+  well as when they need too many instructions.
+* Write tutorial scaffolding.
+* Ensure that the right files are built by `YARD`
+* Write blog entry about ScottKit
+* Maybe modify to run against GLK using the Glkx driver
+* File inclusion

data/README.md

@@ -0,0 +1,100 @@
+ScottKit - a toolkit for Scott Adams-style adventure games
+==========================================================
+
+**Homepage**:  [http://rdoc.info/projects/MikeTaylor/scottkit](http://rdoc.info/projects/MikeTaylor/scottkit)   
+**Git**:       [http://github.com/MikeTaylor/scottkit](http://github.com/MikeTaylor/scottkit)   
+**Author**:    Mike Taylor <mike@miketaylor.org.uk>   
+**Copyright**: 2009-2010   
+**License**:   GNU GPL, version 2 - see file GPL-2
+
+
+Synopsis
+--------
+
+This is a Ruby program to compile, decompile and run adventure games
+in Scott Adams format, including those created by the great man
+himself.  ScottKit's good for nostalgia freaks wanting to relive the
+classic games of the 1980s, but also as a tool for creating small,
+concise, new games.
+
+It was intially written as an exercise in Ruby rather than with any
+great expectation that it would be useful, but it turns out to work
+pretty well as a tight, clean environment for games programming: if
+Inform 7 is like the Ruby of adventure games, ScottKit is like C.  For
+a big project, you definitely want Inform 7; but I've found that there
+is a distinctive appeal to ScottKit.  Apart from anything else, it
+makes a good domain-specific "little language" for teaching my sons
+how to program.
+
+
+Running ScottKit
+----------------
+
+The main three modes of running are:
+
+	$ scottkit -c game.sck > game.sao  # compile
+	$ scottkit game.sao  # play the game; or use scottfree game.sao
+	$ scottkit -d game.sao  # decompile - useful for cheating
+
+And there's a handy short-cut combining compilation and play:
+
+	$ scottkit -p game.sck # compile to memory, and play immediately
+
+Other command-line arguments enable wizard commands, load saved games,
+set random seeds and enable various kinds of debugging output: run
+`scottkit -h` for details.
+
+
+Testing
+-------
+
+Unit testing can be done as follows:
+
+	$ ruby -I lib -rrake/rake_test_loader test/test_*
+	Loaded suite test/test_canonicalise
+	Started
+	...........
+	Finished in 0.769568 seconds.
+
+	11 tests, 37 assertions, 0 failures, 0 errors, 0 skips
+
+
+Game format
+-----------
+
+The file `notes/Definition-scottfree-1.14.txt` is taken 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` is my modified version of this file, since the
+original had several mistakes.  `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.)
+
+
+Games
+-----
+
+The directory `data` contains game files:
+
+* `adams` - Scott Adams's classic games (see Makefile for details)
+* `howarth` - Brian Howarth's  games (see Makefile for details)
+* `test` - games files used by unit-test suite
+* `tutorial` - tiny game used in ScottKit tutorial
+* `crystal` - Crystal of Chaos, a game written to exercise ScottKit
+* `dan-and-matt.sck` - game written by my two eldest sons
+
+I have verified that ScottKit can be used to play and win Scott
+Adams's games #1, 2, and 4: *Adventureland*, *Pirate Adventure* and
+*Voodoo Castle*.  I welcome reports of its being used to play and win
+other games, or failing that, reports of how it fails.
+
+
+
+Bug tolerance
+-------------
+
+The `-b` (`--bug-tolerant`) option is needed for Scott Adams Adventure
+14b (*Buckaroo Banzai*), which places one item (the jug of jet fuel)
+in room 50 of 36.  None of Scott's own games is so sloppy.
+
+

data/Rakefile

@@ -5,8 +5,9 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "scottkit"
-    gem.summary = "ScottKit is a toolkit for compiling, decompiling and playing adventure games in the Scott Adams format."
-    gem.description = gem.summary
+    gem.license = 'GPL-2.0'
+    gem.summary = "Toolkit for Scott Adams-format adventure games"
+    gem.description = "ScottKit is a toolkit for compiling, decompiling and playing adventure games in the Scott Adams format."
     gem.email = "mike@miketaylor.org.uk"
     gem.homepage = "http://github.com/MikeTaylor/scottkit"
     gem.author = "Mike Taylor"
@@ -42,7 +43,7 @@ task :test => :check_dependencies
 
 task :default => :test
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 

data/VERSION

@@ -1 +1 @@
-0.4.0
+1.0.0

data/bin/scottkit

@@ -1,4 +1,4 @@
-#!/usr/local/bin/ruby1.9 -w
+#!/usr/local/bin/ruby -w
 
 # Command-line driver for the ScottKit toolkit, allowing Scott
 # Adams-format adventure games to be compiled, decompiled and played.
@@ -31,7 +31,6 @@ end
 
 mode = :play
 options = {}
-compile, decompile, play_from_source = false, false, false
 sleep_at_end = false
 
 opts = OptionParser.new do |x|

data/data/crystal/crystal.solution

@@ -33,6 +33,9 @@ get plywood
 south
 get balsa
 south
+climb tree
+get honey
+down
 drop oak
 drop plywood
 drop balsa
@@ -45,6 +48,7 @@ get lamp
 west
 south
 south
+follow path
 give honey
 follow path
 get vase

data/data/test/Makefile

@@ -1,7 +1,7 @@
 # This rebuilds the files used for regression testing
 # Do this ONLY WHEN SURE that the software is correct
 
-RUN = ruby1.9 -I ../../lib ../../bin/scottkit
+RUN = ruby -I ../../lib ../../bin/scottkit
 
 **default**:
 	@echo "Use 'make rebuild' if you are SURE that the software is correct"

data/data/test/adams/Makefile

@@ -1,7 +1,7 @@
 # This rebuilds the files used for regression testing
 # Do this ONLY WHEN SURE that the software is correct
 
-RUN = ruby1.9 -I ../../../lib ../../../bin/scottkit
+RUN = ruby -I ../../../lib ../../../bin/scottkit
 
 **default**:
 	@echo "Use 'make rebuild' if you are SURE that the software is correct"

data/data/test/crystal.decompile

@@ -291,7 +291,7 @@ action SAV GAM
 action LOO:
 	look
 
-occur when "at" forest2
+occur when at forest2
 	set_dark
 
 occur when !at forest2
@@ -316,11 +316,11 @@ occur 0%
 	print "a bronze sceptre, a zinc goblet and a tin stoat."
 	comment "cont"
 
-occur when "at" "west" and !flag 6
+occur when at "west" and !flag 6
 	set_flag 6
 	print "Oh, there they are.  That wasn't as hard as I expected."
 
-occur when "at" hut
+occur when at hut
 	set_flag 7
 
 occur when !here chain
@@ -342,31 +342,31 @@ occur when flag 7 and !flag 8
 	set_flag 8
 	print "Ah, looks like I'm still missing the stoat."
 
-occur when "at" level
+occur when at level
 	set_flag 5
 
-occur when "at" "north"
+occur when at "north"
 	set_flag 5
 
-occur when "at" north1
+occur when at north1
 	set_flag 5
 
-occur when "at" "south"
+occur when at "south"
 	set_flag 5
 
-occur when "at" south1
+occur when at south1
 	set_flag 5
 
-occur when "at" forest1
+occur when at forest1
 	clear_flag 5
 
-occur when "at" wall
+occur when at wall
 	clear_flag 5
 
-occur when "at" vase
+occur when at vase
 	clear_flag 5
 
-occur when "at" again
+occur when at again
 	clear_flag 5
 
 occur when counter_eq 1
@@ -403,7 +403,7 @@ occur 0%
 	set_flag 4
 	comment "cont"
 
-occur when flag 4 and "at" glade
+occur when flag 4 and at glade
 	destroy bees
 	put bees1 tree
 
@@ -533,7 +533,7 @@ action GO ENT when here north2
 	goto "room"
 	look2
 
-action LIG PLY when "carried" Plywood
+action LIG PLY when carried Plywood
 	print "Not while I'm carrying it!"
 
 action LIG PLY when here Plywood
@@ -546,10 +546,10 @@ action LIG OAK when here Oak
 	print "My match goes out."
 	destroy match
 
-action LIG OAK when "carried" Oak
+action LIG OAK when carried Oak
 	print "Not while I'm carrying it!"
 
-action LIG BAL when "carried" wood
+action LIG BAL when carried wood
 	print "Not while I'm carrying it!"
 
 action LIG BAL when here wood
@@ -566,7 +566,7 @@ occur 0%
 action GO PAT when here bear
 	print "Bear won't let me"
 
-action GO PAT when "at" forest
+action GO PAT when at forest
 	goto forest2
 	look2
 
@@ -584,11 +584,11 @@ action GO VAS when here vase
 	goto vase
 	look2
 
-action LEA VAS when "at" vase
+action LEA VAS when at vase
 	swap_specific_room 1
 	look2
 
-action TAK OUT when "at" vase
+action TAK OUT when at vase
 	swap_specific_room 1
 	look2
 
@@ -607,7 +607,7 @@ action GO INF when here "south"
 	goto "north"
 	look2
 
-action KNO DOO when "at" cells
+action KNO DOO when at cells
 	print "Which door?  Use `knock iron` or `knock bronze`."
 
 action KNO IRO when here south1

data/lib/scottkit/compile.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Test with: cd /usr/local/src/mike/scott/scottkit && ruby1.9 -I lib bin/scottkit -c data/tutorial/t7.sck
+# Test with: cd /usr/local/src/mike/scott/scottkit && ruby -I lib bin/scottkit -c data/tutorial/t7.sck
 
 require 'pp'
 
@@ -147,7 +147,7 @@ module ScottKit
         conds = []
         while peek == :when || peek == :and
           skip
-          op = match :symbol
+          op = match([:symbol, :carried, :at])
           type = Condition::OPStotype[op] or
             error "unknown condition op '#{op}'"
           case type
@@ -634,7 +634,12 @@ module ScottKit
         def match(expected, estr = nil)
           token = peek
           @lookahead = nil
-          if token != expected
+          if (expected.kind_of?(Array))
+            ok = expected.any? {|x| token == x}
+          else
+            ok = token == expected
+          end
+          if (!ok)
             error("expected #{estr || expected}, got #{render(token)}" +
                   " (before `#{@buffer.lstrip}')")
           end

data/lib/scottkit/decompile.rb

@@ -5,7 +5,7 @@ module ScottKit
     def quote(token) #:nodoc:
       if ((token !~ /^([!a-z_0-9-]+)$/i || token =~ /\n/) ||
           Compiler::Lexer::TOKENMAP[token])
-        "\"#{token.gsub(/[""]/, '\'')}\""
+        "\"#{token.gsub('"', '\'')}\""
       else
         token
       end
@@ -127,7 +127,7 @@ module ScottKit
 
       def render
         type = OPS[@cond][1]
-        res = quote(OPS[@cond][0])
+        res = OPS[@cond][0]
         res += " " +
           quote(type == :room ? @game.roomname(@value) :
                 type == :item ? @game.itemname(@value) :

data/lib/scottkit/game.rb

@@ -248,7 +248,7 @@ module ScottKit
       0.upto(NFLAGS-1) do |i|
         @counters[i], @saved_rooms[i] = f.gets.chomp.split.map(&:to_i)
       end
-      tmp, dark_flag, @loc, @counter, @saved_room, @lampleft =
+      tmp, _UNUSED_dark_flag, @loc, @counter, @saved_room, @lampleft =
         f.gets.chomp.split.map(&:to_i)
       0.upto(NFLAGS-1) do |i|
         @flags[i] = (tmp & 1 << i) != 0

data/lib/scottkit/play.rb

@@ -13,7 +13,6 @@ module ScottKit
       @saved_room = 0
       @loc = defined?(@startloc) ? @startloc : 1
       @lampleft = defined?(@lamptime) ? @lamptime : 0
-      dark_flag = false
 
       puts "ScottKit, a Scott Adams game toolkit in Ruby."
       puts "Release 1.0, (C) 2010 Mike Taylor <mike@miketaylor.org.uk>"
@@ -134,7 +133,7 @@ module ScottKit
             look
             # When moving from a light place to a dark one or vice
             # versa, this look should not happen, because we'll get a
-            # correct version of the display after to flag gets set.
+            # correct version of the display after the flag gets set.
             # I'm not sure what can be done about this.  ### Think
           elsif is_dark
             puts "I fell down and broke my neck."
@@ -323,10 +322,10 @@ module ScottKit
     end
 
     def is_dark
-      return dark_flag if @items.size <= ITEM_LAMP
+      return @flags[15] if @items.size <= ITEM_LAMP
       loc = @items[ITEM_LAMP].loc
-      #puts "dark_flag=#{dark_flag}, lamp(#{ITEM_LAMP}) at #{loc}"
-      dark_flag && loc != ROOM_CARRIED && loc != @loc
+      #puts "dark_flag=#{@flags[15]}, lamp(#{ITEM_LAMP}) at #{loc}"
+      @flags[15] && loc != ROOM_CARRIED && loc != @loc
     end
 
     public :play # Must be visible to driver program
@@ -391,13 +390,13 @@ module ScottKit
         when 53 then @game.items[args.shift].loc = @game.loc
         when 54 then @game.loc = args.shift
         when 55 then @game.items[args.shift].loc = ROOM_NOWHERE
-        when 56 then @game.dark_flag = true
-        when 57 then @game.dark_flag = false
+        when 56 then @game.flags[15] = true
+        when 57 then @game.flags[15] = false
         when 58 then @game.flags[args.shift] = true
         when 59 then @game.items[args.shift].loc = ROOM_NOWHERE
         when 60 then @game.flags[args.shift] = false
         when 61 then
-          puts "I am dead."; @game.dark_flag = false;
+          puts "I am dead."; @game.flags[15] = false;
           @game.loc = @game.rooms.size-1; @game.look
         when 62 then i = args.shift; @game.items[i].loc = args.shift
         when 63 then @game.finished(0)