From e68012962993b2542c0b0dc18d0f5a2b01050817 Mon Sep 17 00:00:00 2001 From: floam Date: Fri, 17 Mar 2006 00:20:03 +0000 Subject: Some stuff from readme and random small changes. git-svn-id: svn://svn.icculus.org/quake3/trunk@648 edf5b092-35ff-0310-97b2-ce42778d08ea --- web/include/help.php | 173 ++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 172 insertions(+), 1 deletion(-) (limited to 'web/include/help.php') diff --git a/web/include/help.php b/web/include/help.php index 9c23193..7aa6417 100644 --- a/web/include/help.php +++ b/web/include/help.php @@ -13,6 +13,177 @@ Make sure that you check documentation, and read the Linux Gamers' FAQ before asking for help! Most questions people have are not unique!

+

New Cvars & Commands

+

Icculus.org/quake3 has introduced a number of new cvars and commands, mostly +because of new features.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Cvar Additions
CvarTypeDescription
cl_autoRecordDemo BooleanRecord a new demo on each map change.
cl_aviFrameRate IntegerThe framerate to use when capturing video.
cl_aviMotionJpeg BooleanUse the mjpeg codec when capturing video.
s_useOpenAL BooleanUse the OpenAL sound backend if it's available.
s_alPrecache BooleanCache OpenAL sounds before use.
s_alGain FloatThe value of AL_GAIN for each source.
s_alSources IntegerThe total number of sources (memory) to allocate.
s_alDopplerFactor FloatThe value passed to alDopplerFactor().
s_alDopplerSpeed FloatThe value passed to alDopplerVelocity().
s_alMinDistance FloatThe value of AL_REFERENCE_DISTANCE for each source.
s_alRolloff FloatThe value of AL_ROLLOFF_FACTOR for each source.
s_alMaxSpeakerDistance FloatET_SPEAKERS beyond this distance are culled.
s_alDriver StringWhich OpenAL library to use.
s_sdlBits IntegerSDL bit resolution.
s_sdlSpeed IntegerSDL sample rate.
s_sdlChannels IntegerSDL number of channels.
s_sdlDevSamps IntegerSDL DMA buffer size override.
s_sdlMixSamps IntegerSDL mix buffer size override.
ttycon_ansicolor BooleanEnable the addition of ANSI escape codes for colors in the tty.
r_GLlibCoolDownMsec IntegerWait for a number of milliseconds to close GL library.
com_altivec BooleanEnable the use of Altivec on PowerPC systems.
s_backend RO StringIndicates the current sound backend.
cl_consoleHistory RO StringStores the console history.
cl_platformSensitivity RO FloatIndicates the mouse input scaling.
+ + + + + + + + + + + + + + +
New Commands
CommandDescription
video <filename>Start video capture (use with demo command). Outputs to + filename.
stopvidepStop the video capture.
+ +

Using shared libraries instead of QVMs

+

To force Q3 to use shared libraries instead of +QVMs run it with the following parameters: +
+set sv_pure 0 +set vm_cgame 0 +set vm_game 0 +set vm_ui 0

+ +

Using Demo Data Files

+

Copy demoq3/pak0.pk3 from the demo installer to your baseq3 +directory. The QVM files in this +pak0.pk3 will not work, so you have to use the native +shared libraries or QVMs from +this project. To use the new QVMs, +they must be put into a .pk3 file. A pk3 file is just a zip file, +so any compression tool that can create such files will work. The shared libraries +should already be in the correct place.

+

Please bear in mind that you will not be able to play online using the demo data, +nor is it something that we like to spend much time maintaining or supporting.

+ +

64-bit Mods

+

If you wish to compile external mods as shared libraries on a 64bit platform, +and the mod source is derived from the id Q3 SDK, you will need to modify the +interface code a little. Open the files ending in _syscalls.c and change +every instance of int to intptr_t in the declaration of the syscall +function pointer and the dllEntry function. Also find the vmMain function +for each module (usually in cg_main.c, g_main.c, etc.) and similarly +replace the return value in the prototype with intptr_t (arg0, arg1, ...stay int). +

+Add the following code snippet to q_shared.h: +

#ifdef Q3_VM
+typedef int intptr_t;
+#else
+#include <stdint.h>
+#endif
+Note: if you simply wish to run mods on a 64bit platform you do not +need to recompile anything since by default Q3 uses a virtual machine system.

+ +

Creating Mods Compatible With Quake III 1.32b

+

If you're using this package to create mods for the last official release of +Quake III, it is necessary to pass the command-line option -vq3 to your +invocation of q3asm. This is because by default q3asm outputs +an updated QVM format that is necessary +to fix a bug involving the optimizing pass of the x86 vm JIT compiler. Read +the web-forum post +about this issue for more details.

+

Pay your dues, contribute!

If you've come up with an improvement or fixed something, we'd love to hear about it! Firstly, try to make sure that the patch breaks less than it fixes. We don't @@ -28,7 +199,7 @@ not do anything at all.

Please make it clear if the patch you're submitting for inclusion isn't yours. Point out where you found it and who authored it. This is so we know who to attribute -blame to when it horribly breaks things credit to.

+blame credit to.

Generating Patches

If you know how to code, but never made a patch before, that's okay. Here's the 10ยข -- cgit v1.2.3