# Readme

### From Q4MAX

[edit]

## Standard Installation

Unzip this archive in the root Quake4/ directory, with folders enabled. You should have a newly created directory named "q4max" with these files:

- readme.htm - This file.
- changelog.txt - A very terse list of additions, changes, and bugfixes. It is however BY FAR the most important of the docs, so READ IT!
- description.txt - The entry for the mods menu.

- zz-q4max-game-077.pk4
- zz-q4max-media-077.pk4

- A few extras (icon, .bat files...)and some standard dirs (docs, modes, cfg)

Make sure you read the docs. The most up to date source of information is our wiki.

[edit]

## If you're updating from a previous version of Q4Max

Delete ALL old .pk4 files in your server's q4max/ directory. Dedicated servers should only have the most recent zz-q4max-*.pk4 files in the /q4max directory to prevent unnecessary .pk4 downloads and confusion (especially on Linux/BSD-based servers).

Clients can keep the old .pk4 files for demo playback and the ability to play on servers that haven't updated yet.

[edit]

## Running the mod

We recommend you do not load Q4Max from the "Mods" menu. Instead you should run Quake 4 with the following command line parameter :

    +set fs_game q4max

(See below on how to create a shortcut that has these parameters on Windows).

This makes sure the mod can initialize properly. This is good practice with any mod, as not doing so will produce various quirks related to difference in variables beetween q4base and whichever mod you're switching to.

For Windows users, Start Q4Max.bat (found in your /q4max dir) will start Q4max directly as explained.

[edit]

## Running Servers

Listen servers are quite broken and we have chosen not to support them for now : we therefore recommend you ALWAYS use dedicated servers.

On Windows :

1. Make a shortcut to quake4ded.exe, right-click it and select Properties.
2. In the properties window, select the shortcut tab.
3. In the Target field, add command line options after the path and .exe name

i.e

    Quake4Ded.exe +set fs_game q4max +exec server.cfg

Start Q4Max-dedicated.bat will start a Q4max dedicated server directly as explained, you may want to edit the file for fs_savepath and other things though.

If you are going to run multiple dedicated servers on a single machine, you will have to add a different +fs_savepath "<path for this instance>" to the commandline of each instance. i.e.

  Server1:

      Quake4Ded.exe +set fs_game q4max +set fs_savepath "d:/server1"

  Server2:

      Quake4Ded.exe +set fs_game q4max +set fs_savepath "d:/server2"

and so on.

If you want to run a dedicated server and a client on your machine, you need to start the server with a fs_savepath as shown higher up.

More information about running servers can be found in the Server documentation page.