fix some warnings
[divverent/darkplaces.git] / darkplaces.txt
1 DarkPlaces engine readme : updated 20060215\r
2 \r
3 About the DarkPlaces glquake engine:\r
4 DarkPlaces engine was started because I was unsatisfied with the other engines\r
5 available soon after the quake source release (which did little more than add\r
6 some flashy effects), and craved modding features for my DarkPlaces mod, and\r
7 wanted some real enhancements to the online gaming experience as well.\r
8 \r
9 DarkPlaces engine is the result, I hope everyone likes it.\r
10 \r
11 See the end of this file for information on how to install Quake from CD on\r
12 Windows, Mac OSX, and Linux.\r
13 \r
14 I am not very good at writing documentation, so this readme is organized as a\r
15 feature list, with information on each feature, I hope it is still adequate\r
16 documentation.\r
17 \r
18 Input Tips:\r
19 If mouse movement is jerky but framerate is high, try typing "gl_finish 1"\r
20 (without quotes) into the console (makes cpu wait for gpu before ending frame,\r
21 which gives lousy input drivers a chance to catch up).\r
22 \r
23 Graphics Tips:\r
24 Visit the Color Control submenu of Options, it's near the top, fiddle with\r
25 gamma (or grey level if using the color levels mode) until the grey box\r
26 surrounding the white/black dither pattern matches up with the grey you see\r
27 while looking at the dither from a distance, this will calibrate quake to look\r
28 approximately as id Software intended, and ensure everyone sees it the same.\r
29 Note: Different resolutions may be different intensities depending on monitor.\r
30 Note2: ATI Radeon Catalyst 3.10 drivers seem to have a weird gamma limiting\r
31 'feature' which rejects gamma settings it doesn't like, feel free to complain\r
32 to ATI about this if it gets in your way (it probably will).\r
33 \r
34 Visit the Effects Options submenu of Options, and check out the options.\r
35 \r
36 Networking tips:\r
37 Visit the Player Setup submenu of the Multiplayer menu to configure your\r
38 network speed (as well as the usual settings from quake like name and colors).\r
39 \r
40 To host a server behind a router/firewall, simply set up a port forward on the\r
41 UDP port you are running the server on (default is 26000), to forward incoming\r
42 UDP packets on that port to the server, then people can connect.\r
43 \r
44 To make your server show up on the server browser (in the Join Game menu),\r
45 either set sv_public 1 in the console, or use the multiplayer new game menu\r
46 and check the Public server checkbox.\r
47 \r
48 Thanks to:\r
49 Tomaz for adding features, fixing many bugs, and being generally helpful.\r
50 Andreas 'Black' Kirsch for much work on the QuakeC VM (menu.dat, someday clprogs.dat) and other contributions.\r
51 Mathieu 'Elric' Olivier for much work on the sound engine (especially the Ogg vorbis support)\r
52 MoALTz for some bugfixes and cleanups\r
53 Joseph Caporale for adding 5 mouse button support.\r
54 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
55 Zombie for making great levels and general DarkPlaces publicity.\r
56 FrikaC for FrikQCC and FrikBot and general community support.\r
57 Transfusion Project for recreating Blood in the world of Quake.\r
58 de-we for the great icons.\r
59 |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
60 VorteX for the DP_QC_GETTAGINFO extension.\r
61 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
62 \r
63 Questions/comments/bugreports/suggestions?\r
64 Send email to lordhavoc@ghdigital.com.\r
65 \r
66 \r
67 \r
68 Supported games:\r
69 Quake : -quake, this is active by default, gamedirs: id1\r
70 Quake: Scourge of Armagon : -hipnotic or hipnotic in executable name or path, gamedirs: hipnotic, id1\r
71 Quake: Dissolution of Eternity : -rogue or rogue in executable name or path, gamedirs: rogue, id1\r
72 Nehahra : -nehahra or nehahra in executable name or path, gamedirs: nehahra, id1\r
73 GoodVsBad2 : -goodvsbad2 or gvb2 in executable name or path, gamedirs: rts\r
74 BattleMech : -battlemech or battlemech in executable name or path, gamedirs: base\r
75 PrydonGate : -prydon or prydon in executable name or path, gamedirs: prydon\r
76 These games are considered officially supported, if any problems are seen,\r
77 please make sure you are running the latest version of the game and engine,\r
78 if you are, please report the problem.\r
79 \r
80 \r
81 \r
82 Future supported games:\r
83 Nexuiz : -nexuiz or nexuiz in executable name or path, gamedirs: data\r
84 Zymotic : -zymotic or zymotic in executable name or path, gamedirs: data\r
85 Fniggium : -fniggium or fniggium in executable name or path, gamedirs: data\r
86 Setheral : -setheral or setheral in executable name or path, gamedirs: data\r
87 SonOfMan : -som or som in executable name or path, gamedirs: data\r
88 These have incomplete support and will likely change before their release.\r
89 \r
90 \r
91 \r
92 Graphics features:\r
93 Redesigned effects including smoke, blood, bubbles and explosions.\r
94 Better looking dynamic lights.\r
95 External texture support (see dpextensions.qc DP_GFX_EXTERNALTEXTURES)\r
96 Realtime bumpmapped lighting/shadowing support (see r_shadow_help in game)\r
97 .rtlights file support (improves performance/appearance of realtime lighting)\r
98 .rtlights file editing (see r_editlights_help in game)\r
99 Alpha blended sprites (instead of glquake's masked sprites).\r
100 Interpolated entity movement and animations (both models and sprites).\r
101 Overbright and fullbright support on walls and models (like winquake).\r
102 Colormapping support on any q1 model (like winquake).\r
103 Fog (set with "fog density red green blue" command)\r
104 Skybox (loadsky "mtnsun_" will load "env/mtnsun_ft.tga" and so on).\r
105 Sky rendering improved (no more glquake distortion).\r
106 Sky polygons obscure geometry just like in winquake.\r
107 Color calibration menu to ensure a proper Quake experience.\r
108 Improved model lighting (directional shading).\r
109 No messy .ms2 model mesh files (no glquake dir anymore either).\r
110 New improved crosshair (team color coded).\r
111 Improved image loading (smoother menus and such).\r
112 Ability to disable particle effects (cl_particles* cvars).\r
113 Decals (cl_decals cvar to enable).\r
114 Stainmaps (cl_stainmap cvar to enable).\r
115 Sorted transparent stuff to render better.\r
116 Improved multitexture support (r_textureunits (1-4 supported), needs gl_combine 1 because of overbright)\r
117 Improved chase cam (chase_active 1 no longer goes into walls)\r
118 More configurable console background (scr_conalpha and scr_conbrightness)\r
119 Optional fullbrights (r_fullbrights 0/1 followed by r_restart)\r
120 Dynamic Farclip (no distance limits in huge maps)\r
121 Improved gl_flashblend (now renders a corona instead of an ugly blob)\r
122 DynamicLight coronas (more realism)\r
123 Transparent statusbar (sbar_alpha) that does not block your view as much.\r
124 No 8bit texture uploads (fixes 'green' walls in the distance).\r
125 Fixed view blends (glquake was quite broken).\r
126 JPEG texture support using libjpeg (Thanks Elric)\r
127 PK3 archive support with compression support using zlib (Thanks Elric)\r
128 \r
129 Sound features:\r
130 Ogg and wav file overrides for cd tracks (example: sound/cdtracks/track01.ogg or .wav) (Thanks Elric)\r
131 Streaming ogg sounds to save memory (Ogg sounds over a certain size are streamed automatically) (Thanks Elric)\r
132 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
133 Stereo wav support (useful for music as ambientsound() calls)\r
134 \r
135 Client features:\r
136 showtime cvar.\r
137 showdate cvar.\r
138 -benchmark option to run automated timedemo benchmarks (-benchmark demo1 does +timedemo demo1 and quits immediately when finished)\r
139 automatic timedemo logging to gamedir/benchmark.log\r
140 Slightly improved aiming on quake servers (does not support proquake aiming).\r
141 -sndspeed samplerate (default: 44100, quake used 11025)\r
142 snd_swapstereo cvar (for people with backwards SB16 sound cards)\r
143 Saves video settings to config and restores them properly\r
144 Ability to change video settings during game (video options menu or vid_* cvars)\r
145 showfps cvar.\r
146 Video Options, Color Control, and Effects Options menus added, and more options.\r
147 Sends 20fps network packets to improve modem play instead of one per frame. (sys_ticrate controls network framerate)\r
148 Allow skin colormaps 14 and 15 (freaky :)\r
149 Longer chat messages.\r
150 No more 72fps limit, host_maxfps lets you decide.\r
151 Support for more mouse buttons (mouse1-mouse16, mwheelup/mwheeldown are aliases to mouse4 and mouse5).\r
152 Server browser for public (sv_public 1) darkplaces servers.\r
153 log_file cvar to log console messages to a file.\r
154 condump command to dump recent console history to a file.\r
155 \r
156 Server features: (Note server only supports darkplaces clients)\r
157 Allows clients to connect through firewalls (automatic feature)\r
158 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
159 More accurate movement and precise aiming.\r
160 64 player support.\r
161 sv_cheats cvar controls cheats (no longer based on deathmatch).\r
162 slowmo cvar controls game speed.\r
163 No crash with the buggy 'teleport train' in shub's pit.\r
164 Allow skin colormaps 14 and 15 (freaky :)\r
165 sys_ticrate applies to listen (client) servers as well as dedicated.\r
166 sv_public cvar to advertise to master server.\r
167 log_file cvar to log console messages to a file.\r
168 condump command to dump recent console history to a file.\r
169 \r
170 Modding features:\r
171 HalfLife map support (place your HalfLife wads in quake/id1/textures/ or quake/MODDIR/textures/ as the maps need them)\r
172 Larger q1 and hl map size of +-32768 units.\r
173 Colored lighting (.lit support) for q1 maps.\r
174 Q3 map support (no shaders though), with no limits.\r
175 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
176 Optimized QuakeC interpreter so mods run faster.\r
177 Bounds checking QuakeC interpreter so mods can't do naughty things with memory.\r
178 Warnings for many common QuakeC errors.\r
179 Unprecached models are now a warning (does not kill the server anymore).\r
180 External texture support (see dpextensions.qc DP_GFX_EXTERNALTEXTURES).\r
181 Fog ("fog" key in worldspawn, same parameters as fog command).\r
182 .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
183 Skybox ("sky" key in worldspawn, works like loadsky and quake2).\r
184 Stereo wav sounds supported.\r
185 Ogg Vorbis sounds supported. (Thanks Elric)\r
186 ATTN_NONE sounds are no longer directional (good for music).\r
187 play2 sound testing command (ATTN_NONE variant of play).\r
188 r_texturestats and memstats and memlist commands to give memory use info.\r
189 Lighting on sprites (put ! anywhere in sprite filename to enable).\r
190 More r_speeds info (now a transparent overlay instead of spewing to console).\r
191 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
192 More sound channels.\r
193 More dynamic lights (32 changed to 256).\r
194 More precached models and sounds (256 changed to 4096).\r
195 Many more features documented in dpextensions.qc. (bullet tracing on models, qc player input, etc)\r
196 \r
197 Commandline options as of 2004-10-05:\r
198 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
199 BSD GLX: -nogetprocaddress disables GLX_ARB_get_proc_address (not required, more formal method of getting extension functions)\r
200 BSD GLX: -novideosync disables GLX_SGI_swap_control\r
201 BSD Sound: -cddev <devicepath> chooses which CD drive to use\r
202 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
203 Client: -forceqmenu disables menu.dat (same as +forceqmenu 1)\r
204 Client: -particles <number> changes maximum number of particles at once, default 32768\r
205 Client: -texbrightness <number> sets the quake palette brightness (brightness of black), allowing you to make quake textures brighter/darker, not recommended\r
206 Client: -texcontrast <number> sets the quake palette contrast, allowing you to make quake textures brighter/darker, not recommended\r
207 Client: -texgamma <number> sets the quake palette gamma, allowing you to make quake textures brighter/darker, not recommended\r
208 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
209 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
210 Console: -developer enables warnings and other notices (RECOMMENDED for mod developers)\r
211 Console: -nostdout disables text output to the terminal the game was launched from\r
212 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
213 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
214 GL: -noanisotropy disables GL_EXT_texture_filter_anisotropic (allows higher quality texturing)\r
215 GL: -nocombine disables GL_ARB_texture_env_combine or GL_EXT_texture_env_combine (required for bumpmapping and faster map rendering)\r
216 GL: -nocubemap disables GL_ARB_texture_cube_map (required for bumpmapping)\r
217 GL: -nocva disables GL_EXT_compiled_vertex_array (renders faster)\r
218 GL: -nodot3 disables GL_ARB_texture_env_dot3 (required for bumpmapping)\r
219 GL: -nodrawrangeelements disables GL_EXT_draw_range_elements (renders faster)\r
220 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
221 GL: -nofragmentshader disables GL_ARB_fragment_shader (currently unused, allows pixel shader effects)\r
222 GL: -nomtex disables GL_ARB_multitexture (required for faster map rendering)\r
223 GL: -noshaderobjects disables GL_ARB_shader_objects (required for vertex shader and fragment shader)\r
224 GL: -noshadinglanguage100 disables GL_ARB_shading_language_100 (required for vertex shader and fragment shader)\r
225 GL: -nostenciltwoside disables GL_EXT_stencil_two_side (accelerates shadow rendering)\r
226 GL: -notexture3d disables GL_EXT_texture3D (required for spherical lights, otherwise they render as a column)\r
227 GL: -notextureshader disables GL_NV_texture_shader (required for the Geforce3 water shader, NVIDIA only)\r
228 GL: -novertexshader disables GL_ARB_vertex_shader (currently unused, allows vertex shader effects)\r
229 Game: -battlemech runs the multiplayer topdown deathmatch game BattleMech\r
230 Game: -fniggium runs the post apocalyptic melee RPG Fniggium\r
231 Game: -goodvsbad2 runs the psychadelic RTS FPS game Good Vs Bad 2\r
232 Game: -hipnotic runs Quake mission pack 1: The Scourge of Armagon\r
233 Game: -nehahra runs The Seal of Nehahra movie and game\r
234 Game: -neoteric runs the game Neoteric\r
235 Game: -netherworld runs the game Netherworld: Dark Masters\r
236 Game: -nexuiz runs the multiplayer game Nexuiz\r
237 Game: -openquartz runs the game OpenQuartz, a standalone GPL replacement of the quake content\r
238 Game: -prydon runs the topdown point and click action-RPG Prydon Gate\r
239 Game: -quake runs the game Quake (default)\r
240 Game: -rogue runs Quake mission pack 2: The Dissolution of Eternity\r
241 Game: -setheral runs the multiplayer game Setheral\r
242 Game: -som runs the multiplayer game Son Of Man\r
243 Game: -tenebrae runs the graphics test mod known as Tenebrae (some features not implemented)\r
244 Game: -teu runs The Evil Unleashed (this option is obsolete as they are not using darkplaces)\r
245 Game: -transfusion runs Transfusion (the recreation of Blood in Quake)\r
246 Game: -zymotic runs the singleplayer game Zymotic\r
247 Input: -nomouse disables mouse support (see also vid_mouse cvar)\r
248 Linux ALSA Sound: -sndbits <number> sets sound precision to 8 or 16 bit (email me if you want others added)\r
249 Linux ALSA Sound: -sndmono sets sound output to mono\r
250 Linux ALSA Sound: -sndpcm <devicename> selects which pcm device to us, default is "default"\r
251 Linux ALSA Sound: -sndspeed <hz> chooses 44100 hz, 22100 hz, or 11025 hz sound output rate\r
252 Linux ALSA Sound: -sndstereo sets sound output to stereo\r
253 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
254 Linux GLX: -nogetprocaddress disables GLX_ARB_get_proc_address (not required, more formal method of getting extension functions)\r
255 Linux GLX: -novideosync disables GLX_SGI_swap_control\r
256 Linux OSS Sound: -sndbits <bits> chooses 8 bit or 16 bit sound output\r
257 Linux OSS Sound: -sndmono sets sound output to mono\r
258 Linux OSS Sound: -sndspeed <hz> chooses 44100 hz, 22100 hz, or 11025 hz sound output rate\r
259 Linux OSS Sound: -sndstereo sets sound output to stereo\r
260 Linux Sound: -cddev <devicepath> chooses which CD drive to use\r
261 MacOSX GLX: -nogetprocaddress disables GLX_ARB_get_proc_address (not required, more formal method of getting extension functions)\r
262 MacOSX GLX: -novideosync disables GLX_SGI_swap_control\r
263 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
264 SDL Sound: -sndspeed <hz> chooses 44100 hz, 22100 hz, or 11025 hz sound output rate\r
265 Server: -dedicated [playerlimit] starts a dedicated server (with a command console), default playerlimit is 8\r
266 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
267 Server: -listen [playerlimit] starts a multiplayer server with graphical client, like singleplayer but other players can connect, default playerlimit is 8\r
268 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
269 Sound: -nocdaudio disables CD audio support\r
270 Sound: -nosound disables sound (including CD audio)\r
271 Sound: -novorbis disables ogg vorbis sound support\r
272 Sound: -simsound runs sound mixing but with no output\r
273 Video: -bpp <bits> performs +vid_bitsperpixel <bits> (example -bpp 32 or -bpp 16)\r
274 Video: -fullscreen performs +vid_fullscreen 1\r
275 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
276 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
277 Video: -window performs +vid_fullscreen 0\r
278 Windows DirectSound: -primarysound locks the sound hardware for exclusive use\r
279 Windows DirectSound: -snoforceformat uses the format that DirectSound returns, rather than forcing it\r
280 Windows GDI Input: -noforcemaccel disables setting of mouse acceleration (not used with -dinput, windows only)\r
281 Windows GDI Input: -noforcemparms disables setting of mouse parameters (not used with -dinput, windows only)\r
282 Windows GDI Input: -noforcemspd disables setting of mouse speed (not used with -dinput, windows only)\r
283 Windows Input: -dinput enables DirectInput for mouse/joystick input\r
284 Windows Input: -nojoy disables joystick support, may be a small speed increase\r
285 Windows Sound: -sndspeed <hz> chooses 44100 hz, 22100 hz, or 11025 hz sound output rate\r
286 Windows Sound: -wavonly uses wave sound instead of DirectSound\r
287 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
288 Windows WGL: -novideosync disables WGL_EXT_swap_control\r
289 \r
290 How to install Quake on each operating system:\r
291 All that DarkPlaces needs from the Quake CD is pak files (be sure not to copy\r
292 opengl32.dll from the Quake CD, it will not work with DarkPlaces!), with this\r
293 in mind, all you need to do is make a Quake directory, extract the darkplaces\r
294 engine zip to that directory, then make a quake/id1 directory, and put the\r
295 pak0.pak and pak1.pak from your Quake CD into the quake/id1 directory, then\r
296 all should be well.\r
297 \r
298 How to deal with a DOS Quake CD on Windows:\r
299 Try to use the DOS Quake installer if you can, use DOSBox if necessary to run\r
300 the installer, then copy the pak0.pak and pak1.pak to your id1 directory in\r
301 the darkplaces installation.  ( http://dosbox.sourceforge.net )\r
302 \r
303 How to deal with a DOS Quake CD on Linux:\r
304 cat /media/cdrom/resource.001 /media/cdrom/resource.002 >quake.lha\r
305 unlha x quake.lha\r
306 If you can't get unlha or lha for your distribution, try using DOSBox to run\r
307 the Quake installer.\r
308 \r
309 How to deal with a DOS Quake CD on Mac OSX:\r
310 Unknown.  Linux solution may work if you can get hold of lha, otherwise use\r
311 DOSBox to run the Quake installer.\r
312 \r
313 How to deal with a WinQuake CD on Windows:\r
314 Copy the D:\Data\id1\pak0.pak and pak1.pak to your id1 directory.\r
315 \r
316 How to deal with a WinQuake CD on Linux:\r
317 Copy the /media/cdrom/data/id1/pak*.pak to your id1 directory.\r
318 \r
319 How to deal with a WinQuake CD on Mac OSX:\r
320 Find the data directory on the cdrom and copy the data/id1/pak*.pak files to\r
321 your id1 directory.\r
322 \r
323 How to deal with a Linux Quake CD on Windows:\r
324 Find an archiver (perhaps 7zip or winrar) that can extract files from rpm\r
325 archives, locate the pak files and copy them to your id1 directory.\r
326 \r
327 How to deal with a Linux Quake CD on Linux:\r
328 mkdir temp\r
329 cd temp\r
330 # in the following line replace quake.rpm with a correct rpm filename\r
331 cat /media/cdrom/quake.rpm | rpm2cpio | cpio -i\r
332 Now you should have a mess of subdirectories, locate the pak files and copy to\r
333 your id1 directory.\r
334 \r
335 How to deal with a Linux Quake CD on Mac OSX:\r
336 Unknown.  If you can get hold of rpm2cpio and cpio you should be able to\r
337 follow the Linux method.\r
338 \r
339 For more information on Quake installation on Linux see the Linux Quake Howto http://www.tldp.org/HOWTO/Quake-HOWTO.html\r
340 \r
341 \r