Trivial doco updates

git-svn-id: svn://svn.code.sf.net/p/quakespasm/code/trunk/quakespasm@429 af15c1b1-3010-417e-b628-4374ebc0bcbd
This commit is contained in:
Steven 2011-03-05 10:20:00 +00:00
parent 305be5e835
commit fd0fe9aa89
2 changed files with 26 additions and 15 deletions

View file

@ -13,7 +13,7 @@ USE_QS_CONBACK=1
### Enable/Disable codecs for streaming music support ### Enable/Disable codecs for streaming music support
# #
# OGG (vorbis) playback requires libvorbis and libogg # OGG (vorbis) playback requires libvorbis and libogg
# MP3 playback requires libmad # MP3 playback requires libmad or libmpg123
USE_CODEC_WAVE=1 USE_CODEC_WAVE=1
USE_CODEC_MP3=1 USE_CODEC_MP3=1

View file

@ -4,6 +4,7 @@
Table of Contents Table of Contents
1. About 1. About
2. Downloads 2. Downloads
3. Hints 3. Hints
@ -19,6 +20,7 @@
6. Todo 6. Todo
7. Links 7. Links
______________________________________________________________________ ______________________________________________________________________
@ -27,6 +29,7 @@
1. About 1. About
QuakeSpasm is a Quake 1 engine based on the SDL port of FitzQuake. It QuakeSpasm is a Quake 1 engine based on the SDL port of FitzQuake. It
includes 64bit CPU support, a new sound driver, several networking includes 64bit CPU support, a new sound driver, several networking
fixes and a few graphical niceities. fixes and a few graphical niceities.
@ -36,32 +39,32 @@
2. Downloads 2. Downloads
Source Source
<http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.4.tgz/download> <http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.4.tgz/download>
Linux (x86) Linux (x86)
<http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.4_linux.tgz/download> <http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.4_linux.tgz/download>
Windows (x86) Windows (x86)
<http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.4_windows.zip/download> <http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.4_windows.zip/download>
OSX universal binary OSX universal binary
<http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.4_osx.zip/download> <http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.4_osx.zip/download>
3. Hints 3. Hints
Visit the FitzQuake Homepage <http://www.celephais.net/fitzquake> for Visit the FitzQuake Homepage <http://www.celephais.net/fitzquake> for
a full run-down of the engine's commands and variables. a full run-down of the engine's commands and variables.
o To disable some changes, use "quakespasm -fitz" o To disable some changes, use "quakespasm -fitz"
o For different sound drivers use "SDL_AUDIODRIVER=DRIVER o For different sound drivers use "SDL_AUDIODRIVER=DRIVER
./quakespasm" , where DRIVER may be alsa, dsp, pulse, esd ... ./quakespasm" , where DRIVER may be alsa, dsp, pulse, esd ...
o Shift+Escape draws the Console. o Shift+Escape draws the Console.
o From the console, use UP to browse the command line history and o From the console, use UP to browse the command line history and TAB
TAB to autocomplete command and map names. to autocomplete command and map names.
o There is currently no CD Music volume support. cd_sdl.c needs o There is currently no CD Music volume support. cd_sdl.c needs
replacing with cd_linux.c, cd_bsd.c etc.. replacing with cd_linux.c, cd_bsd.c etc..
@ -90,11 +93,13 @@
After extracting the source tarball, browse the Makefile and edit the After extracting the source tarball, browse the Makefile and edit the
music streaming options, then music streaming options, then
______________________________________________________________________ ______________________________________________________________________
make make
cp quakespasm /usr/local/games/quake (for example) cp quakespasm /usr/local/games/quake (for example)
______________________________________________________________________ ______________________________________________________________________
Compile time options include Compile time options include
o make DEBUG=1 for debugging o make DEBUG=1 for debugging
@ -109,14 +114,15 @@
HOME directory support can be enabled via Misc/homedir_0.patch HOME directory support can be enabled via Misc/homedir_0.patch
The project can also be built with Codeblocks (project files included). The project can also be built with Codeblocks (project files
included)..
5. Changes 5. Changes
5.1. 0.85.4 5.1. 0.85.4
o Implement music (OGG, MP3, WAV) playback o Implement music (OGG, MP3, WAV) playback
o A better fix for the infamous SV_TouchLinks problem, no more hard o A better fix for the infamous SV_TouchLinks problem, no more hard
@ -142,9 +148,9 @@
o Other minor sound and cdaudio updates o Other minor sound and cdaudio updates
5.2. 0.85.3 5.2. 0.85.3
o Fix the "-dedicated" option (thanks Oz) and add platform specific o Fix the "-dedicated" option (thanks Oz) and add platform specific
networking code (default) rather than SDL_net networking code (default) rather than SDL_net
@ -182,6 +188,7 @@
5.3. 0.85.2 5.3. 0.85.2
o Replace the old "Screen size" slider with a "Scale" slider o Replace the old "Screen size" slider with a "Scale" slider
o Don't constantly open and close condebug log o Don't constantly open and close condebug log
@ -209,6 +216,7 @@
5.4. 0.85.1 5.4. 0.85.1
o 64 bit CPU support o 64 bit CPU support
o Restructured SDL sound driver o Restructured SDL sound driver
@ -247,6 +255,7 @@
6. Todo 6. Todo
o Add HoT's first person camera (and menu item) o Add HoT's first person camera (and menu item)
o Native CD audio support (if desired). cd_sdl.c doesn't have proper o Native CD audio support (if desired). cd_sdl.c doesn't have proper
@ -267,6 +276,7 @@
7. Links 7. Links
QuakeSpasm Homepage <http://quakespasm.sourceforge.net> QuakeSpasm Homepage <http://quakespasm.sourceforge.net>
QuakeSpasm Project page <http://sourceforge.net/projects/quakespasm> QuakeSpasm Project page <http://sourceforge.net/projects/quakespasm>
FitzQuake Homepage <http://www.celephais.net/fitzquake> FitzQuake Homepage <http://www.celephais.net/fitzquake>
@ -282,3 +292,4 @@
Stevenaaus email <mailto:yahoo - dot - com - username - stevenaaus> Stevenaaus email <mailto:yahoo - dot - com - username - stevenaaus>
Kristian's email <mailto:gmail - dot - com - username - inveigle> Kristian's email <mailto:gmail - dot - com - username - inveigle>