scottkit 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74caa6f49f168820ecb2dd75e69168e99a418580
-  data.tar.gz: 7a1ff862fc3c098090fa42c9f42927742bcd1417
+  metadata.gz: ba5e8627024b057135cebd745dac5be2349a7cf2
+  data.tar.gz: 674fcefb8713c42bc1ae4ab03beecfb2f57cc0be
 SHA512:
-  metadata.gz: 865872bd20ee18ccd2ed13af2c121de6d0932db82fb303648948a0ceb759adbd3b0c0ace1564cf54ca81e25dd015d7a4538767805badedbc144460ca103faa0d
-  data.tar.gz: f50211980fb0b774677efc29adde3d9ea3f06d1e512f126a47044998a270286ac545e5e1e53330d0c02baf11919005071ffaa375a6c8ded52cc0cd22afbb30ea
+  metadata.gz: 1baf3caed8abf5d48ca423dec47d6886f6ad0e3073daed3dfa6224c6df0c1a5f00972f7d089cd6b58df0e76666e69787f3550e05a181c7088bc12f8fbb2a2f29
+  data.tar.gz: 72110fd1d28992b86f89772b2d774e7abc1c3a9c8a972bbe0d6133fe73399139d9bdea1bb29cea1c5eaeb817a1e011241484006c520f07a6d68f477772ecc327

data/ChangeLog.md

@@ -1,8 +1,13 @@
 # Revision history for Ruby gem ScottKit
 
-## 1.2.0 (IN PROGRESS)
+## 1.2.0 (Mon Oct 16 15:11:44 BST 2017)
 
 * Create initial tutorial, exactly equivalent to that of Games::ScottAdams.
+* Use the special name `_` for the unused variable representing the redundant dark-flag part of save-files. This avoids an unused-variable warning when running under certain older versions of Ruby.
+* Top-level README links to the tutorial, reference manual and sequence of blog-posts.
+* Add new game, [`data/nosferatu`](data/nosferatu), ported from the Games::ScottAdams reimplementation of the 1982 VIC-20 BASIC game. This is incomplete.
+* Escape sequences for newline (`\n`) and tab (`\t`) are interpreted in printed strings.
+* Add discussion of the `print` action to the reference guide.
 
 ## 1.1.0 (Thu Oct 12 21:59:28 BST 2017)
 
@@ -60,6 +65,7 @@
 
 ## Still to do
 
+* Linting options: see https://github.com/MikeTaylor/scottkit/issues/1
 * Tweak compiler to break actions when they need too many arguments as
   well as when they need too many instructions.
 * Ensure that the right files are built by `YARD`

data/README.md

@@ -98,3 +98,15 @@ The `-b` (`--bug-tolerant`) option is needed for Scott Adams Adventure
 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)
+* 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/)
+
+

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/data/nosferatu/.gitignore

@@ -0,0 +1 @@
+nosferatu.sao

data/data/nosferatu/Makefile

@@ -0,0 +1,14 @@
+test: nosferatu.sao
+	scottkit -W -e $< < nosferatu.sol | diff nosferatu.script -
+
+nosferatu.sao: nosferatu.sck
+	scottkit -c $< > $@
+	diff nosferatu.regression $@
+
+rebuild:
+	scottkit -c nosferatu.sck > nosferatu.regression
+	scottkit -W -e nosferatu.sao < nosferatu.sol > nosferatu.script
+
+clean:
+	rm -f nosferatu.sao
+

data/data/nosferatu/README

@@ -0,0 +1,13 @@
+This is a re-implementation of my 1982 game _Nosferatu_:
+http://www.miketaylor.org.uk/tech/advent/nos/
+
+It was originally written in lovingly hand-crafted BASIC for the
+VIC-20 with 8k expansion, and marketed by Terminal Software.
+
+To play the VIC-20 original in an emulator:
+$ xvic -memory 8k -autostart ~/web/new/comp/tech/advent/nos/NOSFERAT.TAP
+
+Known bugs:
+* "wait" always summons bus.
+* "climb ladder" always works as a teleport
+* The end of the game has not been coded

data/data/nosferatu/nosferatu.map

@@ -0,0 +1,59 @@
+Nosferatu -- originally for VIC-20, now for "sac"
+=================================================
+
+															13:On Bus
+															 \
+															  ^GIVE COINS
+															 /
+							21:Dingy Hut							11:Bus Stop
+							[spade]								[(bus)]
+							|								|
+							|								|
+							20:Lawn				15:Shed				10:Graveyard	12:Witch's Cave
+							|				[bottle]			[grave]	       /[witch->lamp]
+							|				|				| \__GO GRAVE_/
+							|				|				|
+	29:Chasm---||---27:Thicket------22:W. Pond	19:On Bridge	16:E. Pond------14:Yard---||----8:Washroom--||--9:Mortuary
+	[fountain]	|		|		|		|				|
+	|		|		|		|		|				|
+	|		|		|		|		|				|
+	28:Ledge---||---26:By Thicket---23:Field--------18:Junction-----17:Swamp---||---33:Grove	7:Kitchen
+			|		|\								|
+			|		| \____________							|		  __CLIMB ROPE_
+			|		|	       \						|		 /	       \
+			25:Pit----------24:Forest	GO HOLE				1:Coffin--------2:Rat-ridden----5:Balcony	6:Ledge
+						       /						|		|
+					  ____________/							|		|
+					 /								|		|
+					30:Entrance-----31:Cavern---||--32:Chamber			3:Chamber-------4:Library
+							[stalactite,	[count,
+							 passage]	 statue]
+
+Other objects listed on paper map
+---------------------------------
+
+Crucifix engraved: Blackbeard woz ere
+Ladder
+Axe
+Lamp
+Rope
+Coins
+Water of Life
+
+Other notes on paper map
+------------------------
+
+On Bridge: ">1 Object carried => fall"
+Between Swamp and Junction: "Some sort of Barrier" 
+Forest: "needs ladder" (to climb out of pit?)
+By thicket: "JUMP"
+Field of Grass: "DIG HERE.  GO HOL"
+Entrance: "SEMIDARK"
+Cavern: "NEED LAMP / OR BREAK NECK"
+Cavern: "Throw Axe.  At Stalactite.  It shatters, see passage"
+Balcony: "Tie Rope, to Balcony.  Climb Rope"
+Washroom: "Locked doors"
+Cave: "GIVE WATER (IN BOTTLE) => GET LAMP"
+Bus stop: "WAIT: GIVE COINS"
+Chamber: "Count sleeps on altar"
+Chamber: "GO PASSAGE.  SAY 'S$'"

data/data/nosferatu/nosferatu.regression

@@ -0,0 +1,345 @@
+19540
+55
+67
+44
+33
+5
+2
+1
+3
+999
+44
+1
+
+750 0 0 0 0 0 9900 0
+1507 0 0 0 0 0 9900 0
+900 0 0 0 0 0 9750 0
+1058 0 0 0 0 0 10650 0
+100 29 20 0 0 0 8701 373
+0 0 0 0 0 0 454 823
+0 0 0 0 0 0 986 1050
+1200 652 0 0 0 0 1200 0
+100 644 309 0 0 0 8464 0
+100 624 308 0 0 0 8614 0
+100 664 86 0 0 0 1413 0
+1359 352 0 0 0 0 1500 0
+1359 60 0 0 0 0 1708 0
+1810 68 124 60 340 160 9055 7962
+1800 68 60 0 0 0 9013 0
+1800 0 0 0 0 0 2100 0
+1959 162 140 0 0 0 8100 0
+1959 144 221 0 0 0 2313 0
+1959 144 120 0 0 0 8100 0
+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
+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
+166 702 620 0 0 0 8100 0
+1967 562 500 0 0 0 8100 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
+3461 48 602 40 540 0 9053 10950
+0 600 620 0 0 0 10824 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
+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
+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
+4233 541 802 800 820 0 10873 0
+0 840 860 0 0 0 10821 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
+
+"AUT" "ANY"
+"WAL" "NOR"
+"*ENT" "SOU"
+"*GO" "EAS"
+"*RUN" "WES"
+"INV" "UP"
+"SCO" "DOW"
+"SAV" "INV"
+"DIG" "GAM"
+"TIE" "ROP"
+"TAK" "RAI"
+"*GET" "DOO"
+"TO" "GRA"
+"CLI" "BUS"
+"OPE" "BOT"
+"*UNL" "COI"
+"WAI" "PIT"
+"GIV" "LAD"
+"LEA" "WAT"
+"*DRO" "AXE"
+"JUM" "*AX"
+"POU" "STA"
+"THR" "ENT"
+"AT" "COU"
+"KIL" "COF"
+"TEL" "BOO"
+"REA" "LIB"
+"DRI" "ATL"
+"CHO" "MAG"
+"LIG" "WHI"
+"HEL" "SAR"
+"EXA" "BOD"
+"LOO" "DUS"
+"*L" "THI"
+"" "HOL"
+"" "TUN"
+"" "LAM"
+"" "CRO"
+"" "KEY"
+"" "KIP"
+"" "MAL"
+"" "SPA"
+"" "STI"
+"" "MAT"
+"" "BLO"
+
+0 0 0 0 0 0 ""
+0 0 0 0 0 0 "hidden treasury."
+0 0 3 0 0 0 "tall, satin-lined wooden box."
+8 4 6 2 0 0 "*I'm in an empty room."
+3 0 5 0 0 0 "dark crypt."
+6 0 0 4 0 0 "*I'm in the library."
+0 5 0 3 0 0 "*I'm on a balcony overlooking a tall cliff."
+0 0 0 0 0 0 "*I'm on a narrow ledge high up on a cliff."
+9 3 0 0 0 0 "*I'm in the kitchen."
+0 8 10 0 0 0 "*I'm in the washroom."
+11 0 0 9 0 0 "*I'm in the mortuary."
+12 10 0 0 0 0 "desolate windswept graveyard."
+0 11 0 0 0 0 "*I'm by a bus-stop."
+0 0 0 0 0 0 "dark gloomy cave."
+0 12 0 0 0 0 "*I'm on a double-decker bus."
+16 0 9 17 0 0 "rather dark yard."
+0 15 0 0 0 0 "dark shed."
+0 18 15 0 0 0 "*I'm by a fishpond ..."
+17 0 0 19 0 0 "damp swamp."
+20 0 18 24 0 0 "*I'm on a track. To my North is a bridge over a pond."
+21 19 0 0 0 0 "*I'm on a very flimsy bridge..."
+22 20 0 0 0 0 "*I'm on a lawn to the North of a pond."
+0 21 0 0 0 0 "small hut."
+0 24 0 28 0 0 "*I'm west of a pond."
+23 25 19 27 0 0 "sunny field."
+24 25 25 26 0 0 "*I'm in an oak-forest."
+0 0 0 0 0 0 "*I'm at the bottom of a disused cesspit."
+28 26 24 0 0 0 "*I'm north of a rather smelly hole."
+0 27 23 0 0 0 "*I'm at the top of a cliff."
+30 0 0 0 0 0 "*I'm on a narrow ledge, East of a chasm."
+0 29 28 0 0 0 "*I'm at the edge of a deep chasm."
+0 0 0 0 0 0 "*I'm at the bottom of a deep hole."
+0 31 0 0 0 0 "subterranean cavern."
+0 32 0 0 0 0 "cavern where the count sleeps."
+
+""
+"Welcome to `NOSFERATU`, by Mike Taylor."
+"  Original VIC-20 BASIC version, 1982"
+"  Translation to Games::ScottAdams starting Sunday 25th November 2001"
+"  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."
+"I'll need a spade."
+"Nosferatu rises from his altar, and bites my neck!"
+"Huh?  What rope?"
+"To what (eg. to key)"
+"OK."
+"What a stupid concept."
+"Huh?"
+"I'm too heavy:
+I fall!"
+"The 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."
+"I break through to an underground chamber!"
+"OK"
+"Huh?  What axe?"
+"At what (eg. at bus)"
+"It shatters!"
+"Nothing happens."
+"I punch him and he crumbles to dust."
+"Huh!  That was easier than I expected!"
+">Fzing!<"
+"Which one?"
+"OK, but it'll take a while."
+"That was boring!  It was in Transylvanian!"
+"The book says:
+
+Near the forest is a disused cess-pit."
+"The book says:
+
+Magic word id: 'OVYEZ'"
+"The book says:
+
+Bored with this game already, huh?"
+"Burp!  It's good!"
+"I feel stronger."
+"I find something!"
+"The lid's too heavy!"
+"It turns to dust!"
+"It slips through my fingers"
+"You'll have to figure it out for yourself."
+"It looks like a pretty average"
+"Wheee!"
+"I find nothing."
+
+"*treasure* (you shouldn't be able to see this)" 0
+"stone Sarcophagus" 4
+"decomposing Body" 0
+"pile of Dust" 0
+"wooden Cross/CRO/" 0
+"transylvanian Atlas/ATL/" 5
+"book of Magic/MAG/" 5
+"book of Games/GAM/" 5
+"rope tied to rail" 0
+"lit Lamp/LAM/" 0
+"brass Key/KEY/" 7
+"scarlet Kipper/KIP/" 7
+"hanging Rope" 7
+"bottle of Whisky/WHI/" 8
+"empty whisky Bottle/BOT/" 0
+"locked Door" 9
+"wide open Door" 0
+"long Rope/ROP/" 9
+"7-pound Mallet/MAL/" 10
+"newely dug open Grave" 11
+"tombstone engraved: BEWARE THE WITCH" 11
+"large red no. 29 Bus" 0
+"wrinkled old Witch" 13
+"Hole (above me)" 13
+"old Lamp/LAM/" 0
+"balcony Rail" 6
+"bus Conductor" 14
+"sharp Axe/AXE/" 15
+"tall Ladder/LAD/" 16
+"maneating Shark!" 17
+"Hut with locked door" 21
+"Hut with smashed door" 0
+"garden Spade/SPA/" 22
+"sharp wooden Stick/STI/" 22
+"crusifix engraved on the ground" 24
+"Pit in the ground" 0
+"oak-Trees" 25
+"Sign says: 'TREES ARE RESERVED FOR COFFINS'" 25
+"golden Coins/COI/" 26
+"brick Wall" 27
+"inpenetrable Thicket" 28
+"mutilated thicket" 0
+"Sign here says: 'EXA NO FO TROHS'" 28
+"SHORT OF AN AXE' is written backwards on a Sign nearby'" 0
+"brick Wall" 29
+"safety Match/MAT/" 29
+"Water of youth" 30
+"Fountain of youth" 30
+"Hole in thicket" 30
+"whisky Bottle/BOT/" 0
+"secret Tunnel" 31
+"Stalactites hanging from the ceiling" 32
+"entrance to cave" 0
+"the count Nosferatu" 33
+"stone Altar" 33
+"giant *BLOODSTONE*/BLO/" 33
+
+""
+""
+""
+""
+""
+"cont"
+"cont"
+""
+"everywhere inside the cavern is dark"
+"everywhere outside the bottom of the pit is light"
+""
+""
+""
+""
+""
+""
+""
+"We would rather this happen carrying more than one object, but this is near enough."
+""
+"In the original, this created a new exit leading west, but we can't do that in the Scott Adams engine. Instead, the player must GO DOOR."
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+""
+"cont"
+""
+""
+""
+""
+""
+""
+""
+""
+""
+"We only really want to look if it was previously dark. Can do this with flags."
+""
+""
+""
+""
+""
+""
+
+1
+18401
+0