no more nexuiz on home page
[xonotic/xonotic.wiki.git] / Vehicles.md
1 # Please note that this page is still being revised! The information is not 100% accurate yet.
2
3 # About
4
5 ## General informatoin
6
7 Vehicles in Xonotic introduce new dynamics and fun in team play, especially Capture The Flag (CTF), compared to traditional vehicle-free games.
8
9 There are several types of vehicles in Xonotic. Some can fly, some can jump, some can walk, and some can dive. Some need at least one player to operate (drive or pilot). Some vehicles need, in addition to the driver/pilot, one or more gunners to operate the weapons on the vehicles. Some vehicles are not equipped with weapons but can transport a lot of players to a differnt location.
10
11 ## Play a game with vehicles
12
13 Vehicles are available in maps that support them, i.e. maps that have vehicle placed in them. The map makers, or the mappers, have to put vehicles in maps for players to play.
14
15 Any standard servers support vehicles if they include maps with veheciles placed in them. [Some servers](Special-Servers) features only large maps for vehicles.
16
17 [Unsealed Trial 3](http://dl.xonotic.co/unsealedtrial3-full-51eac9fbb6b2b8f3037ff242ef62a6f3698526f6-aff677d276411b4391becf801121abc211c7dcaa.pk3) is a map that supports all offical vehicles.
18
19 # Operating a vehicle
20
21 ## Basic control
22
23 To enter a vehicle, simple go/jump into it. To leave a vehicle, use the keybind "+use" (default key: "F").
24
25 The first player to enter the vehicle will be the driver/pilot. The movement for differnt vehicles are slightly different, but in general +forward (W), +backward (S), +moveleft (A), +moveright (D), +crouch (SHIFT), +jump (SPACE), and mouse movement are used for controlling vehicle movement. +fire (mouse left click) and +fire2 (mouse right click) triggers the primary and secondary weapon, respectively. +weapprev/+weapnext (mousewheel) to switch to weapons, if the vehicle is equipped with multiple weapons.
26
27 If the vehicle supports multi-passengers, then after the driver/pilot enter the vehicles, subsequent players who enter the vehicle will be the passengers. Some vehicles have weapons for passengers. The same keys above are likely to control the weapon aims as well.
28
29 ## Cockpit view
30
31 ![Spiderbot cockpit legend](img/Vehicle-cockpit-legend.jpg)
32
33 Different vehicles have different cockpit view; however, the general principles are the same. Shown above is Spiderbot's cockpit.
34
35 ### Status Panel
36
37 Status panel is at the bottom; it shows, clockwise from lower-left, vehicle shield level, vehicle health, primary weapon status, and secondary weapon staus. In the center of this panel is the general status report of the vehicle.
38
39 The vehicle shield protects the vehicle from attack and collision, which, when happens, lowers the shield level. The shield level will gradually restore over time. When the level drops to zero, the vehicle will start taking damages.
40
41 The vehicle health is affected when there is no shield protecting the vehicle. When it drops to zero, the vehicle explodes. Some vehicles can slowly repairs itself.
42
43 The primary weapon and the secondary weapon are triggered by +fire (default: mouse left click) and +fire2 (default: mouse right click). Their status reflects their level of power/bullets/rockets/etc. Some vehicles movement, such as Racer's acceleration, consumes the energy from the primary weapon.
44
45 ### Crosshair (or reticle)
46
47 The crosshair (or reticle) shows the direction the weapons are pointing to. In some vehicles, the primary weapon and the second weapon have different reticles. If the weapon is fixed, it always points to the same direction as the front of the vehicle; if the weapon is not fixed, it either takes a while for the aiming computer on the vehicle to align with the vehicle direction, or the gunner can control the aiming direction.
48
49 # Official vehicles
50
51 ## Bumblebee
52
53 ![Bumblebee outside](img/Vehicle-bumblebee.jpg)
54
55 ![Bumblebee cockpit](img/Vehicle-bumblebee-cockpit.jpg)
56
57 Up to three players can ride the Bumblebee, a flying vehicle, at the same time.
58
59 ![Bumblebee pilot view](img/Vehicle-bumblebee-pilot-view.jpg)
60
61 The first player will be the pilot, who can also use the green healing wave to heal other teammates.
62
63 ![Bumblebee right gunner view](img/Vehicle-bumblebee-gunner-view.jpg)
64
65 The second player will be the right gunner. The third player will be the left gunner.
66
67 When the pilot leaves Bumblebee, the second player becomes the pilot.
68
69 There are no secondary weapons for any of the three riders in Bumblebee.
70
71 ## Racer
72
73 ![Racer outside](img/Vehicle-racer.jpg)
74
75 ![Racer cockpit](img/Vehicle-racer-cockpit.jpg)
76
77 The Racer looks like a jet, but does not fly high into the sky, similar to [the racers in Starwar](https://en.wikipedia.org/wiki/Star_Wars_Episode_I:_Racer). Use +jump (default: spacebar) to accelerate it. The acceration consumes power from the same source as the primary weapon.
78
79 The Racer takes one player at a time. There are two types of weapon. The primary weapon is laser; the secondary weapon is energy balls that explodes.
80
81 ## Raptor
82
83 ![Raptor outside](img/Vehicle-raptor.jpg)
84
85 ![Raptor cockpit](img/Vehicle-raptor-cockpit.jpg)
86
87 The flying Raptor takes one pilot who can also opearate two weapons. There are two different reticles for them. The primary weapon is laser based, and is shot toward the white reticle. The secondary weapon is air-to-groud bombs, is dropped onto the ground the green reticle is pointing at. The white reticle always points at the head of the vehicle. The green reticle is projected by the movement momentum of the vehicle.
88
89 ## Spiderbot
90
91 ![Spiderbot outside](img/Vehicle-spiderbot.jpg)
92
93 ![Spiderbot cockpit](img/Vehicle-spiderbot-cockpit.jpg)
94
95 Spiderbot takes one rider. It walks on the ground and can jump from very high altitude while protecting the rider.
96
97 ![Spiderbot cockpit legend](img/Vehicle-cockpit-legend.jpg)
98
99 Its primary weapon is machine gun; the aiming direction is shown by the green reticle, which follows the front of the vehicle, given enough time. The secondary weapon is rockets that are aimed with the white reticle, which always points to the front of the vehicle.
100
101 # Unofficial vehicles
102
103 On [some servers](Special-Servers), one may find experiment vehicles that are not official, such as tanks, helicopters, jets, etc. Please post your opinions on them in [Xonotic Official Forums](http://forums.xonotic.org).
104
105 # Notes for mappers
106
107 Vehicle class names for mappers:
108
109 - Bumblebee: "vehicle_bumblebee"
110 - Racer: "vehicle_racer"
111 - Raptor: "vehicle_raptor"
112 - Spiderbot: "vehicle_spiderbot"
113
114 # Notes for developers
115
116 `Assault` needs testing, as far as i can tell it should work now.
117
118 `ons/dom` is UNSUPPORTED, as in targeting vehicles with those ents - this is in development.
119
120 Maps needed, `as` and `ctf` for now - i cant take this much further w/o play testing on a larger scale.
121