+----------------------------------------+
| Quake PRE-RELEASE                      |
| Tuesday, June 11th, 1996               |
| Copyright (C) 1996 id Software, inc.   |
+----------------------------------------+
| Operating Instructions                 |
| by John Romero                         |
+----------------------------------------+

IMPORTANT NOTE: This document is a shabbed-up version of the QTEST1
document that i wrote months ago.  It may suck.

This is our first severely limited pre-release, not intended for the
general public.  If you received this game from a member of id Software,
then you are supposed to have it, otherwise, you are in possession of
something which is not yours. You Are Bad.

There are 3 special documents that cover the 3 important components of the
Quake Engine: VIDEO.TXT, SOUND.TXT and NETWORK.TXT.  Please read these
documents to understand how that subsystem works within Quake.  There are
many command-line parameters listed that you can test for us!

Section List:

1.   Bug Reporting
2.   Running Quake
3.   The Quake Console
4.   Playing Quake
5.   Launching a Quake Server
5.1  Team Play
6.   Running Quake under Windows 95
7.   Problem Icons
8.   Default Keyboard Settings
9.   Quake Console Commands


+---------------+
| Section 1     |
| Bug Reporting |
+---------------+

What we would like from you is to send us (email only) a list of the bugs 
that you find, mostly regarding video problems, sounds problems, or network
problems.

Please send Quake bug-related email to johnr@idsoftware.com. In your subject
line, please describe the type of problem you are reporting: video, network,
sound or game.  It would help immensely if you could send a screenshot with
a bug report -- you can take screenshots with F11.  Send MIME email screens.

IMPORTANT NOTE: Before you even THINK about reporting any kind of bug,
make SURE you read the associated file (NETWORK.TXT, VIDEO.TXT and SOUND.TXT)
and use the bug reporting form contained at the end of that TXT file.


+---------------+
| Section 2     |
| Running Quake |
+---------------+

This pre-release should run okay on an 8mb RAM Pentium-based system.
486 systems are flat-out not going to be supported.

You MUST have a minimum of 8mb of RAM under DOS to run Quake, 16mb
to run under Win95.

+-------------------+
| Section 3         |
| The Quake Console |
+-------------------+

While playing Quake, you can press the ~ (tilde) key to
bring up the console or put it away.  The console is where you enter all
the commands to change the game state.  Any commands that you can enter
in the console can be entered into the console from the command-line by
putting "+" before the command.

For example, one console command is "map <name>" which will load a map
and start it up.  Starting up a map actually starts a local Server and
a Client.  To have a map load up when Quake starts, from the command-
line, you can add "+map <name>" to the command-line. Then, Quake will
load that map after initialization.  From the command-line, the "+" 
character tells Quake that the following parameter should execute the 
console command after initialization.  Any command-line parameter that
starts with a "-" character is an initialization parameter, such as 
"-nosound" and is not something that can be typed in the Quake console.

The console has a command history just like DOSKEY.  Pressing the up and
down arrows in the console will change to the last command entered. You
can backspace over the command and enter new values if you'd like. There
is also a command-completion function.  By pressing the TAB key, you can
have the console automatically finish the name of the command for you. A
really good example of this is the "vid_describemodes" command that lists
all the video modes available on your system.  Instead of typing that
entire command, merely type "vid_d" then press the TAB key and ENTER.


+---------------+
| Section 4     |
| Playing Quake |
+---------------+

Please read the accompanying MANUAL.TXT for the text of the actual manual
that will be printed in the Quake CD package.  The manual can tell you
pretty much everything you need to know about playing Quake.

+--------------------------+
| Section 5                |
| Launching a Quake Server |
+--------------------------+

First of all, there are two types of Quake Servers: Dedicated Servers and
Listen Servers.  Dedicated Servers are used only for running Quake network
games; they will not display any graphics nor output any sound.  The other,
and most common, type of Server is a Listen Server.  This type of Server
will host a game AND operate as a Client.

At this time, there are only 2 network protocols that Quake understands. 
These are IPX and TCP/IP.  Quake understands Win95 TCP/IP and BWNFS TCP/IP
from Beame & Whiteside (this is not a shareware product).  The 
IPX protocol works fine from both DOS and Windows95, so this protocol is
recommended.  Please note that the IPX protocol will NOT work over the
Internet unless a higher-level transport protocol is used.  For more
details, please read NETWORK.TXT.

There are two important command-line parameters that you need to use to
start a network Quake Server. The "-dedicated" parameter will cause Quake 
to run in Dedicated Server mode.  Clients can connect to the Server by 
typing "+connect" on the command-line, or by typing "connect" in the 
console. The Quake Console is documented below.

The "-listen" parameter will make your system a Listen Server, which
places a heavier load on your system than normal, so run a Listen Server 
on a fast system. To connect to any kind of Server, type "+connect" on the
command-line or "connect" in the console.

At this time, the only way to start a Server is from the command-line. You
can start a Server on a specific map by typing "quake -dedicated +map e1m1",
for example.  After the "-dedicated" and "-listen" parameters you can limit
the amount of players allowed into the game by typing a value from 2-8. Thus,
a "-dedicated 2" would allow a 2-player-only game.  ALWAYS make sure you
include the map on the command-line as well, such as "+map e1m3". You pretty
much will always be starting Servers by typing "quake -listen +map e1m1" or
whichever map you select.

For example, if you want to start a 4-player-only Listen Server with Client
capability on the map named e2m6 with a time limit of 5 minutes, you would 
type (on the Server system):

quake -listen 4 +map e2m6 +timelimit 5

The Clients that want to connect to the Server would type:

quake +connect

+-------------+
| Section 5.1 |
| Team Play   |
+-------------+

Normally, Quake is a Deathmatch game in network mode. You can play TEAMS in
Quake if you type "teamplay 1" in the console on the Server.  Then, anyone
that wants to be on the same team must set their "color" to the same value.
For example: if I wanted to team up with Tim against Carmack and Abrash,
I would type "Quake +teamplay 1 -dedicated +map e1m1" on the Server system
and on my Client system I type "color 1" and have Tim type "color 1" in his
console as well so we're on the same team.  Then, when Carmack and Abrash
join the game, they both would select the same color so they're on the same
team.  Then -- BLOODBATH!

In team mode, shooting your teammate will ONLY STRIP ARMOR POINTS from your
teammate.  Rockets and whatnot will not kill them.  They may scream, but
they will not die.  Unless you crush them with something. :)

To have everyone start the game at the same time, someone can press the
PAUSE key and the game will pause while everyone connects to the Server.
Pressing PAUSE again will start the Team Deathmatch.


+---------------------------+
| Section 6                 |
| Running Quake under Win95 |
+---------------------------+

To run Quake under Windows95, you absolutely need 16mb RAM.  Anything less
and Quake will just quit back to Win95.  To check your system's memory,
open up "My Computer->Control Panel->System".

Some systems will not run Quake in a window.  Run an MS-DOS session
and switch to full-screen by pressing ALT-ENTER.  Then run Quake.

Two things you need to be aware of when running Quake from an MS-DOS shell:

1) Do NOT check the box labelled "Prevent MS-DOS-based programs from
detecting Windows" in the Advanced dialog in MS-DOS Prompt Properties
when running Quake.  Quake will run jerkily and will sometimes exit
for no apparent reason if this box is checked.

2) Set the "MS-DOS protected-mode (DPMI) memory" field in the Memory
section of MS-DOS Prompt Properties to either Auto or a value of at
least 12288.  Quake will fail to load with smaller values.

If you are having crashing problems running Quake under Win95, try using the
"-nosound" command-line parameter.


+---------------+
| Section 7     |
| Problem Icons |
+---------------+

Quake has 2 Problem Icons that you may see on your screen from time to time.

When you get disconnected from a Quake Server or the network packet flow is
disturbed, you will see a Network Disconnect icon below the spot where the
turtle icon would be.

When you are very low on RAM and are in a complex area, you may see a RAM
chip under the area where the Network Disconnect icon would be. This means
that Quake is running low on available memory and you should size down your
SMARTDRIVE cache size or get more memory.


+---------------------------+
| Section 8                 |
| Default Keyboard Settings |
+---------------------------+

Quake's keyboard controls are very similar to DOOM's with the exception
of a few new commands.

Toggle CONSOLE mode = ~ (tilde)
Attack = CTRL
Move forward = up arrow
Move backward = down arrow
Turn left = left arrow
Turn right = right arrow
Strafe left = ,
Strafe right = .
Jump/Swim = spacebar and ENTER
Size screen up = +
Size screen down = -
Freelook = \

The "Freelook" command will allow the mouse to control the view angle.
Hold the "freelook" key down and move the mouse around at the same time
and see how your view changes.  Get good at this.  All these keys are
configurable INSIDE THE GAME from the Options menu.


F1 = Help
F2 = Save game
F3 = Load game
F4 = Options menu
F5 = Multiplayer menu
F6 = Quicksave
F7 = End Game
F9 = Quickload
F10 = Quit game to DOS/Win95


Common Server Commands
======================

START A MAP
Syntax: map <name>

There are four episodes/30 maps in Quake and their maps are named
similar to DOOM maps. Their names are: e1m1, e1m2, e1m3, e1m4, e1m5,
e1m6, e1m7, e1m8, e2m1, e2m2, e2m3, e2m4, e2m5, e2m6, e2m7, e3m1,
e3m2, e3m3, e3m4, e3m5, e3m6, e3m7, e4m1, e4m2, e4m3, e4m4, e4m5,
e4m6, e4m7, e4m8, start, end.

CLEAR CONSOLE BUFFER
Syntax: clear

EXECUTE A CONFIGURATION FILE
Syntax: exec <filename>

DISCONNECT FROM THE CURRENT SERVER
Syntax: disconnect

LIST ALL AVAILABLE SERVERS
Syntax: slist

CONNECT TO A SERVER
Syntax: connect
OR
Syntax: connect <slist name>


Network Client Settings
=======================

SET YOUR NAME IN THE GAME
Syntax: name <string>

SET YOUR COLOR IN THE GAME
Syntax: color <0-15 = solid character color>
OR
Syntax: color <0-15 = shirt> <0-15 = pants>


Network Server Settings
=======================

SET THE AMOUNT OF FRAGS AT WHICH THE GAME WILL QUIT
Syntax: fraglimit <value>
The default is 20.

SET THE AMOUNT OF TIME THE GAME WILL LAST BEFORE QUITTING
Syntax: timelimit <value>

SET TEAMPLAY
Syntax: teamplay <value>
The default is 0.

SET WHETHER THE GAME IS ABLE TO BE PAUSED OR NOT
Syntax: pausable <0/1>

SET THE NAME OF YOUR SERVER
Syntax: hostname <string>

CHANGE THE SPEED OF THE GAME
Syntax: host_framerate <value>
The range is 0 to 0.01.  To go slower, use 0.01.

CHANGE THE MAXIMUM SPEED OF THE PLAYER
Syntax: sv_maxspeed <value>
The default is 320.


