Download IFM User Manual

Transcript
IFM User Manual, Release 5.4
$cmd_teleport Regexp matching commands that are known to cause a teleport to an arbitrary room
(case-insensitive). Default: ^(restart|restore)$
8.1.6 Writing the map
Output from scr2ifm is as follows. First, if the title of the map was specified with the title command, it
is printed. Then, if there’s more than one map section, a list of map section titles is printed.
Next, there’s a list of IFM commands derived from the transcript. Each time a new room is seen, a room
command is output for it. Each room is given a tag name formed by the initials of each capitalized word
in its name. To make tags unique, the second and subsequent occurrences of a tag name have that number
appended. For example, room “West of House” would get tag WH.
If a movement command was up, down, in or out, then a compass direction is chosen for it that doesn’t clash
with other rooms (if possible) and the go attribute is used to mark its real direction. If a movement command
isn’t recognized, the same is done except this time the cmd attribute is used to record the command instead.
If movement is seen between two already-visited rooms, a link command is output (or a join, if the
rooms appear to be on different map sections). Link tags are built by concatenating the room tags of the
linked rooms with an underscore in between. Link movement is dealt with in the same manner as for rooms.
If the special item or task commands are seen, then an item or task command is output following the
room that it appears in. If an item or task hasn’t been given a tag, it is assigned one. The tag is made
by translating all invalid tag characters in the name to underscores, capitalizing (to avoid clashes with IFM
commands) and, if the tag clashes with a previously-defined tag, adding a numerical suffix to make it unique.
For example, “black rod” might get a tag Black_rod_2.
Finally, the IFM commands from the file indicated by the -c option are echoed (if any).
8.1.7 Example session
Here’s a simple example of scr2ifm in action on Colossal Cave. First, the transcript in file advent.scr
(with annotation):
Start of a transcript of
ADVENTURE
The Interactive Original
By Willie Crowther and Don Woods (1977)
David M. Baggett’s 1993 reconstruction, ported by Graham Nelson
Release 3 / Serial number 951220 / Inform v1502 Library 5/12
Interpreter 1 Version B / Library serial number 951024
>verbose
ADVENTURE is now in its "verbose" mode, which always gives
long descriptions of locations (even if you’ve been there
before).
>l
At End Of Road
You are standing at the end of a road before a small brick
8.1. scr2ifm: convert transcripts to IFM map
67