-DarkPlaces engine readme : updated 20040206\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
\r
DarkPlaces engine is the result, I hope everyone likes it.\r
\r
+See the end of this file for information on how to install Quake from CD on\r
+Windows, Mac OSX, and Linux.\r
+\r
I am not very good at writing documentation, so this readme is organized as a\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
Longer chat messages.\r
No more 72fps limit, host_maxfps lets you decide.\r
Support for more mouse buttons (mouse1-mouse16, mwheelup/mwheeldown are aliases to mouse4 and mouse5).\r
-Server browser for public (sv_public 1) darkplaces servers. \r
+Server browser for public (sv_public 1) darkplaces servers.\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
Allow skin colormaps 14 and 15 (freaky :)\r
sys_ticrate applies to listen (client) servers as well as dedicated.\r
sv_public cvar to advertise to master server.\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
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
+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
+\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
GL: -notexture3d disables GL_EXT_texture3D (required for spherical lights, otherwise they render as a column)\r
GL: -notextureshader disables GL_NV_texture_shader (required for the Geforce3 water shader, NVIDIA only)\r
GL: -novertexshader disables GL_ARB_vertex_shader (currently unused, allows vertex shader effects)\r
-Game: -battlemech runs the multiplayer topdown deathmatch game BattleMech \r
-Game: -fniggium runs the post apocalyptic melee RPG Fniggium \r
+Game: -battlemech runs the multiplayer topdown deathmatch game BattleMech\r
+Game: -fniggium runs the post apocalyptic melee RPG Fniggium\r
Game: -goodvsbad2 runs the psychadelic RTS FPS game Good Vs Bad 2\r
Game: -hipnotic runs Quake mission pack 1: The Scourge of Armagon\r
Game: -nehahra runs The Seal of Nehahra movie and game\r
Game: -prydon runs the topdown point and click action-RPG Prydon Gate\r
Game: -quake runs the game Quake (default)\r
Game: -rogue runs Quake mission pack 2: The Dissolution of Eternity\r
-Game: -setheral runs the multiplayer game Setheral \r
-Game: -som runs the multiplayer game Son Of Man \r
+Game: -setheral runs the multiplayer game Setheral\r
+Game: -som runs the multiplayer game Son Of Man\r
Game: -tenebrae runs the graphics test mod known as Tenebrae (some features not implemented)\r
Game: -teu runs The Evil Unleashed (this option is obsolete as they are not using darkplaces)\r
Game: -transfusion runs Transfusion (the recreation of Blood in Quake)\r
Windows Sound: -wavonly uses wave sound instead of DirectSound\r
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
Windows WGL: -novideosync disables WGL_EXT_swap_control\r
+\r
+How to install Quake on each operating system:\r
+All that DarkPlaces needs from the Quake CD is pak files (be sure not to copy\r
+opengl32.dll from the Quake CD, it will not work with DarkPlaces!), with this\r
+in mind, all you need to do is make a Quake directory, extract the darkplaces\r
+engine zip to that directory, then make a quake/id1 directory, and put the\r
+pak0.pak and pak1.pak from your Quake CD into the quake/id1 directory, then\r
+all should be well.\r
+\r
+How to deal with a DOS Quake CD on Windows:\r
+Try to use the DOS Quake installer if you can, use DOSBox if necessary to run\r
+the installer, then copy the pak0.pak and pak1.pak to your id1 directory in\r
+the darkplaces installation. ( http://dosbox.sourceforge.net )\r
+\r
+How to deal with a DOS Quake CD on Linux:\r
+cat /media/cdrom/resource.001 /media/cdrom/resource.002 >quake.lha\r
+unlha x quake.lha\r
+If you can't get unlha or lha for your distribution, try using DOSBox to run\r
+the Quake installer.\r
+\r
+How to deal with a DOS Quake CD on Mac OSX:\r
+Unknown. Linux solution may work if you can get hold of lha, otherwise use\r
+DOSBox to run the Quake installer.\r
+\r
+How to deal with a WinQuake CD on Windows:\r
+Copy the D:\Data\id1\pak0.pak and pak1.pak to your id1 directory.\r
+\r
+How to deal with a WinQuake CD on Linux:\r
+Copy the /media/cdrom/data/id1/pak*.pak to your id1 directory.\r
+\r
+How to deal with a WinQuake CD on Mac OSX:\r
+Find the data directory on the cdrom and copy the data/id1/pak*.pak files to\r
+your id1 directory.\r
+\r
+How to deal with a Linux Quake CD on Windows:\r
+Find an archiver (perhaps 7zip or winrar) that can extract files from rpm\r
+archives, locate the pak files and copy them to your id1 directory.\r
+\r
+How to deal with a Linux Quake CD on Linux:\r
+mkdir temp\r
+cd temp\r
+# in the following line replace quake.rpm with a correct rpm filename\r
+cat /media/cdrom/quake.rpm | rpm2cpio | cpio -i\r
+Now you should have a mess of subdirectories, locate the pak files and copy to\r
+your id1 directory.\r
+\r
+How to deal with a Linux Quake CD on Mac OSX:\r
+Unknown. If you can get hold of rpm2cpio and cpio you should be able to\r
+follow the Linux method.\r
+\r
+For more information on Quake installation on Linux see the Linux Quake Howto http://www.tldp.org/HOWTO/Quake-HOWTO.html\r
+\r
+\r
projects / xonotic / darkplaces.git / blobdiff