From 42af5bcf3d3d9fc377e9335af3f62435b985e683 Mon Sep 17 00:00:00 2001 From: SilentSpike Date: Sun, 26 Jul 2015 23:12:10 +0100 Subject: [PATCH] Spectator usage documentation --- documentation/feature/spectator.md | 188 +++++++++++++++++++++++++++++ 1 file changed, 188 insertions(+) create mode 100644 documentation/feature/spectator.md diff --git a/documentation/feature/spectator.md b/documentation/feature/spectator.md new file mode 100644 index 0000000000..e8019bd3ba --- /dev/null +++ b/documentation/feature/spectator.md @@ -0,0 +1,188 @@ +--- +layout: wiki +title: Spectator +description: A flexible spectator system +group: feature +parent: wiki +--- + +## 1. Overview + +## 2. Usage + +### 2.1 Spectator Shortcuts + +#### 2.1.1 Interface Shortcuts + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ShortcutAction
HToggle help
MToggle map
1Toggle unit list
2Toggle toolbar
3Toggle compass
4Toggle unit icons
BackspaceToggle interface
+ +#### 2.1.2 Free Camera Shortcuts + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ShortcutAction
WCamera forward
SCamera backward
ACamera left
DCamera right
QCamera up
ZCamera down
LMBCamera dolly
RMBCamera pan and tilt
ScrollwheelZoom in/out
Ctrl+ScrollwheelSpeed up/down
NNext vision mode
Ctrl+NPrevious vision mode
+ +#### 2.1.3 Unit Camera Shortcuts + + + + + + + + + + + + + + + + + + + + + + +
ShortcutAction
Right arrowNext unit
Left arrowPrevious unit
RMBToggle gun camera
+ +#### 2.1.4 General shortcuts + + + + + + + + + + + + + + + + + + +
ShortcutAction
Up arrowNext camera
Down arrowPrevious camera
+ +### 2.2 The Interface + +#### 2.2.1 Unit list + +The unit list on the left lists all of the units currently available to spectate. +Double click on any unit name in the list to switch to the unit. +Double click on the current unit to switch between internal and external view. + +#### 2.2.2 Toolbar + +The toolbar along the bottom of the screen displays various useful values. From left to right these are: + +* Unit name +* Camera mode +* Camera zoom/Unit side +* 24-hour Clock +* Vision mode/Unit depth +* Camera/Unit speed + +#### 2.2.3 Map + +The map overlay will show the current position of the free camera and all spectatable units. The unit icons are tied into the unit icon toggle shortcut. When spectating a unit the map will also show the icons of units it knows about. In free camera you can double click on the map to teleport the camera to the position of the mouse. + +## 3. Dependencies + +`ace_common`