Permalink
Browse files

Updated documentation and default configuration file.

  • Loading branch information...
1 parent 056e2a3 commit a07e3a605a9f1765b5950da5271df33653245c6b @reefab committed Jul 3, 2012
Showing with 13 additions and 11 deletions.
  1. +12 −10 README.md
  2. +1 −1 stuff/yq2.cfg
View
@@ -6,10 +6,9 @@ This is a port of the [1997 id Software Game](http://en.wikipedia.org/wiki/Quake
From Wikipedia:
-> The Raspberry Pi has a Broadcom BCM2835 system on a chip (SoC),[3] which includes an ARM1176JZF-S 700 MHz processor, VideoCore IV GPU,[9] and 256 megabytes of RAM. It does not include a built-in hard disk or solid-state drive, but uses a SD card for booting and long-term storage.
+> The Raspberry Pi has a Broadcom BCM2835 system on a chip (SoC), which includes an ARM1176JZF-S 700 MHz processor, VideoCore IV GPU, and 256 megabytes of RAM. It does not include a built-in hard disk or solid-state drive, but uses a SD card for booting and long-term storage.
-This is based of the [Yamagi Quake 2 port](http://www.yamagi.org/quake2/), more
-precisely, the OpenGL ES branch.
+This is based of the [Yamagi Quake 2 port](http://www.yamagi.org/quake2/), more precisely, the OpenGL ES branch.
## In Action
@@ -19,9 +18,14 @@ precisely, the OpenGL ES branch.
## Current State
-Mostly playable but some graphical effects had to be disabled.
-The sound is also disabled by default.
+The demo version is playable but some graphical effects had to be disabled.
+## Caveats
+
+Using the full version data files seems to cause hangs and as such is not recommended yet.
+
+The sound is disabled by default due to issues in the ALSA drivers. You can reactivate it by commenting the `set s_initsound 0` line in the `yq2.cfg`.
+You'll want to upgrade from the default firmware/kernel included in the initial public beta release of the Debian Wheezy image using [rpi-update](https://github.com/Hexxeh/rpi-update/).
## Installation
@@ -39,14 +43,12 @@ The sound is also disabled by default.
* zlib1g-dev
* libjpeg8-dev
-Follow the instructions from [the original README](https://github.com/reefab/yquake2/blob/raspberry/README)
-to build and install.
+Follow the instructions from [the original README](https://github.com/reefab/yquake2/blob/raspberry/README) to build and install.
-## Notes
+### Notes
You can get the demo files from [Fileplanet](http://www.fileplanet.com/6584/0/fileinfo/Quake-2-Demo-v3.14)
The game should be launched as root in the console.
-You might want to copy the `stuff/yq2.cfg` to the `baseq2` directory where you
-installed the game to get sane settings for the Raspberry PI.
+You should also copy the `stuff/yq2.cfg` to the `baseq2` directory where you installed the game to get sane settings for the Raspberry PI.
View
@@ -72,6 +72,6 @@ set freelook 1
set ogg_enable 0
set cd_nocd 0
set s_initsound 0
+set r_shadows 0
set gl_shadows 0
-set gl_flashblend 0
set gl_dynamic 0

0 comments on commit a07e3a6

Please sign in to comment.