WOLF4SDL(6)

NAME
Wolf4SDL - Game engine for Wolfenstein 3D and Spear of Destiny

SYNOPSIS
wolf4sdl-wolf-demo [options]
wolf4sdl-wolf-full [options]
wolf4sdl-spear-demo [options]
wolf4sdl-spear-full [options]

DESCRIPTION
Wolf4SDL is an open-source port of id Software's classic first-person shooter Wolfenstein 3D to the cross-platform multimedia library "Simple DirectMedia Layer (SDL)" (http://www.libsdl.org). It is meant to keep the original feel while taking advantage of some modern improvements.

Wolf4SDL is a game engine. To actually play the game, it requires the data files from the original game (see FILES, below).

This man page is for the SlackBuilds.org games/wolf4sdl build, which is based on the last available community version from https://github.com/11001011101001011/Wolf4SDL, with additional patches ported from Debian.

OPTIONS

--help
    Usage summary

--tedlevel <level>
    Starts the game in the given level

--baby
    Sets the difficulty to baby for tedlevel

--easy
    Sets the difficulty to easy for tedlevel

--normal
    Sets the difficulty to normal for tedlevel

--hard
    Sets the difficulty to hard for tedlevel

--nowait
    Skips intro screens

--windowed
    Starts the game in a window, without mouse support.

--windowed-mouse
    Starts the game in a window, with mouse support. The mouse pointer will be unable to leave the game window.

--novert
    Disables vertical mouse motion (see also --modern).

--crosshair
    Shows a crosshair (see also --modern).

--run
    Always run (press both Shift keys to toggle; see also --modern).

--strafe
    Always strafe instead of turning left/right (press both Alt keys or Alt+RightShift to toggle; see also --modern).

--modern
    Same as --novert --crosshair --run --strafe.

--res <width> <height>
    Sets the screen resolution (must be multiple of 320x200 or 320x240). In fullscreen mode, the game switches to the smallest available fullscreen mode that's equal to or larger than the chosen resolution (e.g. 960x720 usually results in a 1024x768 display with black borders).

--resf <width> <height>
    Sets any screen resolution >= 320x200 (which may result in graphic errors, and occasional crashes)

--bits <b>
    Sets the screen color depth (use this when you have palette/fading problems. allowed: 8, 16, 24, 32; default: "best" depth)

--joystick <index>
    Use the index-th joystick if available (-1 to disable joystick, default: 0)

--joystickhat <index>
    Enables movement with the given coolie hat

--samplerate <rate>
    Sets the sound sample rate (given in Hz, default: 44100)

--audiobuffer <size>
    Sets the size of the audio buffer (-> sound latency) (given in bytes, default: 2048 / (44100 / samplerate))

--ignorenumchunks
    Ignores the number of chunks in VGAHEAD.* (may be useful for some broken mods)

--mission <mission>
    wolf4sdl-spear-full only: Mission number to play (0-3, default: 0).
    0 - Original release of Spear of Destiny
    1 - Re-elease of Spear of Destiny by Steam
    2 - Return to Danger
    3 - Ultimate Challenge

--goodtimes
    wolf4sdl-spear-full only: Disable copy protection quiz

--goobers
    wolf4sdl-wolf-full and wolf4sdl-wolf-demo: Enable cheat/debug mode (then press Shift-Alt-Backspace while playing)

--debugmode
    wolf4sdl-spear-full and wolf4sdl-spear-demo: Enable cheat/debug mode (then press Shift-Alt-Backspace while playing)

ENVIRONMENT

WOLF4PATH
    Sets the directory where game data files are searched for. When this variable is not set, the default directory is PREFIX/share/games/wolf3d (PREFIX was set at compile time, and defaults to /usr).

Note that data files are always searched for in the current directory first, regardless of this setting.

FILES
Per-user config files and saved games are stored in ~/.wolf4sdl

Game data files are searched for first in the current directory, then in $WOLF4PATH (see above). Each game binary uses a different set of data files:
Game | Executable | Files
Wolf3D Shareware | wolf4sdl-wolf-demo | *.wl1
Wolf3D Registered | wolf4sdl-wolf-full | *.wl6 or *.wl3
Spear Demo | wolf4sdl-spear-demo | *.sdm
Spear Full Version | wolf4sdl-spear-full | *.sod
wolf4sdl-spear-full --mission 1 | *.sd1
wolf4sdl-spear-full --mission 2 | *.sd2
wolf4sdl-spear-full --mission 3 | *.sd3

All filenames must be in lowercase (e.g. vgahead.wl1, not VGAHEAD.WL1).

The Wolf3D and Spear demo/shareware data files can be downloaded from
http://sourceforge.net/projects/wolfgl/files/
The files are called wolfdata.zip and sdmdata.zip.

The full/registered versions are available commercially. After installing the game (perhaps using DOSBox), the data files will be found in the game's install directory.

To play modified versions of the game ("mods"), place the mod's files in their own directory, cd to that directory, and run the appropriate game binary. The files in the current directory will be used instead of (or in addition to) the ones in /usr/share/games/wolf3d. Remember that only lowercase filenames will work (use "unzip -LL" when extracting). Unfortunately, many available mods include modified versions of the game engine, which are only distributed as Windows or DOS executables, with no source. These are generally unplayable with Wolf4SDL :(

CONTROLS
The controls can be modified from within the game menus. The default controls are:
Keyboard Controls
Up | Move Forward
Down | Move Back
Left | Turn Left (or Strafe Left, with Alt)
Right | Turn Right (or Strafe Right, with Alt)
Space | Open Door
Control | Fire Weapon
Alt | Strafe
Shift | Run
1 | Use Knife
2 | Use Pistol
3 | Use Machine Gun
4 | Use Chaingun
Esc | Go to Main Menu
F1 | Help
F2 | Save Game
F3 | Load Game
F4 | Sound Menu
F5 | Resize View
F6 | Controls Menu
F7 | End Game
F8 | Quick Save
F9 | Quick Load
F10 | Exit

Joystick Controls
X Axis | Turn/Strafe Left/Right
Y Axis | Move Forward/Backward
Button 1 | Fire Weapon
Button 2 | Strafe
Button 3 | Open Door
Button 4 | Run

Mouse Controls
X Axis | Turn/Strafe Left/Right
Y Axis | Move Forward/Backward
Left Button (#1) | Fire Weapon
Right Button (#2) | Strafe
Center Button (#3) | Open Door

Other Controls (non-remappable)
Left Shift + Right Shift | Toggle autorun
Left Alt + Right Alt | Toggle autostrafe
Left Alt + Right Shift | Toggle autostrafe (same as above)

Also, if the game was run with --goobers (Wolf) or --debugmode (Spear), the standard cheat codes are available. Remember to press Alt-Shift-Backspace first, and be careful not to accidentally hit Alt-Ctrl-Backspace instead (*boom*, there goes your X session...)

AUTHORS
Ported by Chaos-Software: http://www.chaos-software.de.vu

Original Wolfenstein 3D by id Software.

The Wolf4SDL project was started by Ripper, and continued by various authors. See https://wl6.fandom.com/wiki/Wolf4SDL for more information.

This man page written for the SlackBuilds.org project by B. Watson, and is licensed under the WTFPL.