You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* added Quake2 info (Yamagi Quake II)
* added `ioquke3` as Q3 port
* restructured the headings, so the TOC is correctly generated
* re-worded some instructions
* added info and link to `lr-tyrquake` gamepad controls
* fixed the Quake pic.
Copy file name to clipboardExpand all lines: docs/Quake.md
+97-40Lines changed: 97 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,100 +2,94 @@
2
2
***
3
3
_Quake was a First Person Shooter series originally developed for the PC by Id Software. It is a successor to the Doom Series._
4
4
5
-
_There are 4 Quake games: Quake, Quake II, and Quake III Arena and Quake 4. RetroPie includes Quake, TyrQuake (an optimised build of the original Quake Engine), and Quake III Arena._
5
+
_There are 4 Quake games: Quake, Quake II, and Quake III Arena and Quake 4. RetroPie includes ports for Quake, Quake II and Quake III Arena._
6
6
7
7
_The source code to the original Quake engine was released under the GPLv2 license on December 21st 1999. This has enabled a wide variety of source ports and improvements to be made and for the game to run on alternative operating systems and architectures._
`libretro-tyrquake` utilises Retroarch configurations and is the recommended port.
26
-
27
-
Add custom RetroArch controls to the `retroarch.cfg` file in
22
+
### Controls
28
23
29
-
```shell
30
-
/opt/retropie/configs/quake/retroarch.cfg
31
-
```
32
-
For more information on custom RetroArch controls see: [RetroArch Configuration](RetroArch-Configuration)
24
+
`libretro-tyrquake` utilises Retroarch configurations and is the recommended port, since it supports a joystick/gamepad to play. See [here](https://docs.libretro.com/library/tyrquake/#joypad) for how the inputs are mapped to the Quake's keyboard.
25
+
You can also switch to a mouse/keyboard combination by changing the the _Device Type_ of the Player 1 connected controller to _Keyboard + Mouse_.
33
26
34
-
`tyrquake` does not support joystick/gamepad input, so is suitable only for those with a keyboard and mouse.
27
+
The other ports use the keyboard and mouse for controls.
35
28
36
-
## Upgrading Shareware to Registered
29
+
###Upgrading Shareware version to Registered
37
30
38
31
During installation of the port, the setup script places the shareware version of the Quake data files at:
39
32
40
33
~~~
41
34
/home/pi/RetroPie/roms/ports/quake/id1/pak0.pak
42
35
~~~
43
36
44
-
If you own the registered version, you may add the registered version data file at:
37
+
If you own the registered version, you may add the `id1` folder files from the installation of the registered version to:
45
38
46
39
~~~
47
-
/home/pi/RetroPie/roms/ports/quake/id1/pak1.pak
40
+
/home/pi/RetroPie/roms/ports/quake/id1/
48
41
~~~
49
42
50
43
The shareware version is Quake v1.06. It is recommended your registered data file be from v1.06 or v1.08 versions of the game, earlier versions may not be compatible.
51
44
52
45
There is no difference between the data files of v1.06 and v1.08, this was an update to the game engine only, not the data files.
53
46
54
-
## Quake Mission Packs
47
+
###Quake Mission Packs
55
48
56
49
In addition to many community maps, Quake had some commercial add-ons which are considered "official".
57
50
58
-
###Mission Pack 1: Scourge of Armagon
51
+
####Scourge of Armagon
59
52
60
-
Scourge of Armagon (aka `hipnotic`) was the first official Quake Mission Pack, sold by Hipnotic Interactive in 1997.
53
+
Scourge of Armagon (aka `hipnotic`) was the first official Quake Mission Pack, developed by Hipnotic Interactive and released in 1997.
61
54
62
-
Place the data file at:
55
+
Place the `hipnotic/pak0.pak` file from your registered installation at:
Reinstall the Quake port from the Setup Script, and a new option **Quake Mission Pack 1 (hipnotic)** will be created.
61
+
Reinstall the Quake port from the Setup Script and a **Quake Mission Pack 1 (hipnotic)**launcher will be added in _Ports_.
69
62
70
-
###Mission Pack 2 - Dissolution of Eternity
63
+
####Dissolution of Eternity
71
64
72
-
Dissolution of Eternity (aka `rogue`) is the second official Quake Mission Pack, sold by Rogue Entertainment in 1997.
65
+
Dissolution of Eternity (aka `rogue`) is the second official Quake Mission Pack, developed by Rogue Entertainment and released in 1997.
73
66
74
-
Place the data file at:
67
+
Place he `rogue/pak0.pak` file from your registered installation at:
75
68
76
69
~~~
77
70
/home/pi/RetroPie/roms/ports/quake/rogue/pak0.pak
78
71
~~~
79
72
80
-
Reinstall the Quake port from the Setup Script, and a new option **Quake Mission Pack 2 (rogue)** will be created.
73
+
Reinstall the Quake port from the Setup Script, and a new entry - **Quake Mission Pack 2 (rogue)**- will be created in _Ports_.
81
74
82
-
### Episode 5 - Dimension of the Past
75
+
####Episode 5 - Dimension of the Past
83
76
84
-
To celebrate Quake's 20th anniversary, MachineGames (developer of Wolfenstein: The New Order) created a new 10-level pack named *Episode 5 - Dimension of the Past* and released it for free at https://cdn.bethsoft.com/quake/dopa.rar
77
+
To celebrate Quake's 20th anniversary, MachineGames (developer of Wolfenstein: The New Order) created a new 10-level pack named *Episode 5 - Dimension of the Past* and released it for free at <https://cdn.bethsoft.com/quake/dopa.rar>.
85
78
86
79
To get DOPA working in the RetroPie Quake ports, create a directory at:
87
80
88
81
~~~
89
82
/home/pi/RetroPie/roms/ports/quake/dopa/
90
83
~~~
91
84
92
-
Place the data file at:
85
+
Place the `pak0.pak` file from the DOPA archive file at:
93
86
94
87
~~~
95
88
/home/pi/RetroPie/roms/ports/quake/dopa/pak0.pak
96
89
~~~
97
90
98
-
Reinstall the Quake port from the Setup Script, and a new option **Quake Episode 5 (dopa)** will be created.
91
+
Reinstall the Quake port from the Setup Script, and a new entry - **Quake Episode 5 (dopa)** - will be created in _Ports_.
92
+
99
93
100
94
### Soundtrack Files
101
95
@@ -105,7 +99,7 @@ CD audio should be ripped into OGG format files, and placed into a subfolder nam
105
99
106
100
For more information refer to [this guide](https://steamcommunity.com/sharedfiles/filedetails/?id=119489135) and the directory structure below.
107
101
108
-
### Directory structure, an overview
102
+
### Directory structure - overview
109
103
110
104
The files `s0.sav` up to `s11.sav` represents structure of savegames.
If you own the registered version, you may add the `baseq2` folder files from the installation of the registered version to:
174
+
175
+
```
176
+
/home/pi/RetroPie/roms/ports/quake2/baseq2
177
+
```
178
+
179
+
### Mission Packs
180
+
181
+
#### The Reckoning
182
+
183
+
Quake II Mission Pack: The Reckoning (aka `xatrix`) is the first official Quake II Mission Pack, developed by Xatrix Entertainment and released in 1998.
184
+
185
+
Copy the `xatrix` folder contents from your mission pack installation at:
186
+
187
+
~~~
188
+
/home/pi/RetroPie/roms/ports/quake2/xatrix
189
+
~~~
190
+
191
+
Reinstall the Quake II port from the Setup Script, and a new entry - **Quake II - The Reckoning** - will be created in _Ports_.
192
+
193
+
#### Ground Zero
194
+
195
+
Quake II Mission Pack: Ground Zero (aka `rogue`) is the second official Quake II Mission Pack, developed by Rogue Entertainment and released in 1998.
196
+
197
+
Copy the `rogue` folder contents from your mission pack installation at:
198
+
199
+
~~~
200
+
/home/pi/RetroPie/roms/ports/quake2/rogue
201
+
~~~
202
+
203
+
Reinstall the Quake II port from the Setup Script, and a new entry - **Quake II - Ground Zero** - will be created in _Ports_.
0 commit comments