Additional Options¶

Additional Files¶

Features¶

User interface:

• Home screen for choosing which game to play and which add-ons to use, browsing multiplayer games, and loading saved games
• Task bar overlay for easy access to engine features
• Configuration menus and Renderer Appearance sidebar editor
• On-the-fly add-on resource loading
• Flexible input control bindings system
• Built-in updater for easy upgrades
• In-game command console

Graphics:

• OpenGL 3.3 renderer
• World movement smoothing (actors, monsters, missiles, surfaces) to remove the original games' limitation of 35 FPS
• Stereoscopic rendering modes: anaglyph, side-by-side, cross-eye and parallel viewing
• Bloom, vignette, and fog effects
• Dynamic lights with halos and lens flares
• Dynamic ambient occlusion (corner shadowing) for world surfaces
• Dynamic shadowing effects for world objects
• Particle effects system
• 3D models for world objects, skies, skyboxes, and particles
• Environmental mapping effects for 3D models and world surfaces
• Automatic world surface (light) decorations
• Detail texturing, shine and glowing effects for world surfaces
• Smart texture filtering using a modified hq2x algorithm

Resources:

• 3D models: FBX and MD5 with skeletal animation and OpenGL shaders, MD2 / DMD with LOD support
• High-resolution textures: PNG, JPG, TGA, PCX
• Flexible containers: packages, PK3, WAD, ZIP, uncompressed folders
• External music files in MP3 and other formats
• Plain text definitions for things like map objects, finale animations, and episode structure
• Internal BSP builder (originally based on glBSP)

Audio:

• 3D positional sound effects
• Environmental echo and reverb effects
• External music files in MP3 and other formats
• Uses FMOD (http://www.fmod.org/) for audio playback (sound effects, music, CD audio tracks)
• Supports the open source SDL_mixer (http://www.libsdl.org/projects/SDL_mixer/) for sound effects and music files
• FluidSynth for MIDI playback using SF2 soundfonts
• OpenAL

Multiplayer:

• Supports up to 15 player games
• Clients can join games in progress
• Clients automatically download PWADs loaded on server
• Automatic discovery of servers running on the local network
• Central master server for discovery of servers on the internet
• Standalone server running as a daemon/background process
• Standalone Doomsday Shell (https://manual.dengine.net/Shell) tool for server management (both local and remote)

Other:

• Cross-platform, based on the Qt framework (http://qt.io/)
• Open source (see Getting Started (https://manual.dengine.net/devel))
• Plugin based extensible architecture

Requirements¶

• At least one WAD file from the original Doom, Heretic, Hexen, or other supported game
• GPU with OpenGL 3.3 hardware acceleration

Loading IWADs¶

Doomsday requires IWAD files (http://wiki.dengine.net/w/WAD) to run games. You can use the following ways to let the engine know where your IWADs can be found:

• The first time you launch Doomsday and it doesn't find any IWADs, it will show a tab titled "Data Files?" containing a single button. Clicking the button opens a file dialog where you can pick a folder where your IWAD files are located.
• The directory /usr/share/games/doom is always checked for any recognized IWAD files.
• Using the -iwad command-line option. You can either provide the path to the IWAD to use, or the path of the directory under which IWADs are located. Doomsday will look through the specified location and use all the recognized IWADs automatically. In other words, you can have the IWADs for all games stored in a single directory; Doomsday will use the appropriate one for each launched game.

  -iwad will also accept multiple paths as parameters:

  -iwad path1 path2
• The configuration file ~/.doomsday/paths is checked for iwaddir (see FILES).
• Environment variables DOOMWADDIR and DOOMWADPATH (see ENVIRONMENT).
• The configuration variable Config.resource.packageFolder. This is typically set automatically via the user interface, for instance when you first start Doomsday. Its value can also be manipulated in the Doomsday Script command prompt. (The variable Config.resource.recursedFolders determines if subdirectories should be searched.)

Doomsday tries to recognize IWAD files based on their contents. The identification criteria can be viewed in GitHub (https://github.com/skyjake/Doomsday-Engine/blob/master/doomsday/apps/libdoomsday/net.dengine.base.pack/databundles.dei).

Supported Games¶

One game plugin, such as the Doom Plugin, is able to run many different variants of the game. Each variant emulates a specific version of the original game and typically has its own IWAD file.

Below is a list of all the games supported by the game plugins distributed with Doomsday.

* = has a 4th episode ** = has episodes 4 and 5

Game Library¶

The game library lists all the available games and their associated save files. Each game can be configured to load additional mods (WADs, PK3s, data files, resource packs). You can also add new customized games based on one of the built-in games.

In User Interface settings you can hide entire game tabs, if you are not interested in a particular family of games. See CONFIGURATION for more details.

Sorting games in the library. If you have lots of games available, it may be helpful to change the game library view options so you can more easily find the game you are looking for. Click on the "..." button under the tab title to see the view options.

Starting a game with or without additional mods. Click on a game to select it, or move the selection with the arrow keys. When selected, Mods and Play buttons slide in. The Mods button shows a number for how many additional mods have been selected for loading. Click Play or double-click the game to start the game.

Selecting mods. Click the game's Mods button to choose which additional mods are going to be loaded when the game is started. On the left side of the dialog, you have a list of the mods selected for loading. On the right, you can browse the available mods. The mods browser works similarly to the Mods tab, and it has a search field and Info buttons (see MODS). To add a mod to the game, click the Plus button or double-click the mod.

Loading a saved game. All saved games are listed below the game they were created in. Click on a save to select it, and then press the game's Play button. Clicking on an already selected save will unselect it.

NOTE:

Old savegames created with Doomsday 1.x do not contain information about which data files and mods were in use when the save was created, so Doomsday can't determine which game they belong to. Such saves are listed under each variant of the game.

Savegame information. Right-click on a saved game to see information about the save: which data files and mods were in use, the overall game parameteres, current map, and other status information.

Deleting a saved game. When a savegame is selected, a small X button appears next to it. Clicking the X lets you delete the save.

Save folders. Each game is assigned a unique save folder where all the save files of the game are kept. Right-click on a profile and select "Show Save Folder" to open the folder in operating system file browser. Note that custom games created in version 2.0 or earlier share a save folder with the built-in game. You can use the "Create New Save Folder" menu item to create a new save folder for the custom game, but you will need to manually move the existing save files over there.

Creating a custom game. At the bottom of each game tab, there is a Plus button that creates a new customized game. In the game settings, you can choose which game mode will be used, and which mods are selected for loading. Note that game cannot have a name that is identical to an already existing game in the library.

Duplicate, edit, and delete games. Any game can be duplicated by right-clicking on it and selecting "Duplicate". Games can also be edited to change their name, the primary data file (IWAD), and the set of selected mods.

Mods¶

The Mods tab is used to browse the available mods and other packages. The Mods tab shows all the data files that Doomsday knows about. You can also quickly try out individual mods in one your games.

Configuring the mod search folders. To let Doomsday know where your mods can be found, either select "Settings" in the Mods tab's actions menu (the "..." button under the tab title), or go to Data Files settings (see CONFIGURATION). The mods will not be copied or moved from wherever you keep them.

Browsing mods. The mods list may contains hundreds of items, so you may want to find the mods you're looking for by entering some search terms. Enter the words to search for in the search field at the top of the list. The search is limited to metadata; the actual file contents are not accessed. When entering multiple words, only mods whose metadata contains all the words are shown.

Special search keywords. Some search words have a special meaning:

• "gamedata": Primary game data files (IWADs).
• "hidden": Only mods that are normally hidden will be shown. Mods that are hidden by default include, for example, mods inside other packages that will get automatically loaded.
• "loaded": Only show currently loaded mods. This is useful when browsing mods while playing a game.
• "core": Doomsday's own core packages. These will be automatically loaded as needed.

Viewing information about a mod. Right-click a mod or click on the "..." button to view information about it. In the case of WAD files, all the maps in the WAD are listed so you'll know which map to start when playing. The info popup also shows the game title picture found in the mod, and readme notes provided by the author. In some cases, Doomsday can make a guess about the game that the mod is meant to be used with.

Quickly trying out a mod. One of the most useful features of the Mods tab is quickly loading a mod in one your games. This will make no changes to your existing games. Simply open the mod info popup (as explained above) and click on "Play in...". However, you should first check that the mod actually is compatible with the game you are playing. Also be aware that if you are already running a game, it will be unloaded first and any unsaved progress will be lost.

Quickly adding a mod to a game. The "Add to..." button in the mod info popup will add the mod to one of your existing games. The games that already have the mod are tagged "ADDED" in the list.

Configuring optional contents. Some mods have optional subcomponents. For instance, add-ons that use the Snowberry Box format may include both opt-in and opt-out mods. When viewing information about this kind of collections, an additional "Options" button is shown in the mod info popup. This will let you enable or disable individual contained mods.

Multiplayer¶

The Multiplayer tab lists multiplayer games that you can join. Servers on the local network are discovered automatically and are visible immediately in the Multiplayer games list. The dengine.net (http://dengine.net/) master server is also automatically queried for any public servers.

Viewing server information. Right-click a server in the list to view information about it. The same popup can be opened by clicking the small "..." button in the server description. The status information includes:

• ping time
• which game and map is currently running
• outline of the current map
• list of mods loaded on the server
• list of connected players
• server version

Joining a game. Join an open multiplayer game by clicking "Join" either in the server list or in the server information popup. Any missing mods are downloaded automatically after you click the button.

Player name and color. When a game is running (after joining a multiplayer game or also in single-player), go to the game's "Options" menu and select "Player Setup". In this menu you can change your multiplayer name, player color, and (in Hexen) player class. Note that this is the game's own menu and not part of Doomsday's UI.

Connecting to a non-public server. To connect to a server that is not announced to the master server, select "Connect to Server..." in the Multiplayer tab's actions menu ("..." under the tab title), and enter the server's IP address or domain name.

Failure to connect? Connectivity problems can also be due to your firewall or network address translation (NAT) (https://en.wikipedia.org/wiki/Network_address_translation). Doomsday uses TCP network connections for multiplayer games. If you host a game and are behind a firewall or using NAT, you must make sure that other computers are able to open TCP connections to your computer. This entails opening the appropriate incoming TCP ports on your firewall and/or configuring the NAT so that the correct ports are routed to your computer.

Additionally, UDP ports 13209-13224 are used for detecting servers running on the local network; if you are experiencing problems with autodetecting local servers, check that your firewall isn't blocking these UDP ports on either end.

A server opens one TCP port for listening to incoming connections. The port must be open for incoming TCP traffic in the firewall. The port number is configured with the console variable net-ip-port. By default, a server uses TCP port 13209.

Clients do not require any firewall configuration for incoming connections. A client only needs to be able to reach the server via the server's TCP port.

You can see status information about the network subsystem with the console command:

Hosting a game. Use doomsday-shell or doomsday-shell-text to host a multiplayer game of your own. The Shell allows you to start, stop, and control Doomsday multiplayer servers. This includes both your own local servers and remote servers on the internet.

doomsday-server runs in a background process and has no UI of its own. The Shell provides a couple of basic game options that you can change via the GUI. For example, you can choose between Deatchmatch and Co-op mode, change the current map, and enable or disable monsters. The full set of console variables can be modified via the Console tab (text-mode command line interface).

If your server is not public (i.e., announced to the master server), a client can connect to it manually using the IP address or domain name.

For more information about the Shell, see Shell Help in the wiki (https://manual.dengine.net/Shell_Help).

App Menu¶

The rightmost button in the task bar (with the DE logo) opens the Doomsday app menu.

Tutorial. The first-run tutorial points out the basic features of Doomsday's UI. It is only shown once, but you can manually show it again by selecting "Help: Show Tutorial".

Browsing and loading mods. "Browse Mods..." opens the mod browser in a sidebar where mods can be loaded and unloaded manually. You can also view information about mods like in the Home screen. The sidebar is only available when a game is loaded. You can use the "loaded" keyword to filter the list so that only the currently loaded mods are listed.

NOTE:

Data from newly loaded mods may not be used until a new map is started in the game. Use of external textures can be enabled and disabled in Renderer settings.

Checking for updates. Doomsday queries the dengine.net website to see if there are newer builds and shows a notification when updates are available. You can always also do a manual update check by selecting "Check for Updates".

Clearing the resource cache. Some resources and metadata get cached for later access. This allows Doomsday to load the resources faster and operate more efficiently. Usually it is unnecessary to clear the cache manually. See FILES for the cache's location.

Configuration¶

The task bar's Gear button opens the configuration menu. This is where the majority of Doomsday's settings can be viewed and changed. Some of the settings are only available when a game is loaded ("Input", for instance).

Reset to defaults and advanced settings. Many settings dialogs have a "Reset to Defaults" button. This affects only the settings in that one particular dialog. Sometimes a Gauge button is also available. It is reserved for advanced settings that are useful for developers and modding.

Renderer settings. Most of the renderer settings are managed via appearance profiles. This makes it easy to select one of the presets, such as a vanilla look or more exaggerated effects. The dialog has a couple of general settings in addition to the active appearance profile. The "Pixel Density" slider is particularly useful as it allows improving rendering performance and achieving a more pixelated, 1990s VGA-style look. The selected appearance profile applies to all games.

Some resource packs with high-resolution textures are intended to be used with the unmodified original games. However, a PWAD file may replace some of the textures with custom ones. The "External Images" options allow you to control when external images are actually enabled if the resource packs in use aren't compatible with the loaded PWADs.

Renderer appearance sidebar. Click the Gear button next to the selected renderer appearance profile and select "Edit" or "View" to open the appearance sidebar. Alternatively you can open the sidebar with the rendedit console command. Individual settings groups can be folded and unfolded by clicking on the group titles. You can continue playing the game while the sidebar is visible. When you're done, dismiss the sidebar with the X button in the top right corner.

Video aspect ratios. In addition to basic game window parameters, the Video settings dialog has a set of aspect ratio options. These control the aspect ratios applied to specific elements in the game:

• "Original 1:1": The aspect ratio is exactly as in the original game.
• "Smart": The aspect ratio is dynamic but does not stretch too far away from the 1:1 ratio.
• "Stretched": The aspect ratio is unrestricted and adapts to window dimensions. Game elements may appear too wide or tall with this setting.

Audio backend. Audio output capabilities vary based on operating system and audio hardware. Doomsday's audio backend can be configured according to your needs primarily via the selection of audio interface plugins. The recommendation on all platforms is FMOD for sound effects and FluidSynth for music, because these two enable software-based rendering of both 3D sound effects and MIDI music. Some of the audio options are dependent on the active audio plugins. For example, a MIDI sound font is supported by the FMOD and FluidSynth plugins. 3D sound and reverb are supported by FMOD, OpenAL, and DirectSound. The audio backend can be reconfigured on the fly; any changes are applied when you press the "Apply" button.

Game controllers. Doomsday comes with a few preset bindings for different gamepads. To use one of the presets, click on the "Game Controller Preset" button and select a suitable one. Then click "Apply" to erase all your existing game controller bindings and activate the ones in the preset. You can still manually edit the bindings in the game's "Options" menu.

Mouse input settings. The "Sync Axis Sensitivities" option will ensure that mouse sensitivity is the same in both the horizontal and vertical directions.

Minimizing mouse latency. The default input settings try to replicate the feel of the original 35 Hz input events of Doom. However, when the screen is actually refreshed at a higher rate, this may feel distractingly laggy. The 35 Hz limiter can be disabled in the advanced input settings (click the Gauge button). This will minimize mouse input latency as much as possible. You may additionally want to disable mouse filtering by toggling the "Filter X Axis" and "Filter Y Axis" options.

Local multiplayer mods. By default, clients are not allowed to load mods in addition to what the server is using. This avoids any potential compatibility issues with the client's mods overriding some of the game's definitions. However, you can manually enable local mods in Network settings. You can then select additional local mods for multiplayer games in the server information popup before joining the game.

User Interface settings. The "Scale" setting applies to the Doomsday UI only, and adjusts the overall size of UI elements and fonts. Lowering the UI scaling may be helpful for example when using a very low display resolution. In the Home screen there will be more tabs visible at the same time when using a smaller UI scale.

Updater settings. The Updater settings determine when Doomsday will check for available updates. When an update is downloaded, it is saved to your temporary files folder.

Log History and Log Options Menu¶

The log message history panel slides in from the left edge of the view. When visible, you can drag its right edge to resize it.

The leftmost button in the task bar opens the log options menu:

Command Prompt¶

The middle of the task bar is occupied by a command prompt text field. Here you can enter console commands and modify console variables manually. This is typically most useful for developers, modders, and other advanced users.

Console basics. Type help to get started. This prints some basic information about how to use the console, and commands for listing all the available console commands and variables (https://manual.dengine.net/consolevariable). At any time, press Tab to autocomplete the word being typed. This will pop up a list of all possible completions, including the current values for any variables. You can change console variable values as follows:

Shortcut key. You should set up a console shortcut key if you find yourself going to the console often. The shortcut defaults to Tilde (U.S. keyboard) but you can choose your own shortcut key by clicking the ">" button next to the command prompt.

Interactive Doomsday Script prompt. Doomsday Script is a fully-fledged Python/Ruby-like scripting language built into Doomsday 2. While it doesn't yet allow full access to all engine features, it is being improved in each release. The command prompt can be switched to Doomsday Script mode by right-clicking the ">" prompt menu button. Everything entered into the command prompt is then run as Doomsday Script. This mode is intended only for developers.