added a tip about using the color control menu to calibrate for proper quake viewing
[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 Tip:\r
16 Visit the Color Control submenu of Options, it's near the top, fiddle with\r
17 gamma (or grey level if using the color levels mode) until the grey box\r
18 surrounding the white/black dither pattern matches up with the grey you see\r
19 while looking at the dither from a distance, this will calibrate quake to look\r
20 approximately as id Software intended, and ensure everyone sees it the same.\r
21 Note: Different resolutions may be different intensities depending on monitor.\r
22 Note2: ATI Radeon Catalyst 3.10 drivers seem to have a weird gamma limiting\r
23 'feature' which rejects gamma settings it doesn't like, feel free to complain\r
24 to ATI about this if it gets in your way (it probably will). \r
25 \r
26 Questions/comments/bugreports/suggestions?\r
27 Send email to havoc@telefragged.com.\r
28 \r
29 \r
30 \r
31 Supported games:\r
32 Quake : -quake, this is active by default, gamedirs: id1\r
33 Quake: Scourge of Armagon : -hipnotic or hipnotic in executable name or path, gamedirs: hipnotic, id1\r
34 Quake: Dissolution of Eternity : -rogue or rogue in executable name or path, gamedirs: rogue, id1\r
35 Nehahra : -nehahra or nehahra in executable name or path, gamedirs: nehahra, id1\r
36 GoodVsBad2 : -goodvsbad2 or gvb2 in executable name or path, gamedirs: rts\r
37 BattleMech : -battlemech or battlemech in executable name or path, gamedirs: base\r
38 These games are considered officially supported, if any problems are seen,\r
39 please make sure you are running the latest version of the game and engine,\r
40 if you are, please report the problem.\r
41 \r
42 \r
43 \r
44 Future supported games:\r
45 Nexuiz : -nexuiz or nexuiz in executable name or path, gamedirs: data\r
46 Zymotic : -zymotic or zymotic in executable name or path, gamedirs: data\r
47 Fniggium : -fniggium or fniggium in executable name or path, gamedirs: data\r
48 Setheral : -setheral or setheral in executable name or path, gamedirs: data\r
49 SonOfMan : -som or som in executable name or path, gamedirs: data\r
50 These have incomplete support and will likely change before their release.\r
51 \r
52 \r
53 \r
54 Graphics features:\r
55 Redesigned effects including smoke, blood, bubbles and explosions.\r
56 Better looking dynamic lights.\r
57 External texture support (see dpextensions.qc DP_GFX_EXTERNALTEXTURES)\r
58 Realtime bumpmapped lighting/shadowing support (see r_shadow_help in game)\r
59 .rtlights file support (improves performance/appearance of realtime lighting)\r
60 .rtlights file editing (see r_editlights_help in game)\r
61 Alpha blended sprites (instead of glquake's masked sprites).\r
62 Interpolated entity movement and animations (both models and sprites).\r
63 Overbright and fullbright support on walls and models (like winquake).\r
64 Colormapping support on any q1 model (like winquake).\r
65 Fog (set with "fog density red green blue" command)\r
66 Skybox (loadsky "mtnsun_" will load "env/mtnsun_ft.tga" and so on).\r
67 Sky rendering improved (no more glquake distortion).\r
68 Sky polygons obscure geometry just like in winquake.\r
69 Color calibration menu to ensure a proper Quake experience.\r
70 Improved model lighting (directional shading).\r
71 No messy .ms2 model mesh files (no glquake dir anymore either).\r
72 New improved crosshair (team color coded).\r
73 Improved image loading (smoother menus and such).\r
74 Ability to disable particle effects (cl_particles* cvars).\r
75 Decals (cl_decals cvar to enable).\r
76 Stainmaps (cl_stainmap cvar to enable).\r
77 Sorted transparent stuff to render better.\r
78 Improved multitexture support (r_textureunits (1-4 supported), needs gl_combine 1 because of overbright)\r
79 Improved chase cam (chase_active 1 no longer goes into walls)\r
80 More configurable console background (scr_conalpha and scr_conbrightness)\r
81 Optional fullbrights (r_fullbrights 0/1 followed by r_restart)\r
82 Dynamic Farclip (no distance limits in huge maps)\r
83 Improved gl_flashblend (now renders a corona instead of an ugly blob)\r
84 DynamicLight coronas (more realism)\r
85 Transparent statusbar (sbar_alpha) that does not block your view as much.\r
86 No 8bit texture uploads (fixes 'green' walls in the distance).\r
87 Fixed view blends (glquake was quite broken).\r
88 \r
89 Client features:\r
90 showtime cvar.\r
91 showdate cvar.\r
92 -benchmark option to run automated timedemo benchmarks (-benchmark demo1 does +timedemo demo1 and quits immediately when finished)\r
93 automatic timedemo logging to gamedir/benchmark.log\r
94 Slightly improved aiming on quake servers (does not support proquake aiming).\r
95 -sndspeed samplerate (default: 44100, quake used 11025)\r
96 snd_swapstereo cvar (for people with backwards SB16 sound cards)\r
97 Saves video settings to config and restores them properly\r
98 Ability to change video settings during game (video options menu or vid_* cvars)\r
99 showfps cvar.\r
100 Video Options, Color Control, and Effects Options menus added, and more options.\r
101 Sends 20fps network packets to improve modem play instead of one per frame. (sys_ticrate controls network framerate)\r
102 Allow skin colormaps 14 and 15 (freaky :)\r
103 Longer chat messages.\r
104 No more 72fps limit, host_maxfps lets you decide.\r
105 Support for more mouse buttons (mouse1-mouse16, mwheelup/mwheeldown are aliases to mouse4 and mouse5).\r
106 Server browser for public (sv_public 1) darkplaces servers. \r
107 \r
108 Server features: (Note server only supports darkplaces clients)\r
109 More accurate movement and precise aiming.\r
110 64 player support.\r
111 sv_cheats cvar controls cheats (no longer based on deathmatch).\r
112 slowmo cvar controls game speed.\r
113 No crash with the buggy 'teleport train' in shub's pit.\r
114 Allow skin colormaps 14 and 15 (freaky :)\r
115 sys_ticrate applies to listen (client) servers as well as dedicated.\r
116 sv_public cvar to advertise to master server.\r
117 \r
118 Modding features:\r
119 HalfLife map support (place your HalfLife wads in quake/id1/textures/ or quake/MODDIR/textures/ as the maps need them)\r
120 Larger q1 and hl map size of +-32768 units.\r
121 Colored lighting (.lit support) for q1 maps.\r
122 Q3 map support (no shaders though), with no limits.\r
123 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
124 Optimized QuakeC interpreter so mods run faster.\r
125 Bounds checking QuakeC interpreter so mods can't do naughty things with memory.\r
126 Warnings for many common QuakeC errors.\r
127 Unprecached models are now a warning (does not kill the server anymore).\r
128 External texture support (see dpextensions.qc DP_GFX_EXTERNALTEXTURES).\r
129 Fog ("fog" key in worldspawn, same parameters as fog command).\r
130 .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
131 Skybox ("sky" key in worldspawn, works like loadsky and quake2).\r
132 Stereo wav sounds supported (note music easily uses over 50mb of memory!).\r
133 Ogg Vorbis sounds supported (note music easily uses over 50mb of memory!).\r
134 ATTN_NONE sounds are no longer directional (good for music).\r
135 play2 sound testing command (ATTN_NONE variant of play).\r
136 r_texturestats and memstats and memlist commands to give memory use info.\r
137 Lighting on sprites (put ! anywhere in sprite filename to enable).\r
138 More r_speeds info (now a transparent overlay instead of spewing to console).\r
139 Supports rotating bmodels (use avelocity, and keep in mind the bmodel needs the "origin" key set to rotate, or in q3 maps an origin brush works).\r
140 More sound channels.\r
141 More dynamic lights (32 changed to 256).\r
142 More precached models and sounds (256 changed to 4096).\r
143 Many more features documented in dpextensions.qc. (bullet tracing on models, qc player input, etc)\r
144 \r
145 \r