woof(6)

๐Ÿ“ฆ
version 15.3.0 ยท 4 versions
, in debian trixie, nixos 26.05, ubuntu questing, ubuntu resolute, ubuntu stonking

๐ŸŒธ NAME ๐ŸŒธ

woof โ€” Woof! is a continuation of Lee Killough's Doom source port MBF targeted at modern systems. This is the woof(6) page from the Games Manual, bestie โ€” buckle up. โœจ


โœจ SYNOPSIS โœจ

woof [OPTIONS]

๐Ÿ’– DESCRIPTION ๐Ÿ’–

okay so MBF stands for "Marine's Best Friend" and is widely regarded the successor of the Boom source port by TeamTNT. It serves as the code base for popular Doom source ports such as PrBoom+/DSDA-Doom or The Eternity Engine. As the original engine was limited to run only under MS-DOS, it has been ported to Windows by Team Eternity under the name WinMBF in 2004. Woof! is developed based on the WinMBF code with the aim to make MBF more widely available and convenient to use on modern systems. iconic behavior, honestly. ๐Ÿ’…


๐ŸŽ€ GENERAL OPTIONS ๐ŸŽ€

  • -config <file> โ€” Load main configuration from the specified file, instead of the default. ๐Ÿ’–
  • -devparm โ€” Developer mode. ๐Ÿ‘‘
  • -file <files> โ€” Load the specified PWAD files. ๐ŸŽ€
  • -help โ€” Print command line help. ๐Ÿซถ
  • -iwad <file> โ€” Specify an IWAD file to use. โœจ
  • -nomusic โ€” Disable music. ๐ŸŽต
  • -nosfx โ€” Disable sound effects. ๐Ÿ”‡
  • -nosound โ€” Disable all sound output. ๐Ÿ’€
  • -quiet โ€” Print with minimum verbosity. ๐Ÿคซ
  • -save <directory> โ€” Specify a path from which to load and save games. If the directory does not exist then it will automatically be created. ๐Ÿ’พ
  • -shotdir <directory> โ€” Specify a path to save screenshots. If the directory does not exist then it will automatically be created. ๐Ÿ“ธ
  • -verbose โ€” Print debugging info with maximum verbosity. ๐Ÿ—ฃ๏ธ
  • -version โ€” Print the program version and exit. ๐Ÿท๏ธ

๐Ÿฆ‹ GAME START OPTIONS ๐Ÿฆ‹

  • -beta โ€” Press beta emulation mode (complevel mbf only). ๐Ÿงช
  • -coop_spawns โ€” Start single player game with items spawns as in cooperative netgame. ๐Ÿค
  • -dog โ€” Enables a single helper dog. ๐Ÿถ
  • -dogs <n> โ€” Overrides the current number of helper dogs, setting it to n. ๐Ÿ•
  • -episode <n> โ€” Start playing on episode n (1-99) ๐Ÿ“บ
  • -fast โ€” Monsters move faster. ๐Ÿƒ
  • -loadgame <ps> โ€” Load the game on page p (0-7) in slot s (0-7). Use 255 to load an auto save. ๐Ÿ’พ
  • -nm โ€” Alias to -skill 5. ๐Ÿ˜ˆ
  • -nomo โ€” Alias to -nomonsters. ๐Ÿšซ
  • -nomonsters โ€” Disable monsters. ๐Ÿ‘ป
  • -pistolstart โ€” Enables automatic pistol starts on each level. ๐Ÿ”ซ
  • -respawn โ€” Monsters respawn after being killed. โ™ป๏ธ
  • -skill <skill> โ€” Set the game skill, 1-5 (1: easiest, 5: hardest). A skill of 0 disables all monsters only in -complevel vanilla. ๐ŸŽš๏ธ
  • -speed <n> โ€” Increase or decrease game speed, percentage of normal. โฉ
  • -turbo <x> โ€” Turbo mode. The player's speed is multiplied by x%. If unspecified, x defaults to 200. Values are rounded up to 10 and down to 400. ๐Ÿš€
  • -uv โ€” Alias to -skill 4. ๐Ÿ’œ
  • -warp <x> <y>|<xy> โ€” Start a game immediately, warping to ExMy (Doom 1) or MAPxy (Doom 2). ๐ŸŒ€

๐ŸŒˆ DISPLAY OPTIONS ๐ŸŒˆ

  • -1 โ€” Don't scale up the screen. Implies -window. 1๏ธโƒฃ
  • -2 โ€” Double up the screen to 2x its normal size. Implies -window. 2๏ธโƒฃ
  • -3 โ€” Triple up the screen to 3x its normal size. Implies -window. 3๏ธโƒฃ
  • -fullscreen โ€” Run in fullscreen mode. ๐Ÿ–ฅ๏ธ
  • -noblit โ€” Disable blitting the screen. ๐Ÿšซ
  • -nodraw โ€” Disable rendering the screen entirely. ๐Ÿ™ˆ
  • -nograbmouse โ€” Don't grab the mouse when running in windowed mode. ๐Ÿ–ฑ๏ธ
  • -nouncapped โ€” Disables uncapped framerate. ๐Ÿข
  • -uncapped โ€” Enables uncapped framerate. ๐Ÿ‡
  • -window โ€” Run in a window. ๐ŸชŸ

๐Ÿ’… NETWORKING OPTIONS ๐Ÿ’…

  • -altdeath โ€” Start a deathmatch 2.0 game. Weapons do not stay in place and all items respawn after 30 seconds. ๐Ÿ’ฅ
  • -autojoin โ€” Automatically search the local LAN for a multiplayer server and join it. ๐Ÿ”
  • -avg โ€” Austin Virtual Gaming: end levels after 20 minutes. โฐ
  • -connect <address> โ€” Connect to a multiplayer server running on the given address. ๐Ÿ”Œ
  • -deathmatch โ€” Start a deathmatch game. โš”๏ธ
  • -dedicated โ€” Start a dedicated server, routing packets but not participating in the game itself. ๐Ÿ–ง
  • -dm3 โ€” Start a deathmatch 3.0 game. Weapons stay in place and all items respawn after 30 seconds. ๐Ÿ”ซ
  • -dup <n> โ€” Reduce the resolution of the game by a factor of n, reducing the amount of network bandwidth needed. ๐Ÿ“‰
  • -extratics <n> โ€” Send n extra tics in every packet as insurance against dropped packets. ๐Ÿ›ก๏ธ
  • -frags <n> โ€” The -frags option allows you to deathmatch until one player achieves <n> frags, at which time the level ends and scores are displayed. If <n> is not specified the match is to 10 frags. ๐Ÿ†
  • -left โ€” Run as the left screen in three screen mode. โฌ…๏ธ
  • -nodes <n> โ€” Autostart the netgame when n nodes (clients) have joined the server. ๐Ÿ•ธ๏ธ
  • -oldsync โ€” Use original network client sync code rather than the improved sync code. ๐Ÿ•ฐ๏ธ
  • -port <n> โ€” Use the specified UDP port for communications, instead of the default (2342). ๐Ÿ”ข
  • -privateserver โ€” When running a server, don't register with the global master server. Implies -server. ๐Ÿคซ
  • -right โ€” Run as the right screen in three screen mode. โžก๏ธ
  • -server โ€” Start a multiplayer server, listening for connections. ๐Ÿ“ก
  • -servername <name> โ€” When starting a network server, specify a name for the server. ๐Ÿท๏ธ
  • -solo-net โ€” Start the game playing as though in a netgame with a single player. This can also be used to play back single player netgame demos. ๐Ÿง
  • -timer <n> โ€” For multiplayer games: exit each level after n minutes. โณ

๐Ÿงš DEHACKED AND WAD MERGING ๐Ÿงš

  • -bex <files> โ€” Alias to -deh. ๐Ÿ”
  • -bexout <filename> โ€” Alias to -dehout. ๐Ÿ”
  • -blockmap โ€” Forces a (re-)building of the BLOCKMAP lumps for loaded maps. ๐Ÿงฑ
  • -bsp โ€” Forces rebuilding of nodes. ๐ŸŒณ
  • -deh <files> โ€” Load the given dehacked/bex patch(es). ๐Ÿฉน
  • -dehout <filename> โ€” Enables verbose dehacked parser logging. ๐Ÿ“
  • -dumptranmap <name> โ€” Dump tranmap lump. ๐Ÿ—‘๏ธ
  • -force_old_zdoom_nodes โ€” Forces extended (non-GL) ZDoom nodes. ๐Ÿง“
  • -noautoload โ€” Disable auto-loading of .wad and .deh files. ๐Ÿšซ
  • -nocheats โ€” Ignore cheats in dehacked files. ๐Ÿšซ
  • -nodeh โ€” Avoid loading DEHACKED lumps embedded into WAD files. ๐Ÿšซ
  • -noextras โ€” Disable auto-loading of extars.wad file. ๐Ÿšซ
  • -nomapinfo โ€” Disable UMAPINFO loading. ๐Ÿšซ
  • -nooptions โ€” Avoid loading OPTIONS lumps embedded into WAD files. ๐Ÿšซ
  • -tranmap โ€” Forces a (re-)building of the translucency and color translation tables. ๐ŸŽจ

๐ŸŽต DEMO OPTIONS ๐ŸŽต

  • -fastdemo <demo> โ€” Plays the given demo as fast as possible. โšก
  • -levelstat โ€” Write level statistics upon exit to levelstat.txt ๐Ÿ“Š
  • -longtics โ€” Record a high resolution "Doom 1.91" demo. ๐ŸŽฅ
  • -maxdemo <size> โ€” Sets the initial size of the demo recording buffer (KiB). This is no longer a hard limit, and the buffer will expand if the given limit is exceeded. ๐Ÿ“ˆ
  • -playdemo <demo> โ€” Play back the demo named demo.lmp. โ–ถ๏ธ
  • -record <demo> โ€” Record a demo named demo.lmp. โบ๏ธ
  • -recordfrom <s> <demo> โ€” Record a demo, loading from the given save slot. Equivalent to -loadgame <s> -record <demo>. ๐Ÿ”—
  • -recordfromto <demo1> <demo2> โ€” Allows continuing <demo1> after it ends or when the user presses the join demo key, the result getting saved as <demo2>. Equivalent to -playdemo <demo1> -record <demo2>. ๐Ÿ”
  • -shorttics โ€” Play with low turning resolution to emulate demo recording. ๐ŸŽž๏ธ
  • -skipsec <min:sec> โ€” Skip min:sec time during viewing of the demo. "-warp <x> -skipsec <min:sec>" will skip min:sec time on level x. โญ๏ธ
  • -strict โ€” Sets compatibility and cosmetic settings according to DSDA rules. ๐Ÿ“
  • -timedemo <demo> โ€” Play back the demo named demo.lmp, determining the framerate of the screen. โฑ๏ธ

โญ COMPATIBILITY โญ

  • -cl <version> โ€” Alias to -complevel. ๐Ÿ”
  • -complevel <version> โ€” Emulate a specific version of Doom/Boom/MBF. Valid values are "vanilla", "boom", "mbf", "mbf21". ๐Ÿ•น๏ธ
  • -gameversion <version> โ€” Emulate a specific version of Doom. Valid values are "1.9", "ultimate", "final", "chex". Implies -complevel vanilla. ๐ŸŽฎ
  • -setmem <version> โ€” Specify DOS version to emulate for NULL pointer dereference emulation. Supported versions are: dos622, dos71, dosbox. The default is to emulate DOS 7.1 (Windows 98). ๐Ÿง 
  • -spechit <n> โ€” Use the specified magic value when emulating spechit overruns. โœจ
  • -statdump <filename> โ€” Dump statistics information to the specified file on the levels that were played. The output from this option matches the output from statdump.exe (see ctrlapi.zip in the /idgames archive). ๐Ÿ“ฆ

๐Ÿ™ˆ OBSCURE AND LESS-USED OPTIONS ๐Ÿ™ˆ

  • -nogui โ€” Don't pop up a GUI dialog box to show the error message. ๐Ÿšซ

๐Ÿ” IWAD SEARCH PATHS โœจ

okay so bestie, to actually PLAY you need an IWAD file. it's this big chonky file that has literally everything โ€” all the levels, the graphics, the sound effects, the music, the whole vibe. it's the entire game basically. ๐Ÿ’–

IWAD files are named after whatever game they are, and the standard names are, like, these:

  • doom.wad, doom1.wad, doom2.wad, tnt.wad, plutonia.wad โ€” Doom, Doom II, Final Doom ๐Ÿ‘‘
  • hacx.wad, chex.wad โ€” Hacx and Chex Quest, the more obscure games based on the Doom engine ๐Ÿฆ‹
  • freedm.wad, freedoom1.wad, freedoom2.wad โ€” the Freedoom open content IWAD files ๐ŸŒˆ

so when Woof goes looking for an IWAD, it checks these directory paths in this order, no cap:

  • Current working directory โ€” any IWAD files chillin' in here get used in preference to IWADs found in any other directories. so like, cwd is the main character here ๐Ÿ’…
  • DOOMWADDIR โ€” this environment variable can be set to hold a path to a single directory to look for IWAD files in. most Doom source ports support it, it's giving legacy icon โœจ
  • DOOMWADPATH โ€” this one, if it's set, can hold a colon-separated list of directories to look in for IWAD files, or alternatively full paths to specific IWAD files. flexible fr fr
  • $HOME/.local/share/games/doom โ€” a writeable directory in the user's home directory. the path can be overridden with the XDG_DATA_HOME environment variable (check the XDG Base Directory Specification for the deets) ๐ŸŽ€
  • /usr/local/share/doom, /usr/local/share/games/doom, /usr/share/doom, /usr/share/games/doom โ€” system-wide locations that all users can access. /usr/share/games/doom is a standard path that most Doom source ports support. these paths can be overridden with the XDG_DATA_DIRS environment variable (again, XDG Base Directory Specification) ๐ŸŒธ

and the way you override all of the above for a one-time thing is the -iwad command line parameter, where you just hand it the path to the IWAD file you wanna use. you can also use this parameter to name a specific IWAD to grab from one of those paths above. like for example, -iwad doom.wad will search all those paths for the file doom.wad to use. obsessed. ๐Ÿซถ


๐Ÿ“ FILES ๐ŸŽ€

  • $HOME/.local/share/woof.cfg โ€” the main configuration file for Woof. go read default.cfg(5) for the full tea.
  • $HOME/.local/share/woof/woofsav*.dsg โ€” savegame files ๐Ÿ’พ
  • $HOME/.local/share/woof/tranmap.dat โ€” cached translucency table โœจ
  • /usr/share/woof/autoload, $HOME/.local/share/woof/autoload/ โ€” WAD files and DEH patches sitting in the subdirectories of these paths get added automatically whenever a WAD file of the corresponding name is loaded. it's giving effortless ๐Ÿ˜Œ

๐Ÿ‘€ SEE ALSO


๐Ÿ‘‘ AUTHOR

Woof! is written and maintained by Fabian Greffrath. it's based on the MBF and WinMBF source codes, which were released by Lee Killough and Team Eternity respectively, and also on the LinuxDoom source code, released by Id Software. iconic lineage tbh ๐ŸŒŸ


Copyright ยฉ id Software Inc; Copyright ยฉ 1999 id Software, Chi Hoang, Lee Killough, Jim Flynn, Rand Phares, Ty Halderman; Copyright ยฉ 2004 James Haley; Copyright ยฉ 2005-2016 Simon Howard; Copyright ยฉ 2020-2022 Fabian Greffrath; Copyright ยฉ 2020-2022 Roman Fomin.

This is free software. You may redistribute copies of it under the terms of the GNU General Public License <http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent permitted by law.

bestie this is the legal bit so listen up: free software, GNU GPL vibes, and literally NO WARRANTY okay?? don't come for anyone if it breaks ๐Ÿ’€

and that's the whole woof(6) page, page two of two, done and dusted ๐ŸŽ€ this one's from the woof(6) manual page (source: the Woof! project, woof(6)), so go forth, frag some demons, and stay slay ๐Ÿ’…โœจ๐Ÿ‘‘

๐Ÿ“ฆ where this page comes from