IFM(1)

📦
version 5.5 · 3 versions
, in fedora 43, fedora 44

✨ IFM 💖 (that's section 1 of the manual, bestie — User Commands, we're in the big leagues)

🌸 NAME 🌸

IFM — Interactive Fiction Mapper 🗺️✨

🎀 SYNOPSIS 🎀

ifm [options] [file...]

🦋 DESCRIPTION 🦋

okay so IFM is literally your little mapping bestie for playing Interactive Fiction games 💖 it keeps track of how far you've gotten. You can write down every room you visit and how it connects to the other rooms, you can note where you first found the useful items, and you can jot down the tasks you gotta do to actually beat the game. no cap.

The mapping commands are built so you can just keep adding to the map while you're exploring 🫶 like, you type in the rooms you visit and the directions you moved to get to the next room, and IFM does the math and figures out where each room sits relative to all the others. And a map can be split into several independent sections, so you can chop up the map however you want. main character energy tbh.

The task commands (if you feel like using them 👑) let you say what order the game-solving tasks have to happen in. Then IFM can calculate and print different styles of walkthrough for the game. iconic.

IFM can also write hardcopy maps straight to PostScript, which is perfect for printing or viewing 🔥 and it can write maps in Fig format, which you can view and edit with Xfig, or convert into a whole bunch of other formats.

ngl, this man page is just the summary of the command-line options. The actual how-to-use-IFM docs live in the SEE ALSO section 💅

💅 the options, bestie (the main ones)

  • -m, --map[=sections] — pick map output 🗺️
  • -i, --items — pick item output 🍓
  • -t, --tasks — pick task output ✅
  • -f, --format <name> — pick the output format 🎀
  • -o, --output <file> — write the output to the file you name 💾

🌈 Auxiliary options

  • -I (dir) — prepend dir to the search path 🔍
  • -S, --style (name) — push a style onto the style list 💄
  • -s, --set (var=val) — set a customization variable 🛠️
  • --noinit — don't read your personal init file 🙈
  • -v, --verbose — be verbose about things 🗣️
  • -w, --nowarn — don't print warnings 🤫

👑 Information options

  • --show <type> — show information ℹ️
  • --version — print the program version 🏷️
  • -h, --help — this help message 🆘

🎨 Output formats (may be abbreviated)

  • ps — PostScript
  • fig — Xfig drawing
  • text — ASCII text
  • rec — Recording of game commands
  • dot — Task dependency graph
  • yaml — YAML
  • raw — Raw ASCII text fields
  • tk — TkIFM program commands

🔍 Show options (may be abbreviated)

  • vars — Show defined variables
  • path — Show file search path

🌱 ENVIRONMENT 🌱

  • IFMPATH — colon-separated list of extra directories to search for include files. (yes, colon-separated, not space, don't fight it bestie)

📁 FILES 📁

  • $HOME/.ifmrc — User resource file. 💖
  • $HOME/ifm.ini — Alternate resource filename (Windows-style). 🪟

Copyright © Glenn Hutchings <zondo42@gmail.com>

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

fr fr read that warranty bit, it is NOT a vibe, it's a legally binding "we promised nothing" 💀

🫶 SEE ALSO 🫶

okay that's the whole page bestie, you're officially certified 💅 go map some dungeons 🌟

IFM version 5.4-70-gc375d57-dirty, July 2022 — yeah that's the version string and the date, mwah, and it's still IFM(1) at the end of the day 🎀✨

📦 where this page comes from