# QuakeGX - 2008/06/13

## Requirements

- A Wii.
- Twilight Hack, The Homebrew Channel or some other way of running programs from SD Card.

## Release Notes for version 0.01

- To correctly see the transparent water without artifacts, please apply Vispatch to your pak0.pak (and pak1.pak, if you have the full version) file.
- This is an early release. I am not currently able to solve the freezing bug until my USBGecko arrives. International mail is SLOW, so please be patient. :)
- Be sure to read the "Installation" section for info regarding the different Wiimote button mappings.
- If you notice a split-second freezing, quickly save you progress and quit the game, then reload it. At least it warns before freezing. :D

## Installation

1. Note: If you have a version released before 13th June 2008 installed, remove ID1/CONFIG.CFG from your SD Card. This is necessary because the button naming for the Wiimote has changed, and deleting ID1/CONFIG.CFG will make the new defaults with the new button names be used.
2. Copy the ID1 folder to the root of your SD Card.
3. Copy Quake's PAK0.PAK (and PAK1.PAK if you own the full version) into the ID1 folder on your SD Card.
4. Insert the SD Card into the Wii front SD slot.
5. Launch QuakeGX.dol using your method of choice.

## Credits

- Original game by id Software.
- GameCube conversion by Peter Mackay.
- GameCube version testing by eke, org and plootid.
- Wii version and GX graphics acceleration by Eluan Miranda

## General notes

- You can freely change button bindings on the Wiimote without affecting the GC pad bindings, except for the D-Pad on both controllers and Start/Plus. These are paired and changing one's binding will change the other
- There is still no music support, but expect it for future releases. (Probably you will have to rip your original quake music from your CD.)
- There is a new menu option for adjusting the size of the screen to adjust for your TV's overscan. (Does not work with the GX accelerated version yet.)

## Software rendering notes

- All of the original dosquake rendering features are supported.
- Unfortunately, the original palette is converted from RGB8 to RGB565. The best way to correct this is writing a full 24-bit software renderer, but don't expect it soon.
- Framerate may be a bit choppy and there is still no support for going back to the old 320x200 resolution.
- Software rendering is only available through svn.

## Hardware rendering notes

- Full speed, fully implemented GX port of the original glquake, with some new features being added gradually.
- Supports all of the original glquake features: dynamic lightmaps, water transparency, and more.
- To make the water correctly transparent, you will need water-vised maps.

## Default controls

- Gamecube PAD

- Attack: R
- Jump: A
- Run/Walk: L
- Previous Weapon: D-Pad Left or Y
- Next Weapon: D-Pad Right or X
- Swim Up: D-Pad Up
- Swim Down: D-Pad Down
- Pause/Menu: Start/Pause
- Select (in menu): A
- Back (in menu): B

- Wiimote

- Attack: B
- Jump: A
- Run/Walk: C
- Previous Weapon: D-Pad Left
- Next Weapon: D-Pad Right
- Swim Up: D-Pad Up
- Swim Down: D-Pad Down
- Pause/Menu: Plus
- Select (in menu): A
- Back (in menu): B

## Contact

You can report bugs or suggestions using the project's issue tracker. Please make sure to check the existing issues before adding new ones. By default only open issues are shown, you will have to select "All Issues" in the search field to see if your issue has already been fixed on svn.

Be sure to keep checking the Google project page for new versions and other info. :)

## Source code

The original Quake code was released under the GNU General Public License (GPL). This port's source code is available at the Google project page.