Doomsday Engine 2 Manual

https://manual.dengine.net
Admin
The Doomsday Engine is an enhanced source port for Doom, Heretic, and Hexen, offering modern 3D...
Tokens:1,506,681
Snippets:1,532
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example qmake Configuration Option

Source: https://manual.dengine.net/devel/compiling_and_running_1

An example of how to specify an installation prefix for the Doomsday engine build on Unix-like systems using qmake.

```qmake
PREFIX=/some/path
```

--------------------------------

### Starting Doomsday Server with Configuration

Source: https://manual.dengine.net/multiplayer/running_a_server

Provides an example of launching the doomsday-server executable with essential command-line arguments. This includes specifying the game, WAD files, and a custom autoexec.cfg file for server configuration.

```bash
doomsday-server -game doom2 -iwad ~/games/doom/DOOM2.WAD \
    -file ~/games/doom/dwango5.wad -p ~/.doomsday/conf/autoexec.cfg
```

--------------------------------

### Configure Doomsday Data Files

Source: https://manual.dengine.net/guide/getting_started

Details on accessing and configuring Doomsday Engine's data file settings. This includes various access points within the engine's interface and related dialogs.

```APIDOC
Data File Configuration Access Points:

- Game library: Mods tab menu > Settings
- Game library: Button at the bottom of the Mods list
- Task bar: ⚙️ > Data Files
- Game Mods popup
- Dialog for choosing main data file for a custom game

Note: Automatic detection may occur for games purchased from Steam or GOG.
```

--------------------------------

### Doomsday Engine User Guide Navigation

Source: https://manual.dengine.net/version/patch

This entry lists the navigation links for the User Guide section of the Doomsday Manual. It covers topics from introduction and getting started to specific features like the game library, mods, task bar, console, renderer settings, and multiplayer.

```APIDOC
User Guide:
  Introduction: /guide/introduction
  Getting started: /guide/getting_started
  Game library: /guide/game_library
  Mods: /guide/mods
  Task bar and console: /guide/task_bar_and_console
  Configuration: /guide/configuration
  Renderer settings: /guide/renderer_settings
  Multiplayer:
    Running a server: /multiplayer/running_a_server
    Shell: /multiplayer/shell_help
  Troubleshooting: /guide/troubleshooting
  Index: /guide/index
```

--------------------------------

### Building Doomsday with Qt Creator

Source: https://manual.dengine.net/devel/compiling_and_running_1

Step-by-step instructions for building the Doomsday engine using Qt Creator, including project file handling, configuration, and build execution.

```text
1. Open "doomsday.pro" in Qt Creator.
2. Check your "config_user.pri" for build options and SDK paths.
3. Configure qmake options in Projects → Desktop :: Build :: Build Steps (e.g., PREFIX=/some/path on Unix).
4. Run qmake to check for errors.
5. (Skip for Mac OS X) Add a Make deploy step with argument "install" in the Run tab.
6. Build the project: Build → Build Project "doomsday".
```

--------------------------------

### Doomsday Engine Modding and Development Navigation

Source: https://manual.dengine.net/version/patch

This entry outlines the navigation paths for modding and development resources for the Doomsday engine. It includes links to modding introductions, resource overviews, file system details, DED and XG references, scripting, and development getting started guides.

```APIDOC
Modding:
  Introduction: /modding/start
  Resources (v1): /modding/overview_of_resources_doomsday_1.x
  File system:
    Packages: /fs/packages
    Assets: /assets
  DED reference: /ded
  XG reference: /xg/reference_guide
  Scripting: /script/reference

Development:
  Getting started: /devel
  Compiling: /devel/compilation
  Contributing: /devel/contributing
```

--------------------------------

### Amethyst Installation Guide

Source: https://manual.dengine.net/devel/quick_guide_to_amethyst

Instructions for building and installing the Amethyst tool independently. It involves creating a build directory, running CMake for configuration, compiling, and executing the install rule.

```bash
# cmake ../doomsday/tools/amethyst
```

--------------------------------

### Doomsday Configuration File Syntax Example

Source: https://manual.dengine.net/guide/2.0/man/doomsday

An example demonstrating the syntax for configuring audio backends within Doomsday configuration files.

```APIDOC
audio fluidsynth {
    driver: pulseaudio
}
```

--------------------------------

### Autostart Command Line Usage

Source: https://manual.dengine.net/guide/autostart

Demonstrates how to use the Doomsday Engine from the command line to initiate an autostart. This bypasses the standard game startup sequence, allowing direct entry into gameplay.

```APIDOC
Autostart Commands:

An autostart can be accomplished from the command line for various purposes including:

- Warping to a specific map with `-warp`
- Loading a saved game with `-loadgame`

Example Usage:

To warp to a specific map:
`doomsday -warp <map_name>`

To load a saved game:
`doomsday -loadgame <save_game_file>`

These commands allow for direct game entry, skipping the usual user interface and startup sequences.
```

--------------------------------

### Localization File Comment Example

Source: https://manual.dengine.net/snowberry/localizing_snowberry

Provides an example of how to add comments to a localization file. Lines starting with '#' are treated as comments and are ignored by the localization system.

```localization
# $Id: english.lang,v 1.11 2005/01/19 15:41:36 jotkeran Exp $.
```

--------------------------------

### Install doomsday-host

Source: https://manual.dengine.net/multiplayer/doomsday-host

Instructions on how to include the doomsday-host utility in your build. It requires modifying the qmake configuration to add the necessary component.

```APIDOC
Installation:
  Currently [doomsday-host](/multiplayer/doomsday-host "multiplayer:doomsday-host") is not installed by default. You need to use `CONFIG+=deng_host` with [qmake](/multiplayer/qmake "multiplayer:qmake") to include it in the build. The script will then be installed in the binary installation directory (where the **doomsday** executable is also located).
```

--------------------------------

### Path Resolution with '>' Prefix Example

Source: https://manual.dengine.net/guide/paths_on_the_command_line

Illustrates how the Doomsday Engine historically resolved paths starting with a '>' prefix by prepending the base directory. This behavior is now deprecated.

```text
*-file >Data\Doom.wad*

This command would make the engine load a WAD named C:\Doomsday\Data\Doom.wad, assuming C:\Doomsday\ is the default Doomsday root.
```

--------------------------------

### Get Original Display Mode

Source: https://manual.dengine.net/script/module/displaymode

Retrieves the original display mode settings of the desktop environment when the engine was started. The function returns a dictionary containing display properties.

```APIDOC
originalMode(): dictionary
  - Returns the original (i.e., desktop) display mode.
  - The return value is a dictionary with the following structure:
    {
      depth: 32, 
      height: 768, 
      ratio: [ 16, 9 ], 
      refreshRate: 60, 
      width: 1366 
    }
```

--------------------------------

### Doomsday Engine Command Line Arguments

Source: https://manual.dengine.net/guide/2.2/readme_macos

Specifies how to launch the Doomsday Engine from the command line with various options to configure startup behavior, data file loading, and display settings.

```APIDOC
Doomsday.app/Contents/MacOS/Doomsday [options]

---

-file | -f
  Specify one or more data files or packages (*.pack*, PK3, WAD, LMP) to load at startup. When used with `-game`, files are loaded after game startup. Without `-game`, they are registered as available files for runtime loading.

-game | -g
  Sets the game to load after startup. If omitted, the Home screen is shown. Example: `-game doom1-ultimate`.

-h | -? | --help
  Prints a brief list of the command line options.

-iwad
  Specifies a directory where to look for IWAD files. Searches all known games and loads them automatically when needed.

-version
  Show version information.

-wnd | -window
  Starts in windowed mode. Default is fullscreen.

-wh
  Sets the size of the Doomsday window. In fullscreen mode, specifies the display resolution to use.

@
  Can be used to specify a response file whose contents are added to the command line.
```

--------------------------------

### Get help for a specific variable

Source: https://manual.dengine.net/guide/introduction_to_the_console

Retrieves detailed help information for a specified console variable, such as 'rend-tex-filter-smart'. This allows users to understand the purpose and usage of individual settings.

```console
help rend-tex-filter-smart
```

--------------------------------

### WAD DD_DIREC Lump Format Example

Source: https://manual.dengine.net/modding/overview_of_resources_doomsday_1

Illustrates the format of a DD_DIREC lump within a WAD file, which translates file paths to lump names. Paths starting with a backslash are relative to the Doomsday base directory.

```text
FILE001  /Md2/jDoom/Some.md2
FILE002  Another.ded
```
Tokens:
Raw