=========
BUILDING:

./configure
make (opengl)
  or
make x11 (software)

  There is no make install, so no need to add --prefix to the configure script.
I use this script mostly for helping people finding which libraries or headers
are missing on their system. In most cases, you will probably have to install
some packages.

On a Debian-like system, the following commands might be helpful:

apt-get install libc6-dev gcc make
apt-get install libasound2-dev libasound2
apt-get install libjpeg62-dev libjpeg62
apt-get install libpng12-dev libpng12-0
apt-get install libxxf86vm-dev libxxf86vm1	(needed for fullscreen/gamma)
apt-get install libgl1-mesa-dev libgl1-mesa-glx
  or if you plan to build a X11 target
apt-get install libxext-dev libxext6
  or if you're trying to build a svga target (not maintained)
apt-get install libsvga1-dev libsvga1

  If you want to enable some options in the configure script:
apt-get install libdbus-1-dev libdbus-1-3
apt-get install libmpg123-dev libmpg123-0
apt-get install libxxf86dga-dev libxxf86dga1
apt-get install libxxf86misc-dev libxxf86misc1

========
RUNNING:

  Example:
./quore-i686-glx -base /home/data/baseq1

  Useful arguments:
-base <basedir>            : set the base directory containing id1
-[no]cd [<device>]         : enable/disable audio cd
+connect <hostname>        : connect to the given host
-debug [<level>]           : increase verbosity and print messages to stdout
-dedicated [<maxclients>]  : launch a dedicated server
-default                   : reset everything
-[no]extra [<extradir>]... : set/unset extra content directories
-[no]free [<freedir>]...   : set/unset the default content directories
-[no]game [<gamedir>]...   : set/unset the default game directories
-help                      : display this help and exit
-legacy [<legacydir>]      : enable legacy mode
-log                       : log console messages to ~/.quore/console.log
+map <mapname>             : load the given map
-[no]multi [<multidir>]... : enable/disable multiplayer mode
-[no]quore [<quoredir>]... : enable/disable quore mode
-[no]sound [<device>]      : enable/disable sound
-window [<width> <height>] : use windowed mode with the given size

  Useful keybinds:
Escape       : main menu
F1           : game menu
F2           : save game
F3           : load game
F4           : options
F5           : video options
F6           : quick save
F9           : quick load
F10          : quit
TAB          : game info
print screen : screenshot

================
TROUBLESHOOTING:

- If you're running the Gnome Desktop, gamma is reset during game by the
screensaver, you can add --enable-dbus to the configure script to prevent this.

- Water surfaces can look ugly when transparent water is enable and the map does
not contain visibility informations for the underwater area. From this you have
three choices, turn off transparency, turn on novis (in the main menu) to
disable visibility checks and render the whole map each frame, or patch the map
with vispatch.sf.net (you need a .vis file correponding to your map).

- If models or brushes look ugly when underwater, turn off gl_caustics.

- If you want to disable 3rd button emulation, go to your xserver config file
and check for the Emulate3Buttons option.

- If your system is low on memory, turn off r_levels or, if you don't care
waiting while loading a map, free the memory used by r_levels by setting
r_levelslowmemory to 1. The more detailed are the textures, the more memory will
be used to store them either in your video card or on your main board.

- If you want to try OSS emulation, type the following as root:
echo "quore 0 0 direct" > /proc/asound/card0/pcm0p/oss

- If you experience sound glitches, use --disable-alsa with the configure script

  There's still many bugs, see the BUGS file for a non-exhaustive list.

===========
CONTACTING:

  If you're having trouble building the engine, or if you find a bug, or if you
have a patch, or any other reason, feel free to send an email at quore@free.fr

=========
THANKING:

  I would like to thank everybody which has taken part to the Quake opensource
adventure, in particular John Carmack, David "Zoid" Kirsch, Jozsef Szalontai,
Qudos, Entar, all the original authors of the visual effects I have used in
this engine, the ezQuake team, r00k, John Fitz, and everyone else I don't know
neither the name nor the work.


Life is short,

lxndr
