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