DooM LEGACY Release v1.30, August 2000. Last Updated: August 2000 Original game & sources by: Id Software. Additions: (c)1998 by: Fabrice Denis & Boris Pereira (c)1999 by: Fabrice Denis, Boris Pereira & Thierry Van Elsuwe (c)2000 by: Boris Pereira & Thierry Van Elsuwe Special thanks to Steven McGranahan, Robert Bäuml and Bell Kin for their large contribution and to others Legacy Team members. Web site: http://www.newdoom.com/doomlegacy e-mail: legacy@newdoom.com OpenGL specific: Web site: http://www.newdoom.com/doomlegacy/gl ----------------------------------------------------------------------- CONSOLE DOCUMENTATION ----------------------------------------------------------------------- Make sure you read this! You will discover a lot of goodies available in Legacy! Be a doom 'power-user' ! Skip to section 2, and browse through the list of commands if you're in a hurry! -------- CONTENTS -------- [0] What's new? [1] Console basics [1-1] Console usage [1-2] Console input [1-3] Commands and variables [1-4] Config.cfg file [1-5] Autoexec.cfg file [1-6] Script files [2] Commands and Variables [2-1] Basic script commands [2-2] Console setup [2-3] Player setup [2-4] Game controls [2-5] Game options [2-6] Video [2-7] Multiplayer [2-8] Demos [2-9] Miscellaneous [2-10] Sound [2-11] Unfinished IMPORTANT NETWORK NOTE: Unless specified otherwise, all commands are working in multiplayer. If a command does not seem to work in multiplayer, it is a *bug*, not an unfinished feature :), so please mail us! --------------- [0] What's new? --------------- Changes from 1.29 to 1.30 ========================= - section [2-4] : added mousemove - section [2-5] : added restartlevel - section [2-6] : added scr_depth, scr_height, scr_width - section [2-7] : added allowmlook, allowrocketjump - section [2-11] : added connect, fullscreen Changes from 1.28 to 1.29 ========================= - section [2-7] : updated map, added allowturbo, allowexitlevel sv_maxplayers, sv_allownewplayer - section [2-2] : changed con_size to con_height (like it was in the code) - section [2-6] : added translucency, splats, screenlink - section [2-4] : added controlperkey, use_mouse2, alwaysmlook2, mousesens2, mlooksens2, mouse2port - section [2-5] : added splitscreen - section [2-9] : update help, added netstat - section [2-11]: update bloodtime - section [2-12]: added OpenGL/Glide commands Changes from 1.27 to 1.28 ========================= - section [2-4] : updated 'use_joystick' - section [2-4] : updated 'overlay' - section [2-5] : 'fastmonsters','cam_height','cam_dist', 'cam_speed' - section [2-7] : updated 'map' - section [2-7] : 'timelimit' - section [2-8] : 'playdemospeed' - section [2-9] : 'addfile' Changes from 1.25 to 1.27 ========================= - section [2-7] : 'sayteam','sayto','fraglimit' - section [2-4] : 'bind' - section [2-9] : 'screenshot','vid_ticrate', 'saveconfig','loadconfig','changeconfig' - section [2-5] : 'save','load','exitlevel' - section [2-11]: updated 'map' - section [2-8] : 'timedemo' - section [2-9] : 'addfile' Changes from 1.24 to 1.25 ========================= - section [2-5] : 'viewheight' - section [2-7] : 'skin','teamplay','teamdamage','frags','teamfrags' - section [2-9] : 'memfree','help' Changes from 1.22 to 1.24 ========================= - section [2-10] : 'cd', 'cd_update', 'cd_volume'. - section [2-11] : 'map' command now works in multiplayer, only the server can change it (note: make sure everybody use the same maps). - section [2-7] : 'gravity' command. ------------------ [1] Console basics ------------------ [1-1]: Console usage ==================== With Doom Legacy's console, you will be able to change a lot of parameters from the game, and customise the game to your preferences. The console is simply a command prompt, where you can enter commands and change the value of game variables. Since the first console we know of was from IdSoftware's game 'Quake', we have been inspired by this console, and have tried to use the same functionality for the Quake-Doom fans. To bring the console, press the '`' tilde key. You can set the console key at the Setup Controls menu. To exit the console, either press again the console key, or press ESC. ESC will bring the menu, and shut the console. The console displays all messages from the game. You can go back in the messages with key 'PAGE UP', and go down with the key 'PAGE DOWN'. Press the key 'HOME' to jump to the oldest message in the console text buffer, and key 'END' to jump to the last output message (the most recent). The last lines of the console text buffer are displayed at the top of the screen, when the console is off. That is, you can see 5 lines of messages instead of only 1 in the original Doom. You can change the duration of display of the messages with the console variable 'con_hudtime', see the commands section for more. [1-2]: Console input ==================== While the console is on, you can type any key to enter a command. Press 'BACKSPACE' to delete the last character. Press 'ENTER' to execute the command. For convenience, you have an history of the last 32 commands entered. Press 'UP ARROW' to go back in the commands history, 'DOWN ARROW' to go forward. Another very useful key is the 'TAB' key : it completes the command or variable name that has not been fully entered. This is a very good way to check for the existing commands : just enter any letter, then press 'TAB' several times to see what commands are available. Example: the variables to customize the console itself usually start with 'con_', thus typing 'con' and pressing the 'TAB' key several times will display the following console variables : 'con_height', 'con_speed', 'con_hudtime', 'con_backpic'... You can also press 'SHIFT-TAB', which will complete the command line, but in reverse order. [1-3]: Commands and Variables ============================= Basically, a command does not have a value, and is not saved to the configuration file. A variable always have an associated value, for example the variable 'name' holds your name as a player. Entering a command without any parameters, will usually tell you the command syntax. Example: entering 'map' will show: map : warp to map, load external map Entering a variable without any parameter, will tell you the current value of the variable. Example: entering 'name' will show: "name" is "gi joe" When a parameter has blanks in it, use "" around it. Example: to enter your name as 'dj fab' type: name "dj fab" Most variables that are either true or false use '0' as false, and any other value which is not zero is true. [1-4]: Configuration file ========================= Most variables are automatically saved to the default configuration file 'config.cfg'. Like in the original Doom, the -config parameter will set explicitly the configuration file to use. Example: legacy -config fab.cfg Thus, you can have default settings for different persons, using different configuration files. While the configuration file supports any command, and is executed like a script, you should not edit it, because it is always overwritten when the game exits. [1-5]: Autoexec.cfg file ======================== The autoexec.cfg file is a text 'script' file which is automatically executed at the game startup, if it is found. You can edit the autoexec.cfg file to set the values of those variables that are not automatically saved to 'config.cfg'. You can also add commands that will be executed one after another, just like a script. Comments starts with '//'. Each line of the autoexec.cfg file is like a line that you would have typed at the console. Here's some examples: This sample 'autoexec.cfg' will warp you to map 01 as soon as the game is loaded: ----------autoexec.cfg example 1----------------- // start always with map1, without waiting at the menu map map01 echo "welcome to map 01" //useless comment ------------------------------------------------- Another example, here we set the variables that are not saved to the config.cfg, because they are not considered like 'standard' parameters: ----------autoexec.cfg example 2----------------- // set my preferred weird game mode bloodtime 5 // blood lasts 5 seconds solidcorpse 1 turbo 150 map map07 echo "bigjim's weird mode active" ------------------------------------------------- In the last example, each time you start the game, it will set the variables like 'bloodtime' that are not normally saved to config.cfg. Just look at config.cfg to know which variables are saved. [1-6]: Script files =================== The config.cfg, and autoexec.cfg are script files. It means they contain commands and variables that are executed in sequence. You can create any number of script files, and execute them with the 'EXEC' command. For example, to start a script named 'blood.cfg' just enter exec blood.cfg -------------------------- [2] Commands and variables -------------------------- Please note that the most common options are changeable at the menus, and will set the corresponding variables. You will need to use the console only if you want to customise the game more to your needs. [2-1] Basic script commands =========================== Here are the basic commands for script execution, they have the same usage and functionality as in the game 'Quake'. You can use ; to separate several commands in the same line. alias When you will type 'aliasname', it will do like if you had entered 'command'. Let's better have an example: :) alias silence "soundvolume 0;music volume 0" Further, when you will type 'silence', it will execute the corresponding command. In this example, we have given two commands as one, inside " ", and using the ; as a separator for commands. echo <"text to output"> Just echoes text to the console. Like 'print' in Basic :) exec