Quake Rev PAK Wii: Difference between revisions

Quake Rev PAK
Quake Rev PAK
General
Author	Izhido, niuus
Type	Game engine
Version	r4
License	Mixed
Last Updated	2023/01/22
Links
	Download
	Website
	Source

Revision as of 08:16, 8 March 2023

A collection of gaming engines, related to the Quake series of games by id Software, modified to run on the Nintendo Wii, using the popular devkitPPC toolchain for homebrew development.

The provided launcher will start the following games:

Quake (using the Q1Rev engine).
Quake Mission Pack No. 1: Scourge of Armagon.
Quake Mission Pack No. 2: Dissolution of Eternity.
QuakeWorld (using the QWRev engine).
Quake II (using the Q2Rev engine).
Quake II Mission Pack: The Reckoning.
Quake II Mission Pack: Ground Zero.
Quake II Threewave Capture The Flag (using the Q2CTFRev engine).

Installation

Extract the downloaded file into the Apps folder in the root of your SD card.

The shareware version is included (PAK0.PAK) if you don't own the full version. If you own the full version, the PAK files are inside Quake's ID1 folder on your computer.

Base Quake game - Copy the PAK0.PAK (and PAK1.PAK for the full version) to "/apps/QRevPAK/Q1/id1" on your SD card.
QuakeWorld - Copy the PAK0.PAK and PAK1.PAK files to "/apps/QRevPAK/Q1/id1" on your SD card.
Quake Mission Pack 1: Scourge of Armagon - Copy the PAK0.PAK file to "apps/QRevPAK/Q1/hipnotic" on your SD card.
Quake Mission Pack 2: Dissolution of Eternity - Copy the PAK0.PAK file to "apps/QRevPAK/Q1/rogue" on your SD card.
Base Quake II game - Copy the PAK0.PAK file to "apps/QRevPAK/Q2/baseq2" on your SD card.
Quake II ThreeWave Capture the Flag - Copy the PAK0.PAK file to "apps/QRevPAK/Q2/baseq2" on your SD card.
Quake II Mission Pack: The Reckoning - Copy the PAK0.PAK file to "apps/QRevPAK/Q2/xatrix" on your SD card.
Quake II Mission Pack: Ground Zero - Copy the PAK0.PAK file to "apps/QRevPAK/Q2/rogue" on your SD card.

You're now ready to open the game on The Homebrew Channel menu.

Notes

Only the Wiimote can be used to start any of the games. After the game has loaded, you can use other controllers.
Takes some time on a black screen when you pick any game to start (40 seconds approximately).
The game can lock you out of the controller when customizing the controls, so do not to use A, B, ZL, or the D-pad directions when remapping.
May hang if you start a New Game after playing.

QRevPAK.xml

You can specify the game to launch based on the data provided by the accompanying QRevPAK.xml file. This contains all the info required to launch a particular game, including:

Name.
Description.
Engine .dol / .elf filename.
Arguments that are passed to the engine (as if they were passed on a command line).

By modifying QRevPAK.xml, you can add new engines, or alter the way the engines are launched; this can be really useful if you have mods that you would like to play using Quake Rev PAK, or to improve the existing ones.

The archive does not provide a QRevPAK.xml file. If it's not present when you start Quake Rev PAK, the file will be created for you. Future releases might modify your current QRevPAK.xml with new updates, preserving your customized entries if detected.

User guide

Supported Controllers:

GameCube controller.
Wiimote+Nunchuk/Wiimotion Plus+Nunchuk.
Wii Classic Controller.

Controls

GameCube Controller

D-Pad - Arrow keys

Left analog joystick - Walk

C-Stick - Look

X - 1 > 2 > 3 > 4 > 5 > 6 > 7

Y - 7 > 6 > 5 > 4 > 3 > 2 > 1

A - Intro

B - "Esc" key

Start - Pause, "y" key, "F1" key

L - Left mouse button

R - Right mouse button

Wiimote & Nunchuk

IR pointer - Look

Plus - 1 > 2 > 3 > 4 > 5 > 6 > 7

Minus - 7 > 6 > 5 > 4 > 3 > 2 > 1

A - Look mode

D-Pad - Arrow keys

B - Left mouse button

1 - Intro

2 - "Esc" key

Home - Pause, "y" key

Nunchuk:

Analog stick - Walk

C - "C" key (Q2Rev / Q2CTFRev), Enable/Disable on-screen keyboard (Q1Rev / QWRev / Q2Rev / Q2CTFRev)

Z - "Spacebar" key

Wii Classic Controller

D-Pad - Arrow keys

Left analog joystick - Walk

Right analog joystick - Look mode

X - 1 > 2 > 3 > 4 > 5 > 6 > 7

Y - 7 > 6 > 5 > 4 > 3 > 2 > 1

A - Intro

B - "Esc" key

Home - Pause, "y" key

L - Left mouse button

R - "Spacebar" key

ZL - Enable/Disable on-screen keyboard (Q1Rev / QWRev), "C" key (Q2Rev / Q2CTFRev)

ZR - Enable/Disable on-screen keyboard (Q2Rev / Q2CTFRev)

Screenshots

Media

Quake Rev PAK release 2 (Cid2Mizard)

Changelog

Release 4

New GX-accelerated builds of Q2Rev and Q2CTFRev.
Support for the official Quake and Quake II Mission Packs, now available in the Quake Rev PAK launcher.
Lots of bug fixes, including an embarrasing one where left & right sound channels were inverted (oops).
Fixed a problem with Quake II savegame files, which were not compatible between releases. Starting from Release 4, all new savegame files will work as expected.
Also starting from this release, it will be required that the game data folders be located inside folders called "Q1" and "Q2" at the engines folder level. This will help having Quake and Quake II data separated, and thus be able to play the "rogue" Mission Packs (Dissolution of Eternity, Ground Zero).

NOTICE: The config.cfg data generated by previous releases of the Q2Rev and Q2CTFRev engines might contain invalid data. It is recommended that you delete them before playing the Quake II games. The engines will recreate the config.cfg files when they are not found.

Release 3

This release introduces the first GX-accelerated builds of Q1Rev and QWRev. They run at 60fps (instead of the 30fps of the software-rendered ones), and look really gorgeous! To load them, be sure to check the new “Use GX-accelerated builds if available” option on the Quake Rev PAK launcher.

Release 2

CD music track playback is now available! Copy your Ogg Vorbis-encoded tracks from your original Quake & Quake II CDs into a \cdtracks folder inside both your \ID1 and \baseq2 folders to enjoy the original CD soundtrack of your favorite games. NOTE: Please ensure that the tracks can be sorted by name. Also, there is no need for a fake Track 1; the engine won't look for it.
Key aliases are finally out of beta! With the new "keyalias" command, accessible from the console, and remembered in config.cfg, you can map every single key in your controller(s) to any other one, so you can configure your controller to suit your needs.
Quake Rev PAK will now remember the last game you launched, and will take you to that entry upon start.
A few bugs have been corrected, including one where Quake II and related games won't operate correctly with the Wiimote-Nunchuk combo control.
Minor stability adjustments to the engines, so they use less memory, and crash a little less often. NOTE: the Quake II and related game engines still have a few issues, but they are less noticeable now.
If your game crashes, and there is a chance that the engine finds out what happened, it will now create a QRevPAK.err file in your media card, containing the date/time the crash happened, and the error message explaining what happened.
The On-Screen Keyboard now appears, in the Quake II and related game engines, only if you press the associated key for less than 0.5 seconds. Makes playing Quake II a lot easier in areas where you need to crouch.

Release 1

First public version.

External links

GitHub - https://github.com/niuus/Quake-Wii-GX/releases
GitHub - https://github.com/izhido/qrevpak
WiiBrew - https://wiibrew.org/wiki/QRevPAK

@@ Line 1: / Line 1: @@
-{{#seo:
-|title=Wii Homebrew Games (Game engine) - GameBrew
-|title_mode=append
-|image=quakerevpakwii2.jpg
-|image_alt=Quake Rev PAK
-}}
 {{Infobox Wii Homebrews
 |title=Quake Rev PAK
-|image=quakerevpakwii2.jpg
+|image=quakerevpakwii2.png
-|description=A collection of gaming engines, related to the Quake series of games, ported to the Nintendo Wii
+|description=A collection of gaming engines, related to the Quake series of games, ported to the Nintendo Wii.
 |author=Izhido, niuus
 |lastupdated=2023/01/22
@@ Line 18: / Line 12: @@
 |source=https://github.com/niuus/Quake-Wii-GX/releases
 }}
-'''Quake Rev PAK''' is a collection of gaming engines related to the Quake series by id Software, adapted for the Nintendo Wii. This modification is made possible through the use of devkitPPC, a popular toolchain for homebrew development on the Wii. This PAK allows fans of the Quake series to enjoy these classic games on their Nintendo Wii, offering a new way to experience the excitement of the legendary FPS franchise.
+A collection of gaming engines, related to the Quake series of games by id Software, modified to run on the Nintendo Wii, using the popular devkitPPC toolchain for homebrew development.
+The provided launcher will start the following games:
+* Quake (using the Q1Rev engine).
+* Quake Mission Pack No. 1: Scourge of Armagon.
+* Quake Mission Pack No. 2: Dissolution of Eternity.
+* QuakeWorld (using the QWRev engine).
+* Quake II (using the Q2Rev engine).
+* Quake II Mission Pack: The Reckoning.
+* Quake II Mission Pack: Ground Zero.
+* Quake II Threewave Capture The Flag (using the Q2CTFRev engine).
+==Installation==
+Extract the downloaded file into the Apps folder in the root of your SD card.
+The shareware version is included (PAK0.PAK) if you don't own the full version. If you own the full version, the PAK files are inside Quake's ID1 folder on your computer.
+*Base Quake game - Copy the PAK0.PAK (and PAK1.PAK for the full version) to "/apps/QRevPAK/Q1/id1" on your SD card.
+*QuakeWorld - Copy the PAK0.PAK and PAK1.PAK files to "/apps/QRevPAK/Q1/id1" on your SD card.
+*Quake Mission Pack 1: Scourge of Armagon - Copy the PAK0.PAK file to "apps/QRevPAK/Q1/hipnotic" on your SD card.
+*Quake Mission Pack 2: Dissolution of Eternity - Copy the PAK0.PAK file to "apps/QRevPAK/Q1/rogue" on your SD card.
+*Base Quake II game - Copy the PAK0.PAK file to "apps/QRevPAK/Q2/baseq2" on your SD card.
+*Quake II ThreeWave Capture the Flag - Copy the PAK0.PAK file to "apps/QRevPAK/Q2/baseq2" on your SD card.
+*Quake II Mission Pack: The Reckoning - Copy the PAK0.PAK file to "apps/QRevPAK/Q2/xatrix" on your SD card.
+*Quake II Mission Pack: Ground Zero - Copy the PAK0.PAK file to "apps/QRevPAK/Q2/rogue" on your SD card.
+You're now ready to open the game on The Homebrew Channel menu.
+===Notes===
+*Only the Wiimote can be used to start any of the games. After the game has loaded, you can use other controllers.
+*Takes some time on a black screen when you pick any game to start (40 seconds approximately).
+*The game can lock you out of the controller when customizing the controls, so do not to use A, B, ZL, or the D-pad directions when remapping.
+*May hang if you start a New Game after playing.
+===QRevPAK.xml===
+You can specify the game to launch based on the data provided by the accompanying QRevPAK.xml file. This contains all the info required to launch a particular game, including:
+*Name.
+*Description.
+*Engine .dol / .elf filename.
+*Arguments that are passed to the engine (as if they were passed on a command line).
+By modifying QRevPAK.xml, you can add new engines, or alter the way the engines are launched; this can be really useful if you have mods that you would like to play using Quake Rev PAK, or to improve the existing ones.
+The archive does not provide a QRevPAK.xml file. If it's not present when you start Quake Rev PAK, the file will be created for you. Future releases might modify your current QRevPAK.xml with new updates, preserving your customized entries if detected.
+==User guide==
+Supported Controllers:
+*GameCube controller.
+*Wiimote+Nunchuk/Wiimotion Plus+Nunchuk.
+*Wii Classic Controller.
+==Controls==
+===GameCube Controller===
+D-Pad - Arrow keys
+Left analog joystick - Walk
+C-Stick - Look
+X - 1 > 2 > 3 > 4 > 5 > 6 > 7
+Y - 7 > 6 > 5 > 4 > 3 > 2 > 1
+A - Intro
+B - "Esc" key
+Start - Pause, "y" key, "F1" key
+L - Left mouse button
+R - Right mouse button
+===Wiimote & Nunchuk===
+IR pointer - Look
+Plus - 1 > 2 > 3 > 4 > 5 > 6 > 7
-==Description==
+Minus - 7 > 6 > 5 > 4 > 3 > 2 > 1
-Quake Rev PAK is a comprehensive collection of gaming engines related to the popular Quake series, adapted to run on the Nintendo Wii.
-The provided launcher allows players to start a variety of games, including: Quake, Quake Mission Pack No. 1: Scourge of Armagon, Quake Mission Pack No. 2: Dissolution of Eternity, QuakeWorld, Quake II, Quake II Mission Pack: The Reckoning, Quake II Mission Pack: Ground Zero, and Quake II Threewave Capture The Flag.
+A - Look mode
-The launcher is able to start these games using the data provided in the accompanying QRevPAK.xml file. This file contains all the information required to launch a specific game, including the name, description, engine .dol/.elf filename, and the arguments passed to the engine, as if they were passed on a command line. By modifying the QRevPAK.xml file, players can add new engines or alter the way existing engines are launched, which can be useful for playing mods or improving the existing games.
+D-Pad - Arrow keys
-If the QRevPAK.xml file is not present when the launcher is started, the file will be created for the player. Future releases of the PAK may modify the current QRevPAK.xml with updates, preserving any custom entries that are detected. This allows players to continually enjoy the latest updates and improvements to the collection.
+B - Left mouse button
-==Installation==
+- Intro
-. Extract the downloaded file into the Apps folder at the root of your SD card.
+- "Esc" key
+Home - Pause, "y" key
+'''Nunchuk:'''
+Analog stick - Walk
+C - "C" key (Q2Rev / Q2CTFRev), Enable/Disable on-screen keyboard (Q1Rev / QWRev / Q2Rev / Q2CTFRev)
+Z - "Spacebar" key
+===Wii Classic Controller===
+D-Pad - Arrow keys
+Left analog joystick - Walk
+Right analog joystick - Look mode
+X - 1 > 2 > 3 > 4 > 5 > 6 > 7
+Y - 7 > 6 > 5 > 4 > 3 > 2 > 1
+A - Intro
-. If you don't have the full version, download the shareware version ([https://github.com/niuus/Quake-Wii-GX/releases/download/WIP/Quake_shareware.zip Quake_shareware.zip]) which includes the PAK0.PAK file. If you own the full version, the PAK files can be found in the ID1 folder of your Quake game on your computer.
+B - "Esc" key
-. Copy the PAK0.PAK (and PAK1.PAK if you have the full version) file to the following locations for each respective game:
+Home - Pause, "y" key
-* Base Quake: "/apps/QRevPAK/Q1/id1"
+L - Left mouse button
-* QuakeWorld: "/apps/QRevPAK/Q1/id1"
-* Quake Mission Pack 1: Scourge of Armagon: "/apps/QRevPAK/Q1/hipnotic"
-* Quake Mission Pack 2: Dissolution of Eternity: "/apps/QRevPAK/Q1/rogue"
-* Base Quake II: "/apps/QRevPAK/Q2/baseq2"
-* Quake II ThreeWave Capture the Flag: "/apps/QRevPAK/Q2/baseq2"
-* Quake II Mission Pack: The Reckoning: "/apps/QRevPAK/Q2/xatrix"
-* Quake II Mission Pack: Ground Zero: "/apps/QRevPAK/Q2/rogue"
-* Launch the game from the Homebrew Channel menu.
-'''Notes:'''
+R - "Spacebar" key
-* Only the Wiimote can be used to start the games. Once the game has loaded, you can use other controllers.
-* There may be a 40-second wait on a black screen when selecting a game.
-* Avoid using A, B, ZL, or the D-pad directions when customizing controls, as the game may lock you out of the controller.
-* The game may hang if starting a New Game after playing.
-==Media==
+ZL - Enable/Disable on-screen keyboard (Q1Rev / QWRev), "C" key (Q2Rev / Q2CTFRev)
-'''Quake Rev PAK release 2 - ([https://www.youtube.com/watch?v=d2x9o0k50us Cid2Mizard])'''<br>
-<youtube>d2x9o0k50us</youtube>
-== Supported Controllers ==
+ZR - Enable/Disable on-screen keyboard (Q2Rev / Q2CTFRev)
-=== Gamecube controller. ===
-'''D-pad:''' arrow keys<br />
-'''Left analog joystick:''' walk<br />
-'''C-Stick:''' look<br />
-'''X button:''' 1 -&gt; 2 -&gt; 3 -&gt; 4 -&gt; 5 --&gt; 6 --&gt; 7<br />
-'''Y button:''' 7 -&gt; 6 -&gt; 5 -&gt; 4 -&gt; 3 -&gt; 2 -&gt; 1<br />
-'''A button:''' intro<br />
-'''B button:''' &quot;Esc&quot; key<br />
-'''Start button:''' Pause / &quot;y&quot; key / &quot;F1&quot; key<br />
-'''L button:''' Left mouse button<br />
-'''R button:''' Right mouse button
-=== Wiimote+Nunchuk / Wiimotion Plus+Nunchuk. ===
+==Screenshots==
-'''IR pointer:''' look<br />
+https://dlhb.gamebrew.org/wiihomebrews/quakerevpakwii3.png
-'''Plus (+) button:''' 1 -&gt; 2 -&gt; 3 -&gt; 4 -&gt; 5 --&gt; 6 --&gt; 7<br />
+https://dlhb.gamebrew.org/wiihomebrews/quakerevpakwii4.png
-'''Minus (-) button:''' 7 -&gt; 6 -&gt; 5 -&gt; 4 -&gt; 3 -&gt; 2 -&gt; 1<br />
-'''A button:''' look mode<br />
-'''D-pad:''' arrow keys<br />
-'''B button:''' Left mouse button<br />
-'''1 button:''' Intro<br />
-'''2 button:''' &quot;Esc&quot; key<br />
-'''HOME button:''' Pause / &quot;y&quot; key
-=== Nunchuk. ===
+https://dlhb.gamebrew.org/wiihomebrews/quakerevpakwii5.png
-'''Analog stick:''' walk<br />
+https://dlhb.gamebrew.org/wiihomebrews/quakerevpakwii6.png
-'''C button:''' &quot;C&quot; key (Q2Rev / Q2CTFRev). Enable/Disable on-screen keyboard (Q1Rev / QWRev / Q2Rev / Q2CTFRev)<br />
-'''Z button:''' &quot;Spacebar&quot; key
-=== Wii Classic Controller. ===
+==Media==
-'''D-pad:''' arrow keys<br />
+'''Quake Rev PAK release 2 ([https://www.youtube.com/watch?v=d2x9o0k50us Cid2Mizard])'''<br>
-'''Left analog joystick:''' walk<br />
+<youtube>d2x9o0k50us</youtube>
-'''Right analog joystick:''' look mode<br />
-'''X button:''' 1 -&gt; 2 -&gt; 3 -&gt; 4 -&gt; 5 --&gt; 6 --&gt; 7<br />
-'''Y button:''' 7 -&gt; 6 -&gt; 5 -&gt; 4 -&gt; 3 -&gt; 2 -&gt; 1<br />
-'''A button:''' Intro<br />
-'''B button:''' &quot;Esc&quot; key<br />
-'''HOME button:''' Pause / &quot;y&quot; key<br />
-'''L button:''' Left mouse button<br />
-'''R button:''' &quot;Spacebar&quot; key<br />
-'''ZL button:''' Enable/Disable on-screen keyboard (Q1Rev / QWRev). &quot;C&quot; key (Q2Rev / Q2CTFRev)<br />
-'''ZR button:''' Enable/Disable on-screen keyboard (Q2Rev / Q2CTFRev).
 == Changelog ==
-'''''Release 4'''''
+'''Release 4'''
 * New GX-accelerated builds of Q2Rev and Q2CTFRev.
 * Support for the official Quake and Quake II Mission Packs, now available in the Quake Rev PAK launcher.
-* Lots of bug fixes, including an embarrasing one where left &amp; right sound channels were inverted (oops!)
+* Lots of bug fixes, including an embarrasing one where left &amp; right sound channels were inverted (oops).
 * Fixed a problem with Quake II savegame files, which were not compatible between releases. Starting from Release 4, all new savegame files will work as expected.
 * Also starting from this release, it will be required that the game data folders be located inside folders called &quot;Q1&quot; and &quot;Q2&quot; at the engines folder level. This will help having Quake and Quake II data separated, and thus be able to play the &quot;rogue&quot; Mission Packs (Dissolution of Eternity, Ground Zero).
@@ Line 109: / Line 159: @@
 NOTICE: The config.cfg data generated by previous releases of the Q2Rev and Q2CTFRev engines might contain invalid data. It is recommended that you delete them before playing the Quake II games. The engines will recreate the config.cfg files when they are not found.
-'''''Release 3'''''
+'''Release 3'''
 * This release introduces the first GX-accelerated builds of Q1Rev and QWRev. They run at 60fps (instead of the 30fps of the software-rendered ones), and look really gorgeous! To load them, be sure to check the new “Use GX-accelerated builds if available” option on the Quake Rev PAK launcher.
-'''''Release 2'''''
+'''Release 2'''
 * CD music track playback is now available! Copy your Ogg Vorbis-encoded tracks from your original Quake &amp; Quake II CDs into a \cdtracks folder inside both your \ID1 and \baseq2 folders to enjoy the original CD soundtrack of your favorite games. NOTE: Please ensure that the tracks can be sorted by name. Also, there is no need for a fake Track 1; the engine won't look for it.
 * Key aliases are finally out of beta! With the new &quot;keyalias&quot; command, accessible from the console, and remembered in config.cfg, you can map every single key in your controller(s) to any other one, so you can configure your controller to suit your needs.
@@ Line 119: / Line 169: @@
 * Minor stability adjustments to the engines, so they use less memory, and crash a little less often. NOTE: the Quake II and related game engines still have a few issues, but they are less noticeable now.
 * If your game crashes, and there is a chance that the engine finds out what happened, it will now create a QRevPAK.err file in your media card, containing the date/time the crash happened, and the error message explaining what happened.
-* The On-Screen Keyboard now appears, in the Quake II and related game engines, '''only''' if you press the associated key for less than 0.5 seconds. Makes playing Quake II a lot easier in areas where you need to crouch.
+* The On-Screen Keyboard now appears, in the Quake II and related game engines, only if you press the associated key for less than 0.5 seconds. Makes playing Quake II a lot easier in areas where you need to crouch.
-'''''Release 1'''''
+'''Release 1'''
 * First public version.
 ==External links==
-* Github (niuus) - https://github.com/niuus/Quake-Wii-GX/releases
+* GitHub - https://github.com/niuus/Quake-Wii-GX/releases
-* Github - https://github.com/izhido/qrevpak
+* GitHub - https://github.com/izhido/qrevpak
-* Wiibrew - https://wiibrew.org/wiki/QRevPAK
+* WiiBrew - https://wiibrew.org/wiki/QRevPAK