Introduction
============
Fodquake is a QuakeWorld client. Multiplayer game.

---

Installation
============
Unpack Fodquake archive wherever you want. Copy pak0.pak and pak1.pak from your Quake(World) game to:

• Fodquake/id1/ directory on AROS and MorphOS.
• ~/.fodquake/id1 directory on FreeBSD and Linux.
• ~/Library/Application\ Support/Fodquake/id1/ directory on Mac OS X.
• My Documents/Fodquake/id1 directory on Windows.

---

Starting
========
Doubleclick fodquake-gl or fodquake-sw icon. Game welcomes you with a console screen. To show a main menu press the ESC key.

---

Main
====

SinglePlayer
Not supported.

MultiPlayer
Here you can go to server browser where you can start a game, configure player setup, browse and play demos.

Options
Brings an option menu where you can customize controls, change video mode, graphics settings, save your config.

MediaPlayer
Not supported.

Quit
Shows about screen. Quits the game.

---

Options
=======

Customize controls
You can assign the key/button for each action by selecting the entry and pressing the new key/button.

Go to console
Brings down you a console.

Reset to defaults
Resets settings to defaults.

Screen size
Adjusts screen size.

Gamma
Adjusts gamma, you can make your screen darker or lighter using this setting.

Contrast
Adjusts contrast.

Mouse speed
Adjusts mouse speed.

CD music volume, Sound volume.
Adjusts volume

Video modes
This menu allows to change a video mode, lists the available modes your system/video card/monitor support.

FPS Settings
You can change basic graphics options here. There are two preset modes, fast and high quality.

---

Controls
========

• W, UP - forward.
• A, LEFT - left.
• S, DOWN - backward.
• D, RIGHT - right.
• Space, Caps Lock, Ctrl - jumps.
• Left mouse button - fires a rocket launcher.
• Right mouse button - fires a lightning gun.
• Middle mouse button - fires a shotgun.
• TAB - shows a score table.
• ESC - shows a main menu.
• ~ - brings down console.

Related commands:

bind
     Usage: bind <key> [command]
     Attaches a command to a key.
     Used without command shows commands actually binded to a key.
     Note: Enclose multiple commands within quotes and seperate each command with a semi-colon.

bindlist
     Lists all binds.

unbind
     Usage: unbind <key>
     Remove commands from a key.

unbindall
     Removes all commands from keys.

---

Server Browser
==============
Allows you to find a match or a player, add friends. Sorts servers by gametype in columns. Here you can join games, observe, watch EzTV streams via QTV proxy.

• UP - moves selection highlight up.
• DOWN - moves selection highlight down.
• LEFT - switches a selected tab to the left.
• RIGHT - switches a selected tab to the right.
• Ctrl, Shift - if pressed, changes jump when using UP, DOWN.
• Tab - switches selected column.
• Enter - joins the selected server.
• Ctrl Enter - joins the selected server as a spectator.
• Shift Enter - joins the selected server via FTEQTV.
• Ctrl R - refreshes the server list.
• Ctrl F - opens a player search box.
• / - opens a map/server search box.
• Ctrl H - displays a help.
• ESC - quits the server browser.

Related commands:

sb_activate
     Shows a server browser.

sb_add_filter
     Usage: sb_add_filter [tab name] [filter name] [filter operator] [value]
     Adds a filter.

sb_add_friend
     Usage: sb_add_friend friend
     Adds a friend.

sb_add_tab
     Usage: sb_add_tab [tab name]
     Adds a tab.

sb_del_tab
     Usage: sb_del_tab [tab name]
     Deletes a tab.

sb_list
     Lists all tabs.

sb_refresh
     Refreshes a servers list.

sb_remove_friend
     Usage: sb_remove_friend friend
     Removes a friend.

sb_search
     Usage: sb_search nm player_name map
     You can use one or both arguments.

sb_set_clipboard
     Usage: sb_set_clipboard [clip bord text]

sb_tablayout
     Usage: sb_tablayout tab_name [ping players map hostname]
     Sets layout of a server browser.

sb_write_config
     Saves a server browser config.

---

Player setup
============
Here you can change your name, team, colour of shirt and pants.

Related commands:

color
     Usage: color <0-13> [0-13]
     Sets the color for the player's shirt and pants.
     Note: If one color is given, shirt and pants will share the same color.

teamcolor
     Usage: teamcolor <0-13> [0-13]
     Sets the color for the friendly's shirts and pants.
     Note: If only the shirt color is given, the pants color will match.

enemycolor
     Usage: enemycolor <0-13> [0-13]
     Sets the color of the enemy's shirts and pants.
     Note: If one color is given, shirt and pants will share the same color.

---

Demos
=====
Here you can browse and play demos. Press Ctrl Enter to timedemo.

Related commands:

demo_capture
     Usage: demo_capture <start time | stop>
     Captures a demo to frames. Uses demo_capture_fps and (default: "30") and demo_capture_dir (default: "capture").

demo_jump
     Usage: demo_jump [+:-][M:]<s> (seconds)
     Jumps to a point in time.

demo_setspeed
     Usage: demo_setspeed [speed %]
     Sets playback speed.

easyrecord
     Records a demo and names it according to match_* settings.

playdemo
     Usage: playdemo <demoname>
     Plays a demo.

record
     Usage: record <demoname>
     Records a demo.

stop
     Stops demo recording.

timedemo
     Usage: timedemo <demoname>
     Runs a demo as fast as possible and shows the average fps rate.

---

Screen
======

Related cvars:

scr_centerSbar
     Enables/disables screenbar centering.
scr_compactHud
     Compact hud mode.

• 0 -
• 1 -
• 2 -
• 3 -

cl_gameclock
     Changes gameclock mode.

• 0 - off.
• 1 - hh:mm:ss - current your time.
• 2 - hh:mm:ss - remaining game time.
• 3 - mm:ss - current your time.
• 4 - mm:ss - remaining game time.
• 5 - hh:mm:ss - current your time.

crosshair "2"
     Changes crosshair type.

• 0 - off.
• 1 - txt file in crosshairs/crosshair.txt.
• 2 -
• 3 -
• 4 -
• 5 -
• 6 -
• 7 -
• 8 - char from charset.

crosshairalpha (GL only)

• 1 - 100% intensity.
• 0 - 0% intensity.

crosshaircolor
     Color number from a quake palette or a RGB value.

crosshairimage <filename> (GL only)
     png/tga file in qw/crosshairs/. "" to disable.

crosshairsize
     Sets size of a crosshair. In the range of 0 to 20.

Drawflat:

Allows to either choose distinct colours for walls, floors/ceilings and slopes, or choosing to colour each surface on the entire map according to their wish.

r_drawflat
     Usage: r_drawflat [x_lower_limit] [y_upper_limit] [y_lower_limit]
     [y_upper_limit] [z_lower_limit] [z_upper_limit] [r] [g] [b]
     Limits go from -1 to 1, colors should be in the range of 0 to 1.

r_drawflat_floors_ceilings
     Usage: r_drawflat_floors_ceilings [r] [g] [b]
     Colors should be in the range of 0 to 1.

r_drawflat_set
     Usage: r_drawflat_set [surface] [r] [g] [b]
     Colors should be in range of 0 to 1.

r_drawflat_shoot
     Usage: r_drawflat_shoot [r] [g] [b]
     Colors should be in the range of 0 to 1.
     Paints selected part of a wall/floor/ceiling/slope.

r_drawflat_shoot_unset
     Removes selected paint from a part of wall/floor/ceiling/slope.

r_drawflat_slopes
     Usage: r_drawflat_slopes [r] [g] [b]
     Colors should be in the range of 0 to 1.

r_drawflat_unset
     Removes all paint from all surfaces.

r_drawflat_walls
     Usage: r_drawflat_walls [r] [g] [b]
     Colors should be in the range of 0 to 1.

r_drawflat_writeconfig
     Saves a drawflat config to qw/<mapname>.dfcfg.

---

Weapons
=======

• Axe
• Shotgun (SG)
• Barreled shotgun (BS)
• Nailgun (NG)
• Super nailgun (SN)
• Grenade launcher (GL)
• Rocket launcher (RL)
• Lightning gun (LG)

---

Ammunition
==========

• Shells - For shotguns.
• Flechettes - For nailguns.
• Rockets - For rocket launcher and grenade launcher.
• Cells - For lightning gun.

---

First Aid Kits
==============

• Yellow kit - + 15 energy points. max. 100.
• Green kit - + 25 energy points. max. 100.
• Mega kit (MH) - + 100 energy points, max. 250. 1 point less per second till player has 100.

---

Armours
=======
They respawn 20 seconds after pickup.

• Green Armour (GA) - 50 armour points.
• Yellow Armour (YA) - 150 armour points.
• Red Armour (RA) - 200 armour points.

---

Powerups
========
They wear out after 30 seconds of use.

• Quad - gives your weapons increased firepower. Respawn after 60 seconds.
• Ring - renders you almost invisible. Respawn after 5 minutes.
• Pentagram - renders you immortal. Respawn after 5 minutes.

---

Console
=======
Console can be brought down by pressing the ESC key in the main menu or the tilde (~) key when connected to a server.
List of all commands, cvars and macros.

Related cvars:

context_sensitive_tab_completion
     Switches tab completion mode
scr_conalpha
     Sets level of transparency in the console. In the range of 0 to 1.
scr_consize
     Sets size of the console. In the range of 0 to 1.

---

Misc
====
Some unsorted useful commands and cvars.

cl_maxfps
     Sets an upper limit how many frames Fodquake is allowed to generate. 0 means as many as your hardware can do.

---