Cloak of Darkness

Example 291

★★★★

Implementation of "Cloak of Darkness", a simple example game that for years has been used to demonstrate the features of IF languages.

"Cloak of Darkness" is a brief example game that has been implemented in nearly every IF system currently used. It hasn't got much claim to complexity or richness, but it does exemplify many of the standard things one might want an IF language to be able to do: define descriptions and the results of actions, assign synonyms to nouns, create new verbs, handle darkness, track repeated acts, and so on.

Here is what the game looks like in Inform:

Play/modify in Borogove

Play in Quixe

"Cloak of Darkness"

The story headline is "A basic IF demonstration."

Use scoring.

The maximum score is 2.

Whatever room we define first becomes the starting room of the game, in the absence of other instructions:

Foyer of the Opera House is a room.  "You are standing in a spacious hall, splendidly decorated in red and gold, with glittering chandeliers overhead. The entrance from the street is to the north, and there are doorways south and west."
 
Instead of going north in the Foyer, say "You've only just arrived, and besides, the weather outside seems to be getting worse."

We can add more rooms by specifying their relation to the first room. Unless we say otherwise, the connection will automatically be bidirectional, so "The Cloakroom is west of the Foyer" will also mean "The Foyer is east of the Cloakroom":

The Cloakroom is west of the Foyer. "The walls of this small room were clearly once lined with hooks, though now only one remains. The exit is a door to the east."
 
In the Cloakroom is a supporter called the small brass hook. The hook is scenery. Understand "peg" as the hook.

Inform will automatically understand any words in the object definition ("small", "brass", and "hook", in this case), but we can add extra synonyms with this sort of Understand command.

The description of the hook is "It's just a small brass hook, [if something is on the hook]with [a list of things on the hook] hanging on it[otherwise]screwed to the wall[end if]."

This description is general enough that, if we were to add other hangable items to the game, they would automatically be described correctly as well.

The Bar is south of the Foyer. The printed name of the bar is "Foyer Bar". The Bar is dark.  "The bar, much rougher than you'd have guessed after the opulence of the foyer to the north, is completely empty. There seems to be some sort of message scrawled in the sawdust on the floor."
 
The scrawled message is scenery in the Bar. Understand "floor" or "sawdust" as the message.
 
Neatness is a kind of value. The neatnesses are neat, scuffed, and trampled. The message has a neatness. The message is neat.

We could if we wished use a number to indicate how many times the player has stepped on the message, but Inform also makes it easy to add descriptive properties of this sort, so that the code remains readable even when the reader does not know what "the number of the message" might mean.

Instead of examining the message:
   increment score;
   say "The message, neatly marked in the sawdust, reads...";
   end the story finally.

This second rule takes precedence over the first one whenever the message is trampled. Inform automatically applies whichever rule is most specific:

Instead of examining the trampled message:
   say "The message has been carelessly trampled, making it difficult to read. You can just distinguish the words...";
   end the story saying "You have lost".

This command advances the state of the message from neat to scuffed and from scuffed to trampled. We can define any kinds of value we like and advance or decrease them in this way:

Instead of doing something other than going in the bar when in darkness:
   if the message is not trampled, now the neatness of the message is the neatness after the neatness of the message;
   say "In the dark? You could easily disturb something."
 
Instead of going nowhere from the bar when in darkness:
   now the message is trampled;
   say "Blundering around in the dark isn't a good idea!"

This defines an object which is worn at the start of play. Because we have said the player is wearing the item, Inform infers that it is clothing and can be taken off and put on again at will.

The player wears a velvet cloak. The cloak can be hung or unhung. Understand "dark" or "black" or "satin" as the cloak. The description of the cloak is "A handsome cloak, of velvet trimmed with satin, and slightly splattered with raindrops. Its blackness is so deep that it almost seems to suck light from the room."
 
Carry out taking the cloak:
   now the bar is dark.
 
Carry out putting the unhung cloak on something in the cloakroom:
   now the cloak is hung;
   increment score.
 
Carry out putting the cloak on something in the cloakroom:
   now the bar is lit.
 
Carry out dropping the cloak in the cloakroom:
   now the bar is lit.
 
Instead of dropping or putting the cloak on when the player is not in the cloakroom:
   say "This isn't the best place to leave a smart cloak lying around."
 
When play begins:
   say "[paragraph break]Hurrying through the rainswept November night, you're glad to see the bright lights of the Opera House. It's surprising that there aren't more people about but, hey, what do you expect in a cheap demo game...?"
 
Understand "hang [something preferably held] on [something]" as putting it on.
 
Test me with "s / n / w / inventory / hang cloak on hook / e / s / read message".

Test me with "s / n / w / inventory / hang cloak on hook / e / s / read message".

Foyer of the Opera House
You are standing in a spacious hall, splendidly decorated in red and gold, with glittering chandeliers overhead. The entrance from the street is to the north, and there are doorways south and west.

>(Testing.)

>[1] s

Darkness
It is pitch dark, and you can't see a thing.

>[2] n

Foyer of the Opera House
You are standing in a spacious hall, splendidly decorated in red and gold, with glittering chandeliers overhead. The entrance from the street is to the north, and there are doorways south and west.

>[3] w

Cloakroom
The walls of this small room were clearly once lined with hooks, though now only one remains. The exit is a door to the east.

>[4] inventory
You are carrying:
a velvet cloak (being worn)

>[5] hang cloak on hook
(first taking it off)
You put the velvet cloak on the small brass hook.

[Your score has just gone up by one point.]

>[6] e

Foyer of the Opera House
You are standing in a spacious hall, splendidly decorated in red and gold, with glittering chandeliers overhead. The entrance from the street is to the north, and there are doorways south and west.

>[7] s

Foyer Bar
The bar, much rougher than you'd have guessed after the opulence of the foyer to the north, is completely empty. There seems to be some sort of message scrawled in the sawdust on the floor.

>[8] read message
The message, neatly marked in the sawdust, reads...

*** The End ***

In that game you scored 2 out of a possible 2, in 8 turns.

And that's all. As always, type TEST ME to watch the scenario play itself out.