OS X installation instructions

This commit is contained in:
Yamagi Burmeister 2012-10-06 09:35:16 +02:00
parent a79b705c13
commit 915e5ff716
1 changed files with 103 additions and 29 deletions

132
README
View File

@ -24,7 +24,7 @@ file for further information.
Content of this file:
--------------------
1. Installation on (Free)BSD and Linux
1. Installation on (Free|Open)BSD and Linux
1.1 Supported Systems
1.2 Retail Version
1.3 Demo Version
@ -41,27 +41,34 @@ Content of this file:
2.6 Compiling
2.7 Default Configuration
3. OGG/Vorbis playback
3.1 Setup for the original soundtrack
3.2 Setup for other music and playlists
3.3 Manual control
3.4 Console variables
3. Installation on OS X
3.1 Supported Systems
3.2 Retail Version
3.3 Demo Version
3.4 Addons
3.5 Binary Installation
4. Configuration
4.1 Video
4.2 Input
4.3 Sound
4.3.1 The classic sound system
4.3.2 The OpenAL sound system
4. OGG/Vorbis playback
4.1 Setup for the original soundtrack
4.2 Setup for other music and playlists
4.3 Manual control
4.4 Console variables
5. Bugreports
5. Configuration
5.1 Video
5.2 Input
5.3 Sound
5.3.1 The classic sound system
5.3.2 The OpenAL sound system
6. FAQ
6. Bugreports
7. FAQ
===============================================================================
1. Installation on (Free)BSD and Linux
=======================================
1. Installation on (Free|Open)BSD and Linux
===========================================
Note: If you're using Debian Linux or a derived distribution like Ubuntu, you
probably want to use the packages that are linked in the Download section at
http://www.yamagi.org/quake2/debian.html They'll even assist you in installing
@ -264,14 +271,77 @@ Now you are ready to start your brand new Quake II. Have fun.
===============================================================================
3. OGG/Vorbis playback
3. Installation on OS X
=======================
Yamagi Quake II has full support for Microsoft Windows. All features are
supported, including the IPv6 network code and the OpenAL sound backend.
Installation can be done by using the binary release (this is highly
recommended) or by compiling the source.
3.1 Supported Systems
---------------------
Yamagi Quake II should run on every Mac with Intel CPU and OS X 10.6
or higher.
3.2 Retail Version
------------------
If you own Quake II, first get the official point release to Quake II 3.20:
ftp://ftp.idsoftware.com/idstuff/quake2/q2-3.20-x86-full-ctf.exe
Use this and only this file! Unofficial pointreleases or something like
that will not work and may crash your game!
Extract the file into a new directory (we recommend quake2\) and remove
the following files and directories:
- 3.20_Changes.txt
- quake2.exe
- ref_gl.dll
- ref_soft.dll
- baseq2\gamex86.dll
- baseq2\maps.lst
- ctf\ctf2.ico
- ctf\gamex86.dll
- ctf\readme.txt
- ctf\server.cfg
- xatrix\gamex86.dll
- rogue\gamex86.dll
Now put the Quake II CD-ROM into your cd drive and cancel the installtion.
Copy "pak0.pak" and the directory "video\" to the "baseq2\" directory of your
installation.
3.3 Demo Version
----------------
If you haven't got Quake II, try the demo version. Get it here:
ftp://ftp.idsoftware.com/idstuff/quake2/q2-314-demo-x86.exe
Extract this file into a new directory and delete everything but
"baseq2\pak0.pak" and the "baseq2\players\" directory. No patching
is needed for the demo, in fact it would break it.
3.4 Addons
----------
The addons are currently unsupported on OS X. The build but are crashing
as soon as a map is loaded. Patches are welcome.
3.5 Binary Installation
-----------------------
We highly recommend, that you use our binary release of Yamagi Quake 2.
Extract the zip archive and right click on the app. Select "Show Contents",
a new finder window will open. Navigate to Contents/Resources/baseq2 and
copy the contents of the baseq2/ folder (created while preparing the game
data, see above) into it. Close the finder windows. Yamagi Quake II is
now ready.
===============================================================================
4. OGG/Vorbis playback
======================
Since most modern CD-ROM and DVD drives don't have an analog audio output and
most sound codecs don't have the appropriate input header, it's not possible to
use CD audio as background music on such systems. Therefore OGG/Vorbis music
support has been added to Yamagi Quake II.
3.1 Setup for the original soundtrack:
4.1 Setup for the original soundtrack:
--------------------------------------
Put your Quake II CD-ROM into your drive, start your favorite CD extractor and
rip the audiotracks into OGG/Vorbis files. These files must be named after their
@ -284,7 +354,7 @@ Drop these files in "baseq2/music/", start Quake II, enter the "Options" menu
and set "OGG music" to enabled. "CD music" will be automaticly disabled.
Quake II will now play the OGG/Vorbis files instead of the Audio-CD.
3.2 Setup for other music and playlists:
4.2 Setup for other music and playlists:
----------------------------------------
You can put any OGG/Vorbis files into "baseq2/music/" or "your_mod/music/".
If shuffle is enabled, Quake II will shuffle through all files, otherwise it
@ -292,7 +362,7 @@ will loop through the track associated with the map.
A playlist is also supported. Just put the filenames into music/playlist
(a plain text file) and start the game.
3.3 Manual control:
4.3 Manual control:
-------------------
For manual control of ogg playback the following console commands are available:
@ -325,7 +395,7 @@ For manual control of ogg playback the following console commands are available:
- ogg_status
Display status ("playing a file", "paused", "stopped", etc).
3.4 Console variables:
4.4 Console variables:
----------------------
- ogg_enable {0 | 1}
Enables the Ogg Vorbis subsystem if set to "1". Defaults to "0".
@ -349,13 +419,13 @@ For manual control of ogg playback the following console commands are available:
===============================================================================
4. Configuration
5. Configuration
================
While configuring Quake II is straight forward some rough edges can arise.
Before reporting bugs or mailing us please read this section all the hints
covered in it!
4.1 Video
5.1 Video
---------
For most people the options in the "Video" menu are sufficent. But there
are some things that can and in some cases must be tuned via cvars. Here
@ -416,7 +486,7 @@ the most common questions are answered.
"vid_restart" aftwards.
4.2 Input
5.2 Input
---------
Quake II had a rather simple input system, even back in 1997. It just mapped
Windows 95 mouse directly on movements. That was a very acurate way to do it,
@ -446,7 +516,7 @@ There are some cvar to adjust:
impossible to add modern acceleration to Quake II since most of the needed data
isn't available to the input backend.
4.3 Sound
5.3 Sound
---------
Quake II featured one of the best sound systems of it's time (for example it had
support for realtime calculated stereo effects) but sadly it was totaly broken.
@ -459,7 +529,7 @@ scratch. This should solve most if not all problems. Yamagi Quake II 4.20
featured an optional OpenAL sound system, enabling better stereo calculations
and even surround support.
4.3.1 The classic sound system
5.3.1 The classic sound system
------------------------------
This is the original sound implementation, as used in the first release of Quake
II in 1997. It featured stereo calculations for most samples. It's disabled by
@ -489,7 +559,7 @@ default and can be reenables by setting "s_openal" to "0", followed by
card 0
}
4.3.2 The OpenAL sound system
5.3.2 The OpenAL sound system
-----------------------------
This is a sound system based upon the popular OpenAL audio library. It features
surround playback which gives a huge improvement in sound quality and gameplay
@ -513,7 +583,7 @@ vary). The most important options (tested with OpenAL Soft 1.14) are:
===============================================================================
5. Bugreports
6. Bugreports
=============
Something is not working as expected? An elevator is broken? An enemy doesn't
move? Or the whole game is just crashing? Just open a new github issue at
@ -552,7 +622,7 @@ Valgrind reports many, many memory leaks!
===============================================================================
6. FAQ
7. FAQ
======
How do I open the console?
@ -657,4 +727,8 @@ What is yq2.cfg for?
decisions in the original defaults.cfg. Please do not alter it,
unless you know what you're doing! It may beak the game!
Why isn't there an "underwater sound effect" when playing under OS X?
- That's a limitation of OS X. Apples OpenAL implementation doesn't
support sound effects.
==============================================================================