Clarify SDL stuff in the README, mention vsync bug with SDL 1.2

This commit is contained in:
Yamagi Burmeister 2013-10-12 12:23:15 +02:00
parent 82f3fa84a9
commit bffc43ea53

30
README
View file

@ -147,7 +147,7 @@ it'll lead to the loss of features):
- libogg with development headers - libogg with development headers
- libvorbis with development headers - libvorbis with development headers
- OpenAL with development headers - OpenAL with development headers
- SDL with development headers and sdl-config(1) - SDL 1.2 or 2.0 with development headers and sdl-config(1)
- ZLib - ZLib
Extract the source, change into the new created directory and type "make" Extract the source, change into the new created directory and type "make"
@ -156,7 +156,6 @@ following files from "release/" to your installation directory preserving the
directory structure: directory structure:
- q2ded - q2ded
- quake2 - quake2
- ref_gl.so
- baseq2/game.so - baseq2/game.so
1.6 Default Configuration 1.6 Default Configuration
@ -242,7 +241,7 @@ use the github version or want to develop on Windows. If you really want to
compile Yamagi Quake II by yourself follow these steps: compile Yamagi Quake II by yourself follow these steps:
1. Grab a copy of Nuwens MinGW distribution from http://nuwen.net/mingw.html 1. Grab a copy of Nuwens MinGW distribution from http://nuwen.net/mingw.html
Our code is tested with version 9.0, newer version may work but we can not Our code is tested with version 11.0, newer version may work but we can not
guarantee that. Extract the distribution to a directory of your choice. guarantee that. Extract the distribution to a directory of your choice.
2. Grab a copy of OpenAL Soft from http://kcat.strangesoft.net/openal.html 2. Grab a copy of OpenAL Soft from http://kcat.strangesoft.net/openal.html
(the binary release for Windows). Our code is tested with version 1.14. (the binary release for Windows). Our code is tested with version 1.14.
@ -256,14 +255,12 @@ After compiling, copy the following files from "release\" to your Quake II
installation preserving the directory structure: installation preserving the directory structure:
- q2ded.exe - q2ded.exe
- quake2.exe - quake2.exe
- ref_gl.dll
- baseq2\game.dll - baseq2\game.dll
You'll need a "openal32.dll" and an "SDL.dll" next to "quake2.exe". You can use You'll need a "openal32.dll. You can use and rename the OpenAL DLL that
and rename the OpenAL DLL that came with OpenAL Soft. We recommend to use a came with OpenAL Soft. Known to be good DLLs can be found in the
"SDL.dll" from http://libsdl.org and not the one supplied with Nuwens MinGW stuff/win32-libs directory of the source code distribution. The supplied
distribution. Known to be good DLLs can be found in the stuff/win32-libs SDL.dll is an SDL 1.2 build, required if you're still using SDL 1.2.
directory of the source code distribution.
2.7 Default Configuration 2.7 Default Configuration
------------------------- -------------------------
@ -375,8 +372,9 @@ Now you are ready to start your brand new Quake II. Have fun.
====================== ======================
Since most modern CD-ROM and DVD drives don't have an analog audio output and 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 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 use CD audio as background music on such systems. With SDL 2.0 CD audio is
support has been added to Yamagi Quake II. unsupported Therefore OGG/Vorbis music support has been added to Yamagi Quake
II.
4.1 Setup for the original soundtrack: 4.1 Setup for the original soundtrack:
-------------------------------------- --------------------------------------
@ -649,9 +647,7 @@ My SDL sound is not working!
Does the sound work in other SDL games? Does your setup support at least five Does the sound work in other SDL games? Does your setup support at least five
virtual channels? In most cases it's better to not use sound servers like virtual channels? In most cases it's better to not use sound servers like
Pulseaudio but the plain sound system like OSS or ALSA with libasound instead. Pulseaudio but the plain sound system like OSS or ALSA with libasound instead.
Also see the "Sound" section in this file! On Windows the SDL sound backend Also see the "Sound" section in this file!
may not work on all installations. This is due to a limitation of SDL. Use
OpenAL instead.
My OpenGL is not working! My OpenGL is not working!
- Make sure, that OpenGL is working in other games. Use "glxinfo" and - Make sure, that OpenGL is working in other games. Use "glxinfo" and
@ -699,7 +695,7 @@ that, so that Quake II behaves like a normal window?
Hey, my screensaver crashes Quake II or I experience strange crashes after a Hey, my screensaver crashes Quake II or I experience strange crashes after a
fixed amount of time! fixed amount of time!
- This is a known bug in some linux distributions. SDL fails to disable - This is a known bug in some linux distributions. SDL 1.2 fails to disable
the screensaver even if we tell him to do so. See this Ubuntu bugreport: the screensaver even if we tell him to do so. See this Ubuntu bugreport:
https://bugs.launchpad.net/ubuntu/+source/gnome-screensaver/+bug/32457 https://bugs.launchpad.net/ubuntu/+source/gnome-screensaver/+bug/32457
As a work around use the startscript in stuff/quake-start.sh It deactivates As a work around use the startscript in stuff/quake-start.sh It deactivates
@ -794,4 +790,8 @@ Why is the FOV different than in id Softwares client?
Why doesn't gl_showtris work? Why doesn't gl_showtris work?
- gl_showtris requires gl_ext_multitexturing set to 0. - gl_showtris requires gl_ext_multitexturing set to 0.
How do I disable the vsync?
- Set gl_swapinterval to 0 and type vid_restart. Beware that this may
not work with SDL 1.2 due to bugs in SDL.
============================================================================== ==============================================================================