Configuration file

From ZDoom Wiki
(Redirected from The ini)
Jump to navigation Jump to search

This article is a stub. Please help the ZDoom Wiki by adding to it.

The configuration file used by UZDoom is an INI file that contains configuration settings for UZDoom. It is frequently referred to as just uzdoom.ini or "the ini file" when the context is clear.

The -config Command line parameters lets you use a different configuration file from the one used by default.

Configuration Location

Windows

UZDoom comes in portable and non-portable modes, which affect where the ini file is stored:

  • Portable: The ini is stored in UZDoom's folder as uzdoom_portable.ini, and can be created forcefully by first creating a file called uzdoom_portable.ini in UZDoom's folder..
  • Non-portable: the ini is placed in Documents\My Games\UZDoom\uzdoom.ini by default. If you still have an old INI in your folder, UZDoom will ask what to do with it, you can either move it to the user folder or convert to a portable install.

This was done to bring handling in line with current guidelines and to make it easier for commercial games that often get installed into a folder without write access.

The .ini extension may be hidden if the default setting of letting the Explorer hide known file extensions is kept.

Linux

The default location of the configuration file is /home/Username/.config/uzdoom/uzdoom.ini, where "Username" is your system user.

macOS

The default location of the configuration file is /User/Username/Library/Preferences/uzdoom.ini, where "Username" is your system user.

Environment Variables

You are able to use system environment variables in the uzdoom.ini file. By default, the following environment variables are already set up in the configuration file:

.
References the current directory that UZDoom is launched from within your terminal or console.
For example if you are in /home/Username/a/b/c/d/ when you start UZDoom, it will look in that directory for WADs.
  • On Linux and macOS environments, $PWD is able to be used instead.
$DOOMWADDIR
References a system environment variable of the same name that contains a search directory.
$DOOMWADPATH
References a system environment variable of the same name whose value contains a semicolon (on Windows) or colon (on other systems) delimited list of searchable directories.
It's similar to $DOOMWADDIR, except that $DOOMWADPATH is a list of possible search directories.
$HOME
References your system user directory.
  • On Windows, that will likely default to C:\Users\Username\
  • On most Linux environments, that will likely default to $HOME (/home/Username)
  • On macOS environments, that will default to $HOME (/User/Username)
$PROGDIR
References the directory that the main binary is located in.
  • On Windows this is next to "UZDoom.exe".
  • On Linux this is likely to be next to where the main binary is for the app, and may differ from distro to distro.
  • On macOS this is likely to be "/Applications/UZDoom.app/Content/Resources"