replaced rainsplash animation with just a single particle which expands over time...

[divverent/darkplaces.git] / darkplaces.txt

DarkPlaces engine readme : updated 20060215\r
\r
About the DarkPlaces glquake engine:\r
DarkPlaces engine was started because I was unsatisfied with the other engines\r
available soon after the quake source release (which did little more than add\r
some flashy effects), and craved modding features for my DarkPlaces mod, and\r
wanted some real enhancements to the online gaming experience as well.\r
\r
DarkPlaces engine is the result, I hope everyone likes it.\r
\r
See the end of this file for information on how to install Quake from CD on\r
Windows, Mac OSX, and Linux.\r
\r
I am not very good at writing documentation, so this readme is organized as a\r
feature list, with information on each feature, I hope it is still adequate\r
documentation.\r
\r
Input Tips:\r
If mouse movement is jerky but framerate is high, try typing "gl_finish 1"\r
(without quotes) into the console (makes cpu wait for gpu before ending frame,\r
which gives lousy input drivers a chance to catch up).\r
\r
Graphics Tips:\r
Visit the Color Control submenu of Options, it's near the top, fiddle with\r
gamma (or grey level if using the color levels mode) until the grey box\r
surrounding the white/black dither pattern matches up with the grey you see\r
while looking at the dither from a distance, this will calibrate quake to look\r
approximately as id Software intended, and ensure everyone sees it the same.\r
Note: Different resolutions may be different intensities depending on monitor.\r
Note2: ATI Radeon Catalyst 3.10 drivers seem to have a weird gamma limiting\r
'feature' which rejects gamma settings it doesn't like, feel free to complain\r
to ATI about this if it gets in your way (it probably will).\r
\r
Visit the Effects Options submenu of Options, and check out the options.\r
\r
Networking tips:\r
Visit the Player Setup submenu of the Multiplayer menu to configure your\r
network speed (as well as the usual settings from quake like name and colors).\r
\r
To host a server behind a router/firewall, simply set up a port forward on the\r
UDP port you are running the server on (default is 26000), to forward incoming\r
UDP packets on that port to the server, then people can connect.\r
\r
To make your server show up on the server browser (in the Join Game menu),\r
either set sv_public 1 in the console, or use the multiplayer new game menu\r
and check the Public server checkbox.\r
\r
Thanks to:\r
Tomaz for adding features, fixing many bugs, and being generally helpful.\r
Andreas 'Black' Kirsch for much work on the QuakeC VM (menu.dat, someday clprogs.dat) and other contributions.\r
Mathieu 'Elric' Olivier for much work on the sound engine (especially the Ogg vorbis support)\r
MoALTz for some bugfixes and cleanups\r
Joseph Caporale for adding 5 mouse button support.\r
KGB|romi for his contributions to the Quake community, including his rtlights project and many suggestions, his id1 romi_rtlights.pk3 is included in darkplaces mod releases.\r
Zombie for making great levels and general DarkPlaces publicity.\r
FrikaC for FrikQCC and FrikBot and general community support.\r
Transfusion Project for recreating Blood in the world of Quake.\r
de-we for the great icons.\r
|Rain| for running my favorite anynet IRC server and his bot feh (which although a bit antisocial never seems to grow tired of being my calculator).\r
VorteX for the DP_QC_GETTAGINFO extension.\r
Ludwig Nussel for the ~/.games/darkplaces/ user directory support on non-Windows platforms (allowing games to be installed in a non-writable system location as is the standard on UNIX but still save configs to the user's home directory).\r
\r
Questions/comments/bugreports/suggestions?\r
Send email to lordhavoc@ghdigital.com.\r
\r
\r
\r
Supported games:\r
Quake : -quake, this is active by default, gamedirs: id1\r
Quake: Scourge of Armagon : -hipnotic or hipnotic in executable name or path, gamedirs: hipnotic, id1\r
Quake: Dissolution of Eternity : -rogue or rogue in executable name or path, gamedirs: rogue, id1\r
Nehahra : -nehahra or nehahra in executable name or path, gamedirs: nehahra, id1\r
GoodVsBad2 : -goodvsbad2 or gvb2 in executable name or path, gamedirs: rts\r
BattleMech : -battlemech or battlemech in executable name or path, gamedirs: base\r
PrydonGate : -prydon or prydon in executable name or path, gamedirs: prydon\r
These games are considered officially supported, if any problems are seen,\r
please make sure you are running the latest version of the game and engine,\r
if you are, please report the problem.\r
\r
\r
\r
Future supported games:\r
Nexuiz : -nexuiz or nexuiz in executable name or path, gamedirs: data\r
Zymotic : -zymotic or zymotic in executable name or path, gamedirs: data\r
Fniggium : -fniggium or fniggium in executable name or path, gamedirs: data\r
Setheral : -setheral or setheral in executable name or path, gamedirs: data\r
SonOfMan : -som or som in executable name or path, gamedirs: data\r
These have incomplete support and will likely change before their release.\r
\r
\r
\r
Graphics features:\r
Redesigned effects including smoke, blood, bubbles and explosions.\r
Better looking dynamic lights.\r
External texture support (see dpextensions.qc DP_GFX_EXTERNALTEXTURES)\r
Realtime bumpmapped lighting/shadowing support (see r_shadow_help in game)\r
.rtlights file support (improves performance/appearance of realtime lighting)\r
.rtlights file editing (see r_editlights_help in game)\r
Alpha blended sprites (instead of glquake's masked sprites).\r
Interpolated entity movement and animations (both models and sprites).\r
Overbright and fullbright support on walls and models (like winquake).\r
Colormapping support on any q1 model (like winquake).\r
Fog (set with "fog density red green blue" command)\r
Skybox (loadsky "mtnsun_" will load "env/mtnsun_ft.tga" and so on).\r
Sky rendering improved (no more glquake distortion).\r
Sky polygons obscure geometry just like in winquake.\r
Color calibration menu to ensure a proper Quake experience.\r
Improved model lighting (directional shading).\r
No messy .ms2 model mesh files (no glquake dir anymore either).\r
New improved crosshair (team color coded).\r
Improved image loading (smoother menus and such).\r
Ability to disable particle effects (cl_particles* cvars).\r
Decals (cl_decals cvar to enable).\r
Stainmaps (cl_stainmap cvar to enable).\r
Sorted transparent stuff to render better.\r
Improved multitexture support (r_textureunits (1-4 supported), needs gl_combine 1 because of overbright)\r
Improved chase cam (chase_active 1 no longer goes into walls)\r
More configurable console background (scr_conalpha and scr_conbrightness)\r
Optional fullbrights (r_fullbrights 0/1 followed by r_restart)\r
Dynamic Farclip (no distance limits in huge maps)\r
Improved gl_flashblend (now renders a corona instead of an ugly blob)\r
DynamicLight coronas (more realism)\r
Transparent statusbar (sbar_alpha) that does not block your view as much.\r
No 8bit texture uploads (fixes 'green' walls in the distance).\r
Fixed view blends (glquake was quite broken).\r
JPEG texture support using libjpeg (Thanks Elric)\r
PK3 archive support with compression support using zlib (Thanks Elric)\r
\r
Sound features:\r
Ogg and wav file overrides for cd tracks (example: sound/cdtracks/track01.ogg or .wav) (Thanks Elric)\r
Streaming ogg sounds to save memory (Ogg sounds over a certain size are streamed automatically) (Thanks Elric)\r
Ogg Vorbis sound support (all .wav sounds look for .ogg if the .wav is missing, useful for making mods smaller, particularly for ambientsound() music) (Thanks Elric)\r
Stereo wav support (useful for music as ambientsound() calls)\r
\r
Client features:\r
showtime cvar.\r
showdate cvar.\r
-benchmark option to run automated timedemo benchmarks (-benchmark demo1 does +timedemo demo1 and quits immediately when finished)\r
automatic timedemo logging to gamedir/benchmark.log\r
Slightly improved aiming on quake servers (does not support proquake aiming).\r
-sndspeed samplerate (default: 44100, quake used 11025)\r
snd_swapstereo cvar (for people with backwards SB16 sound cards)\r
Saves video settings to config and restores them properly\r
Ability to change video settings during game (video options menu or vid_* cvars)\r
showfps cvar.\r
Video Options, Color Control, and Effects Options menus added, and more options.\r
Sends 20fps network packets to improve modem play instead of one per frame. (sys_ticrate controls network framerate)\r
Allow skin colormaps 14 and 15 (freaky :)\r
Longer chat messages.\r
No more 72fps limit, host_maxfps lets you decide.\r
Support for more mouse buttons (mouse1-mouse16, mwheelup/mwheeldown are aliases to mouse4 and mouse5).\r
Server browser for public (sv_public 1) darkplaces servers.\r
log_file cvar to log console messages to a file.\r
condump command to dump recent console history to a file.\r
\r
Server features: (Note server only supports darkplaces clients)\r
Allows clients to connect through firewalls (automatic feature)\r
Works behind firewalls unlike NetQuake (must port forward UDP packets on the relevant port from the firewall to the server, as with any game)\r
More accurate movement and precise aiming.\r
64 player support.\r
sv_cheats cvar controls cheats (no longer based on deathmatch).\r
slowmo cvar controls game speed.\r
No crash with the buggy 'teleport train' in shub's pit.\r
Allow skin colormaps 14 and 15 (freaky :)\r
sys_ticrate applies to listen (client) servers as well as dedicated.\r
sv_public cvar to advertise to master server.\r
log_file cvar to log console messages to a file.\r
condump command to dump recent console history to a file.\r
\r
Modding features:\r
HalfLife map support (place your HalfLife wads in quake/id1/textures/ or quake/MODDIR/textures/ as the maps need them)\r
Larger q1 and hl map size of +-32768 units.\r
Colored lighting (.lit support) for q1 maps.\r
Q3 map support (no shaders though), with no limits.\r
Q2 and Q3 model support, with greatly increased limits (256 skins, 65536 frames, 65536 vertices, 65536 triangles).  (Note: md2 player models are not supported because they have no skin list)\r
Optimized QuakeC interpreter so mods run faster.\r
Bounds checking QuakeC interpreter so mods can't do naughty things with memory.\r
Warnings for many common QuakeC errors.\r
Unprecached models are now a warning (does not kill the server anymore).\r
External texture support (see dpextensions.qc DP_GFX_EXTERNALTEXTURES).\r
Fog ("fog" key in worldspawn, same parameters as fog command).\r
.spr32 and halflife .spr sprites supported.  (Use Krimzon's tool to make spr32, and lhfire can render directly to spr32, or just use replacement textures on .spr).\r
Skybox ("sky" key in worldspawn, works like loadsky and quake2).\r
Stereo wav sounds supported.\r
Ogg Vorbis sounds supported. (Thanks Elric)\r
ATTN_NONE sounds are no longer directional (good for music).\r
play2 sound testing command (ATTN_NONE variant of play).\r
r_texturestats and memstats and memlist commands to give memory use info.\r
Lighting on sprites (put ! anywhere in sprite filename to enable).\r
More r_speeds info (now a transparent overlay instead of spewing to console).\r
Supports rotating bmodels (use avelocity, and keep in mind the bmodel needs the "origin" key set to rotate (read up on hipnotic rotation support in your qbsp docs, or choose another qbsp if yours does not support this feature), or in q3 maps an origin brush works).\r
More sound channels.\r
More dynamic lights (32 changed to 256).\r
More precached models and sounds (256 changed to 4096).\r
Many more features documented in dpextensions.qc. (bullet tracing on models, qc player input, etc)\r
\r
Commandline options as of 2004-10-05:\r
BSD GLX: -gl_driver <drivername> selects a GL driver library, default is libGL.so.1, useful only for using fxmesa or similar, if you don't know what this is for, you don't need it\r
BSD GLX: -nogetprocaddress disables GLX_ARB_get_proc_address (not required, more formal method of getting extension functions)\r
BSD GLX: -novideosync disables GLX_SGI_swap_control\r
BSD Sound: -cddev <devicepath> chooses which CD drive to use\r
Client: -benchmark <demoname> runs a timedemo and quits, results of any timedemo can be found in gamedir/benchmark.log (for example id1/benchmark.log)\r
Client: -forceqmenu disables menu.dat (same as +forceqmenu 1)\r
Client: -particles <number> changes maximum number of particles at once, default 32768\r
Client: -texbrightness <number> sets the quake palette brightness (brightness of black), allowing you to make quake textures brighter/darker, not recommended\r
Client: -texcontrast <number> sets the quake palette contrast, allowing you to make quake textures brighter/darker, not recommended\r
Client: -texgamma <number> sets the quake palette gamma, allowing you to make quake textures brighter/darker, not recommended\r
Client: -useqmenu causes the first time you open the menu to use the quake menu, then reverts to menu.dat (if forceqmenu is 0)\r
Console: -condebug logs console messages to qconsole.log with sync on (so it keeps every message up to a crash), see also log_file and log_sync\r
Console: -developer enables warnings and other notices (RECOMMENDED for mod developers)\r
Console: -nostdout disables text output to the terminal the game was launched from\r
Filesystem: -basedir <path> chooses what base directory the game data is in, inside this there should be a data directory for the game (for example id1)\r
Filesystem: -path <path ..> specifies the full search path manually, overriding the generated one, example: -path c:\quake\id1 c:\quake\pak0.pak c:\quake\pak1.pak (not recommended)\r
GL: -noanisotropy disables GL_EXT_texture_filter_anisotropic (allows higher quality texturing)\r
GL: -nocombine disables GL_ARB_texture_env_combine or GL_EXT_texture_env_combine (required for bumpmapping and faster map rendering)\r
GL: -nocubemap disables GL_ARB_texture_cube_map (required for bumpmapping)\r
GL: -nocva disables GL_EXT_compiled_vertex_array (renders faster)\r
GL: -nodot3 disables GL_ARB_texture_env_dot3 (required for bumpmapping)\r
GL: -nodrawrangeelements disables GL_EXT_draw_range_elements (renders faster)\r
GL: -noedgeclamp disables GL_EXT_texture_edge_clamp or GL_SGIS_texture_edge_clamp (recommended, some cards do not support the other texture clamp method)\r
GL: -nofragmentshader disables GL_ARB_fragment_shader (currently unused, allows pixel shader effects)\r
GL: -nomtex disables GL_ARB_multitexture (required for faster map rendering)\r
GL: -noshaderobjects disables GL_ARB_shader_objects (required for vertex shader and fragment shader)\r
GL: -noshadinglanguage100 disables GL_ARB_shading_language_100 (required for vertex shader and fragment shader)\r
GL: -nostenciltwoside disables GL_EXT_stencil_two_side (accelerates shadow rendering)\r
GL: -notexture3d disables GL_EXT_texture3D (required for spherical lights, otherwise they render as a column)\r
GL: -notextureshader disables GL_NV_texture_shader (required for the Geforce3 water shader, NVIDIA only)\r
GL: -novertexshader disables GL_ARB_vertex_shader (currently unused, allows vertex shader effects)\r
Game: -battlemech runs the multiplayer topdown deathmatch game BattleMech\r
Game: -fniggium runs the post apocalyptic melee RPG Fniggium\r
Game: -goodvsbad2 runs the psychadelic RTS FPS game Good Vs Bad 2\r
Game: -hipnotic runs Quake mission pack 1: The Scourge of Armagon\r
Game: -nehahra runs The Seal of Nehahra movie and game\r
Game: -neoteric runs the game Neoteric\r
Game: -netherworld runs the game Netherworld: Dark Masters\r
Game: -nexuiz runs the multiplayer game Nexuiz\r
Game: -openquartz runs the game OpenQuartz, a standalone GPL replacement of the quake content\r
Game: -prydon runs the topdown point and click action-RPG Prydon Gate\r
Game: -quake runs the game Quake (default)\r
Game: -rogue runs Quake mission pack 2: The Dissolution of Eternity\r
Game: -setheral runs the multiplayer game Setheral\r
Game: -som runs the multiplayer game Son Of Man\r
Game: -tenebrae runs the graphics test mod known as Tenebrae (some features not implemented)\r
Game: -teu runs The Evil Unleashed (this option is obsolete as they are not using darkplaces)\r
Game: -transfusion runs Transfusion (the recreation of Blood in Quake)\r
Game: -zymotic runs the singleplayer game Zymotic\r
Input: -nomouse disables mouse support (see also vid_mouse cvar)\r
Linux ALSA Sound: -sndbits <number> sets sound precision to 8 or 16 bit (email me if you want others added)\r
Linux ALSA Sound: -sndmono sets sound output to mono\r
Linux ALSA Sound: -sndpcm <devicename> selects which pcm device to us, default is "default"\r
Linux ALSA Sound: -sndspeed <hz> chooses 44100 hz, 22100 hz, or 11025 hz sound output rate\r
Linux ALSA Sound: -sndstereo sets sound output to stereo\r
Linux GLX: -gl_driver <drivername> selects a GL driver library, default is libGL.so.1, useful only for using fxmesa or similar, if you don't know what this is for, you don't need it\r
Linux GLX: -nogetprocaddress disables GLX_ARB_get_proc_address (not required, more formal method of getting extension functions)\r
Linux GLX: -novideosync disables GLX_SGI_swap_control\r
Linux OSS Sound: -sndbits <bits> chooses 8 bit or 16 bit sound output\r
Linux OSS Sound: -sndmono sets sound output to mono\r
Linux OSS Sound: -sndspeed <hz> chooses 44100 hz, 22100 hz, or 11025 hz sound output rate\r
Linux OSS Sound: -sndstereo sets sound output to stereo\r
Linux Sound: -cddev <devicepath> chooses which CD drive to use\r
MacOSX GLX: -nogetprocaddress disables GLX_ARB_get_proc_address (not required, more formal method of getting extension functions)\r
MacOSX GLX: -novideosync disables GLX_SGI_swap_control\r
SDL GL: -gl_driver <drivername> selects a GL driver library, default is libGL.so.1 (Linux/BSD) or opengl32.dll (windows) or OpenGL.framework (MacOSX), useful only for 3dfxogl.dll/3dfxvgl.dll or fxmesa or similar, if you don't know what this is for, you don't need it\r
SDL Sound: -sndspeed <hz> chooses 44100 hz, 22100 hz, or 11025 hz sound output rate\r
Server: -dedicated [playerlimit] starts a dedicated server (with a command console), default playerlimit is 8\r
Server: -ip <ipaddress> sets the ip address of this machine for purposes of networking (default 0.0.0.0 also known as INADDR_ANY), use only if you have multiple network adapters and need to choose one specifically.\r
Server: -listen [playerlimit] starts a multiplayer server with graphical client, like singleplayer but other players can connect, default playerlimit is 8\r
Server: -port <portnumber> sets the port to use for a server (default 26000, the same port as QUAKE itself), useful if you host multiple servers on your machine\r
Sound: -nocdaudio disables CD audio support\r
Sound: -nosound disables sound (including CD audio)\r
Sound: -novorbis disables ogg vorbis sound support\r
Sound: -simsound runs sound mixing but with no output\r
Video: -bpp <bits> performs +vid_bitsperpixel <bits> (example -bpp 32 or -bpp 16)\r
Video: -fullscreen performs +vid_fullscreen 1\r
Video: -height <pixels> performs +vid_height <pixels> and also +vid_width <pixels*4/3> if only -height is specified (example: -height 768 sets 1024x768 mode)\r
Video: -width <pixels> performs +vid_width <pixels> and also +vid_height <pixels*3/4> if only -width is specified (example: -width 1024 sets 1024x768 mode)\r
Video: -window performs +vid_fullscreen 0\r
Windows DirectSound: -primarysound locks the sound hardware for exclusive use\r
Windows DirectSound: -snoforceformat uses the format that DirectSound returns, rather than forcing it\r
Windows GDI Input: -noforcemaccel disables setting of mouse acceleration (not used with -dinput, windows only)\r
Windows GDI Input: -noforcemparms disables setting of mouse parameters (not used with -dinput, windows only)\r
Windows GDI Input: -noforcemspd disables setting of mouse speed (not used with -dinput, windows only)\r
Windows Input: -dinput enables DirectInput for mouse/joystick input\r
Windows Input: -nojoy disables joystick support, may be a small speed increase\r
Windows Sound: -sndspeed <hz> chooses 44100 hz, 22100 hz, or 11025 hz sound output rate\r
Windows Sound: -wavonly uses wave sound instead of DirectSound\r
Windows WGL: -gl_driver <drivername> selects a GL driver library, default is opengl32.dll, useful only for 3dfxogl.dll or 3dfxvgl.dll, if you don't know what this is for, you don't need it\r
Windows WGL: -novideosync disables WGL_EXT_swap_control\r
\r
How to install Quake on each operating system:\r
All that DarkPlaces needs from the Quake CD is pak files (be sure not to copy\r
opengl32.dll from the Quake CD, it will not work with DarkPlaces!), with this\r
in mind, all you need to do is make a Quake directory, extract the darkplaces\r
engine zip to that directory, then make a quake/id1 directory, and put the\r
pak0.pak and pak1.pak from your Quake CD into the quake/id1 directory, then\r
all should be well.\r
\r
How to deal with a DOS Quake CD on Windows:\r
Try to use the DOS Quake installer if you can, use DOSBox if necessary to run\r
the installer, then copy the pak0.pak and pak1.pak to your id1 directory in\r
the darkplaces installation.  ( http://dosbox.sourceforge.net )\r
\r
How to deal with a DOS Quake CD on Linux:\r
cat /media/cdrom/resource.001 /media/cdrom/resource.002 >quake.lha\r
unlha x quake.lha\r
If you can't get unlha or lha for your distribution, try using DOSBox to run\r
the Quake installer.\r
\r
How to deal with a DOS Quake CD on Mac OSX:\r
Unknown.  Linux solution may work if you can get hold of lha, otherwise use\r
DOSBox to run the Quake installer.\r
\r
How to deal with a WinQuake CD on Windows:\r
Copy the D:\Data\id1\pak0.pak and pak1.pak to your id1 directory.\r
\r
How to deal with a WinQuake CD on Linux:\r
Copy the /media/cdrom/data/id1/pak*.pak to your id1 directory.\r
\r
How to deal with a WinQuake CD on Mac OSX:\r
Find the data directory on the cdrom and copy the data/id1/pak*.pak files to\r
your id1 directory.\r
\r
How to deal with a Linux Quake CD on Windows:\r
Find an archiver (perhaps 7zip or winrar) that can extract files from rpm\r
archives, locate the pak files and copy them to your id1 directory.\r
\r
How to deal with a Linux Quake CD on Linux:\r
mkdir temp\r
cd temp\r
# in the following line replace quake.rpm with a correct rpm filename\r
cat /media/cdrom/quake.rpm | rpm2cpio | cpio -i\r
Now you should have a mess of subdirectories, locate the pak files and copy to\r
your id1 directory.\r
\r
How to deal with a Linux Quake CD on Mac OSX:\r
Unknown.  If you can get hold of rpm2cpio and cpio you should be able to\r
follow the Linux method.\r
\r
For more information on Quake installation on Linux see the Linux Quake Howto http://www.tldp.org/HOWTO/Quake-HOWTO.html\r
\r
\r