AGRIP AudioQuake Manual

Matthew Tylee Atkinson

0.3.0

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

Please note that AudioQuake itself is distributed under the GNU General Public License. This is included as an appendix to this document as with the FDL.

2nd January 2008

Abstract

This is the user manual and reference guide for AudioQuake. We hope you'll find it helpful and informative. Please help us improve the manual by reporting any bugs and/or submitting update requests to .

The AGRIP web site, which provides a number of resources for those using and developing AudioQuake, can be found at: http://www.agrip.org.uk/

The latest version of this manual can be found at: http://docs.agrip.org.uk/

The revision number of the manual follows the same format as the AudioQuake version number. If the first two digits of the version numbers match, the manual and AudioQuake will correspond.


Table of Contents

I. Introduction
1. Important Note
2. What is AudioQuake?
2.1. More than just an “Accessible Game
2.2. Quake
2.2.1. Not for Under-15s
2.3. Customisable
2.4. Free (as in Freedom)
2.5. Only the Beginning
3. Installing AudioQuake
3.1. Why Quake is Required and How to Try Before You Buy
3.2. mindgrid:audio
3.3. Installing AudioQuake on Linux
3.4. Installing AudioQuake on Windows
3.5. Installing from Source
II. Playing AudioQuake
4. Starting AudioQuake
4.1. Running the Game
4.2. Initial Data File Set–up
4.3. How Best to Listen
5. The User Interface
5.1. The Game Launcher
5.2. The Console
5.3. Quake Menu
6. Navigation
6.1. Moving Around
6.2. Navigation Helper
6.2.1. Obstacle (Wall, Door and Slope) Indications
6.2.2. Hazard Detection
6.2.3. Open Space Detection
6.2.4. Corner Detection
6.3. Independent Navigation Aids
6.3.1. Footsteps
6.3.2. The Compass
6.3.3. Waypoint Markers
7. Creature and Hazard Detection – The EtherScan RADAR
7.1. Monster Detection
7.2. Hazard Detection
7.3. Is it a Monster, Enemy or Friend?
8. Item Detection, Weapons, Health and Ammo
8.1. The Detector 5000
8.2. Using the Weapons
8.3. Health, Ammo and Armour Indicators
9. Completing a Map and Miscellaneous Keys
9.1. Completing a Map
9.2. Other Keys and Exiting the Game
III. Singleplayer Game Modes
10. The AudioQuake Tutorial
11. Single-Player
11.1. Difficulty Level
11.2. Game Saving and Loading
IV. Multiplayer Game Modes
12. Gametypes
12.1. Deathmatch
12.1.1. Deathmatch Variations
12.1.2. Frag and Time Limits
12.2. Team Deathmatch
12.2.1. Additional Team Deathmatch Variations
12.3. Co-Operative (“co-op”)
13. Offline Practice with Bots
13.1. Deathmatch
13.1.1. Setting Frag and Time Limits
13.2. Team Deathmatch
13.3. Co-Op
14. Playing Matches with other People
14.1. Multiplayer Basics
14.2. Setting Your Player Information
14.3. Joining a Game
14.4. Chatting
14.4.1. Chat History
14.5. Playing the Game
14.5.1. Scores and Scoreboards
14.5.2. Online Statistics
14.6. Leaving a Game
15. AudioQuake Stats and Servers Website
15.1. What is it?
15.2. Quick Tour
15.3. Getting Your Stats Included
16. Setting up and Running your own Server
16.1. Clients and Dedicated vs. Listen Servers
16.1.1. Why Use Dedicated Servers?
16.2. Public vs. Private and Stats Logging
16.3. Interacting with the Server Directly
16.4. Configuring Your Server
16.4.1. Port
16.4.2. Map Cycles
16.5. Admin Tasks
V. Maps
17. Deathmatch/Team Deathmatch Maps
17.1. agdm01: The Melee
17.2. agdm01t: The Melee – 1on1 Edition
17.3. agdm02: Halls of Retribution
17.4. agdm02l: Halls of Retribution – Warring Factions Remix
VI. Customising AudioQuake
18. Menu–Based Customisation with the Launcher
19. autoexec.cfg
19.1. Object Toggle Settings
19.2. Detection Settings
19.3. Sound Volume Settings
19.4. Key Bindings
19.5. Aliases
20. The Launcher – Alternative Speech/Braille Settings
20.1. Changing the Default SAPI Voice
20.2. Editing Launcher Options
20.2.1. What to Configure
20.2.2. Linux and Windows Differences
20.3. Using a Different Software Synthesiser
20.4. Using a Hardware Speech Synthesiser or Braille Display
20.5. Other Options
VII. Reference Information
A. Key to the AudioQuake Sounds
A.1. Toggle Sounds
A.2. Navigation Sounds
A.2.1. Jump Descriptions
A.3. Independent Navigation Aid Sounds
A.3.1. Compass Sounds
A.4. Detector 5000 Sounds
A.5. Weapon Sounds
A.6. EtherScan RADAR Sounds
A.6.1. Hazard Detection Mode
A.7. End of Level
B. Finding out More – The Web is Your Friend!
C. Installing AudioQuake from Source
C.1. Installing from Source on Linux
C.2. Installing from Source on Windows
D. Manual Revision History
E. GNU General Public License
E.1. Preamble
E.2. TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
E.2.1. Section 0
E.2.2. Section 1
E.2.3. Section 2
E.2.4. Section 3
E.2.5. Section 4
E.2.6. Section 5
E.2.7. Section 6
E.2.8. Section 7
E.2.9. Section 8
E.2.10. Section 9
E.2.11. Section 10
E.2.12. NO WARRANTY Section 11
E.2.13. Section 12
E.3. How to Apply These Terms to Your New Programs
F. GNU Free Documentation License
F.1. PREAMBLE
F.2. APPLICABILITY AND DEFINITIONS
F.3. VERBATIM COPYING
F.4. COPYING IN QUANTITY
F.5. MODIFICATIONS
F.6. COMBINING DOCUMENTS
F.7. COLLECTIONS OF DOCUMENTS
F.8. AGGREGATION WITH INDEPENDENT WORKS
F.9. TRANSLATION
F.10. TERMINATION
F.11. FUTURE REVISIONS OF THIS LICENSE
F.12. ADDENDUM: How to use this License for your documents

List of Tables

A.1. Structures
A.2. Vertical Movement
A.3. Hazard (Drop/Ledge) Warnings
A.4. Waypoint Marker Sounds
A.5. Monster Indication Sounds
A.6. Enemy (Player or Bot) Indication Sounds
A.7. Friend (Player or Bot) Indication Sounds