-DarkPlaces engine readme : updated 20060215\r
+DarkPlaces engine readme : updated 20060614\r
\r
About the DarkPlaces glquake engine:\r
DarkPlaces engine was started because I was unsatisfied with the other engines\r
feature list, with information on each feature, I hope it is still adequate\r
documentation.\r
\r
+If you have any suggestions for features to document in detail in the readme or any other questions/comments/bugreports/suggestions/etc, send me an email at lordhavoc@ghdigital.com\r
+\r
+\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
+\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
either set sv_public 1 in the console, or use the multiplayer new game menu\r
and check the Public server checkbox.\r
\r
+\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
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
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
+External texture support (see Replacement Content section below)\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
JPEG texture support using libjpeg (Thanks Elric)\r
PK3 archive support with compression support using zlib (Thanks Elric)\r
\r
+\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
+\r
+\r
Client features:\r
showtime cvar.\r
showdate cvar.\r
log_file cvar to log console messages to a file.\r
condump command to dump recent console history to a file.\r
\r
+\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
log_file cvar to log console messages to a file.\r
condump command to dump recent console history to a file.\r
\r
+\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
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
+\r
+\r
+Replacement Content:\r
+Formats supported: tga, png, jpg, pcx, lmp\r
+\r
+Usually you want to put replacement content in either id1/ or another directory such as pretty/ inside your quake directory, in DarkPlaces you can run multiple -game options at once (such as -game ctf -game pretty -game dpmod to have texture overrides from pretty, maps from ctf, and gameplay from dpmod) or multiple gamedirs specified with the gamedir console command (gamedir ctf pretty dpmod).\r
+\r
+All texture layers are optional except diffuse (the others are NOT loaded without it):\r
+skins:\r
+progs/player.mdl_0.tga - diffuse\r
+progs/player.mdl_0_norm.tga - normalmap (can have alpha channel with bumpmap height for offsetmapping/reliefmapping)\r
+progs/player.mdl_0_bump.tga - bumpmap (not loaded if normalmap is present)\r
+progs/player.mdl_0_glow.tga - glow map (use _luma if tenebrae compatibility is a concern)\r
+progs/player.mdl_0_luma.tga - alternate tenebrae-compatible name for glow map (use one or the other)\r
+progs/player.mdl_0_pants.tga - pants image, greyscale and does not cover the same pixels as the diffuse texture (this is additive blended ('Screen' mode in photoshop) ontop of the diffuse texture with a color tint according to your pants color)\r
+progs/player.mdl_0_shirt.tga - shirt image, same type as pants\r
+\r
+map-specific textures: (overrides textures for a specific map)\r
+textures/e1m1/ecop1_6.tga\r
+textures/e1m1/ecop1_6_norm.tga\r
+textures/e1m1/ecop1_6_bump.tga\r
+textures/e1m1/ecop1_6_glow.tga\r
+textures/e1m1/ecop1_6_luma.tga\r
+textures/e1m1/ecop1_6_pants.tga - pants and shirt layers are possible on bmodel entities with quakec modifications to set their .colormap field\r
+textures/e1m1/ecop1_6_shirt.tga\r
+\r
+map textures:\r
+textures/quake.tga\r
+textures/quake_norm.tga\r
+textures/quake_bump.tga\r
+textures/quake_glow.tga\r
+textures/quake_luma.tga\r
+textures/quake_pants.tga\r
+textures/quake_shirt.tga\r
+\r
+hud and menu pictures:\r
+gfx/conchars.tga\r
+\r
+Replacement models:\r
+same as in Quake, you can replace a model with exactly the same file name (including file extension), so for example an md3 player model has to be renamed progs/player.mdl, and a small box of shells in md3 format has to be renamed maps/b_shell0.bsp\r
+\r
+.skin files:\r
+These files use the same format as the ones in Quake3 (except being named <modelname>_0.skin, <modelname>_1.skin, and so on), they specify what texture to use on each part of the md3 (or zym or dpm or psk) model, their contents look like this:\r
+torso,progs/player_default.tga (says that the model part named "torso" should use the image progs/player_default.tga)\r
+gun,progs/player_default.tga (says that the model part named "gun" should use the image progs/player_default.tga)\r
+muzzleflash,progs/player_default_muzzleflash.tga (says that the model part named "muzzleflash" should use the image progs/player_default_muzzleflash.tga - this is useful for transparent skin areas which should be kept separate from opaque skins)\r
+tag_head, (says that the first tag is named "tag_head" - this is only useful for QuakeC mods using segmented player models so that they can look up/down without their legs rotating, don't worry about it as a user)\r
+tag_torso, (second tag name)\r
+tag_weapon, (third tag name)\r
+\r
+\r
+Example list of filenames:\r
+quake/id1/progs/player.mdl (replaces the player model)\r
+quake/id1/progs/player.mdl_0.skin (text file that specifies textures to use on an md3 model)\r
+quake/id1/progs/player_default.tga (texture referenced by the .skin, make sure that any special parts of this are black, like pants should be black here otherwise you get pink pants when you use a red color ingame)\r
+quake/id1/progs/player_default_pants.tga (white pants area of the skin, this is colored by the engine according to your color settings, additive blended (which is called "Screen" mode in Photoshop if you wish to preview the layers))\r
+quake/id1/progs/player_default_shirt.tga (white shirt area of the skin, similar to pants described above)\r
+quake/id1/progs/player_default_norm.tga (normalmap texture for player_default, alpha channel can contain a heightmap for offsetmapping (r_glsl_offsetmapping 1 in console) to use, alternatively you can use _bump.tga instead of this which is only a heightmap and the engine will generate the normalmap for you)\r
+quake/id1/progs/player_default_gloss.tga (glossmap (shiny areas) for player_default)\r
+quake/id1/progs/player_default_glow.tga (glowmap (glowing stuff) for player_default, this is fullbrights and such, be sure the corresponding pixels are black in the player_default.tga, because just like pants/shirt this is additive blended)\r
+quake/id1/textures/quake.tga (replaces the quake logo on the arch in start.bsp)\r
+quake/id1/textures/quake_norm.tga (same as for a player)\r
+quake/id1/textures/quake_gloss.tga (same as for a player)\r
+quake/id1/textures/#water1.tga (replaces *water1 texture in the maps, # is used instead of * in filenames)\r
+quake/id1/gfx/conchars.tga (replacement font image, this was in gfx.wad in quake)\r
+quake/id1/gfx/conback.tga (replacement console background, just like in quake)\r
+quake/id1/gfx/mainmenu.tga (replacement main menu image, just like in quake)\r
+quake/id1/maps/b_bh25.bsp (replacement for normal health pack, for example this could be an md3 model instead)\r
+\r
+\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
projects / xonotic / darkplaces.git / blobdiff