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