fte
/
quakespasm
mirror of https://github.com/Shpoike/Quakespasm.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Doco update 

git-svn-id: svn://svn.code.sf.net/p/quakespasm/code/trunk/quakespasm@383 af15c1b1-3010-417e-b628-4374ebc0bcbd
This commit is contained in:
Steven 2011-01-10 03:09:09 +00:00
parent 7164ac8dc5
commit 64e52ea80c
7 changed files with 146 additions and 94 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Quake/Makefile
View File

@ -1,15 +1,21 @@
# GNU Makefile for QuakeSpasm unix targets, Aug. 31, 2010
### GNU Makefile for QuakeSpasm unix targets, Aug. 31, 2010
#
# You need the SDL library fully installed.
# "make DEBUG=1" to build a debug client.
# "make SDL_CONFIG=/path/to/sdl-config" for unusual SDL installations.
# "make SDLNET=1" to use SDL_net (not recommended) instead of platform
# specific code.
#
# Build objects are separate from those of codeblocks for now
# (we aren't using codeblocks).
# "make SDLNET=1" to use SDL_net (not recommended)
# instead of platform specific code.
# Build objects are separate from those of codeblocks
### Enable/Disable codecs for streaming music support
#
# OGG (vorbis) playback requires libvorbis and libogg
# MP3 playback requires libmad
USE_CODEC_WAVE=yes
USE_CODEC_MP3=yes
USE_CODEC_VORBIS=yes
# ============================================================================
# ============================================================================
# Helper functions
@ -17,12 +23,6 @@
check_gcc = $(shell if echo | $(CC) $(1) -S -o /dev/null -xc - > /dev/null 2>&1; then echo "$(1)"; else echo "$(2)"; fi;)
# ============================================================================
# Enable/disable codecs for streaming music support:
USE_CODEC_WAVE=yes
USE_CODEC_MP3=yes
USE_CODEC_VORBIS=yes
DEBUG ?= 0
SDLNET ?= 0

2
Quake/bgmnull.c
View File

@ -1,5 +1,5 @@
/*
* Background music handling for Hexen II: Hammer of Thyrion (uHexen2)
* Background music handling for Quakespasm
* Handle cases when we are configured for no sound and no midi driver,
* nada...
*

4
Quake/bgmusic.c
View File

@ -1,9 +1,9 @@
/*
* Background music handling for Hexen II: Hammer of Thyrion (uHexen2)
* Background music handling for Quakespasm
* Handles streaming music as raw sound samples and runs the midi driver
*
* Copyright (C) 1999-2005 Id Software, Inc.
* Copyright (C) 2010 O.Sezer <sezero@users.sourceforge.net>
* Copyright (C) 2011 O.Sezer <sezero@users.sourceforge.net>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by

4
Quake/bgmusic.h
View File

@ -1,9 +1,9 @@
/*
* Background music handling for Hexen II: Hammer of Thyrion (uHexen2)
* Background music handling for Quakespasm
* Handles streaming music as raw sound samples and runs the midi driver
*
* Copyright (C) 1999-2005 Id Software, Inc.
* Copyright (C) 2010 O.Sezer <sezero@users.sourceforge.net>
* Copyright (C) 2011 O.Sezer <sezero@users.sourceforge.net>
*
* $Id: bgmusic.h 3818 2010-12-19 09:04:17Z sezero $
*

75
README.html
View File

@ -11,7 +11,7 @@
<PRE>
</PRE>
</P>
<P>QuakeSpasm 0.85.3 (19 September 2010)</P>
<P>QuakeSpasm 0.85.4 (19 February 2011)</P>
<P>
<H2><A NAME="toc1">1.</A> <A HREF="README.html#s1">About </A></H2>
@ -29,9 +29,10 @@
<H2><A NAME="toc5">5.</A> <A HREF="README.html#s5">Changes</A></H2>
<UL>
<LI><A NAME="toc5.1">5.1</A> <A HREF="README.html#ss5.1">0.85.3</A>
<LI><A NAME="toc5.2">5.2</A> <A HREF="README.html#ss5.2">0.85.2</A>
<LI><A NAME="toc5.3">5.3</A> <A HREF="README.html#ss5.3">0.85.1</A>
<LI><A NAME="toc5.1">5.1</A> <A HREF="README.html#ss5.1">0.85.4</A>
<LI><A NAME="toc5.2">5.2</A> <A HREF="README.html#ss5.2">0.85.3</A>
<LI><A NAME="toc5.3">5.3</A> <A HREF="README.html#ss5.3">0.85.2</A>
<LI><A NAME="toc5.4">5.4</A> <A HREF="README.html#ss5.4">0.85.1</A>
</UL>
<P>
<H2><A NAME="toc6">6.</A> <A HREF="README.html#s6">Todo </A></H2>
@ -53,14 +54,16 @@ It includes 64bit CPU cupport, a new sound driver, several networking fixes, and
<P>
<A HREF="http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.3.tgz/download">Source</A><BR>
<A HREF="http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.3_linux.tgz/download">Linux binary</A><BR>
<A HREF="http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.3_windows.zip/download">Windows</A><BR>
<A HREF="http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.3_osx.zip/download">OSX universal binary</A><BR></P>
<A HREF="http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.4.tgz/download">Source</A><BR>
<A HREF="http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.4_linux.tgz/download">Linux binary</A><BR>
<A HREF="http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.4_windows.zip/download">Windows</A><BR>
<A HREF="http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.4_osx.zip/download">OSX universal binary</A><BR></P>
<H2><A NAME="s3">3.</A> <A HREF="#toc3">Hints </A></H2>
<P><EM> Visit the
<A HREF="http://www.celephais.net/fitzquake">FitzQuake Homepage</A> for a full run-down of engine's commands and variables.</EM></P>
<P>
<UL>
<LI>To disable some changes, use "<B>quakespasm -fitz</B>"
@ -68,28 +71,32 @@ It includes 64bit CPU cupport, a new sound driver, several networking fixes, and
<LI>For different sound drivers use "<B>SDL_AUDIODRIVER=</B><EM>DRIVER</EM><B> ./quakespasm</B>"
, where DRIVER may be alsa, dsp, pulse, esd ...
</LI>
<LI><B>Shift+Escape</B> draws the Console.
</LI>
<LI><B>Shift+Escape</B> draws the Console.</LI>
<LI>From the console, use <B>UP</B> to browse the command line history, and
<B>TAB</B> to autocomplete command and map names.
</LI>
<LI>Quakespasm allows loading new games (mods) on the fly with "<B>game</B> <EM>GAMENAME</EM>"
</LI>
<LI>There is currently no music volume support. cd_sdl.c needs replacing with cd_linux.c, cd_bsd.c etc..
</LI>
<B>TAB</B> to autocomplete command and map names.</LI>
<LI>There currently no CD Music volume support. cd_sdl.c needs replacing with cd_linux.c, cd_bsd.c etc..</LI>
<LI>In windows, alternative CD drives are accessible by "<B>quakespasm -cddev F</B>" (for example)
</LI>
<LI>Quakespasm allows loading new games (mods) on the fly with "<B>game</B> <EM>GAMENAME</EM>"</LI>
</UL>
</P>
<P><EM> Visit the
<A HREF="http://www.celephais.net/fitzquake">FitzQuake Homepage</A> for a full run-down of this engine's features.</EM></P>
<H3>Music Playback</H3>
<P>From 0.85.4 Quakespasm can play back external MP3, OGG and Wave music files.
<UL>
<LI>Tracks should be named "track01.ogg, track02.ogg" ... (for example), and placed into "Quake/id1/music".</LI>
<LI>Linux users may need some extra libraries installed : libmad for MP3, and libogg and libvorbis for OGG.</LI>
<LI>Use the "-nomusic" option to disable this feature.</LI>
</UL>
</P>
<H2><A NAME="s4">4.</A> <A HREF="#toc4">Compiling </A></H2>
<P>Just extract the source tarball, then
<P>After extracting the source tarball, browse the Makefile and edit the music streaming options, then
<HR>
<PRE>
cd quakespasm-0.85.3
make
cp quakespasm /usr/local/games/quake (for example)
</PRE>
@ -99,18 +106,28 @@ Compile time options include
<UL>
<LI><B>make DEBUG=1</B> for debugging</LI>
<LI><B>make SDLNET=1</B> to enable SDL_net (Otherwise the socket api will be used directly)</LI>
<LI><B>make SDL_CONFIG=</B><EM>/PATH/TO/SDL-CONFIG</EM> for unusual SDL installs<BR><BR></LI>
<LI>HOME directory support can be enabled via the <B>Misc/homedir_0.patch</B> diff</LI>
<LI><B>make SDL_CONFIG=</B><EM>/PATH/TO/SDL-CONFIG</EM> for unusual SDL installs</LI>
</UL>
<BR>
If for any reason this doesn't work, the project can also be built with Codeblocks.
</P>
<P>Streaming music playback requires "libmad" for MP3, and "libogg", "libvorbis" for OGG files.</P>
<P>HOME directory support can be enabled via the <B>Misc/homedir_0.patch</B> diff</P>
<P><EM>If for any reason this doesn't work, the project can also be built with Codeblocks.
This is a large, free, integrated development environment that requires wxWidgets and cmake to install.
The process is not for the faint hearted.</P>
The process is not for the faint hearted</EM></P>
.
<H2><A NAME="s5">5.</A> <A HREF="#toc5">Changes</A></H2>
<H2><A NAME="ss5.1">5.1</A> <A HREF="#toc5.1">0.85.3</A>
<H2><A NAME="ss5.1">5.1</A> <A HREF="#toc5.1">0.85.4</A>
</H2>
<P>
<UL>
<LI> Implement music (ogg, mp3, wav) playback</LI>
<LI> A better fix for the infamous "SV_TouchLinks: next != l->next" problem</LI>
</UL>
</P>
<H2><A NAME="ss5.2">5.2</A> <A HREF="#toc5.2">0.85.3</A>
</H2>
<P>
@ -134,7 +151,7 @@ The process is not for the faint hearted.</P>
</UL>
</P>
<H2><A NAME="ss5.2">5.2</A> <A HREF="#toc5.2">0.85.2</A>
<H2><A NAME="ss5.3">5.3</A> <A HREF="#toc5.3">0.85.2</A>
</H2>
<P>
@ -153,7 +170,7 @@ The process is not for the faint hearted.</P>
</UL>
</P>
<H2><A NAME="ss5.3">5.3</A> <A HREF="#toc5.3">0.85.1</A>
<H2><A NAME="ss5.4">5.4</A> <A HREF="#toc5.4">0.85.1</A>
</H2>
<P>

49
README.sgml
View File

@ -4,7 +4,7 @@
<toc>
<verb></verb>
QuakeSpasm 0.85.3 (19 September 2010)
QuakeSpasm 0.85.4 (19 February 2011)
<sect> About <p>
@ -15,17 +15,19 @@ It includes 64bit CPU cupport, a new sound driver, several networking fixes, and
<sect> Downloads <p>
<url url="http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.3.tgz/download" name="Source">
<url url="http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.4.tgz/download" name="Source">
<newline>
<url url="http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.3_linux.tgz/download" name="Linux binary">
<url url="http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.4_linux.tgz/download" name="Linux binary">
<newline>
<url url="http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.3_windows.zip/download" name="Windows">
<url url="http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.4_windows.zip/download" name="Windows">
<newline>
<url url="http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.3_osx.zip/download" name="OSX universal binary">
<url url="http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.4_osx.zip/download" name="OSX universal binary">
<newline>
<sect> Hints <p>
<em> Visit the <url url="http://www.celephais.net/fitzquake" name="FitzQuake Homepage"> for a full run-down of engine's commands and variables.</em>
<itemize>
<item>To disable some changes, use "<bf>quakespasm -fitz</bf>"
@ -33,24 +35,27 @@ It includes 64bit CPU cupport, a new sound driver, several networking fixes, and
, where DRIVER may be alsa, dsp, pulse, esd ...
<item><bf>Shift+Escape</bf> draws the Console.
<item>From the console, use <bf>UP</bf> to browse the command line history, and
<bf>TAB</bf> to autocomplete command and map names.
<item>Quakespasm allows loading new games (mods) on the fly with "<bf>game</bf> <em>GAMENAME</em>"
<item>There is currently no music volume support. cd_sdl.c needs replacing with cd_linux.c, cd_bsd.c etc..
<item>There currently no CD Music volume support. cd_sdl.c needs replacing with cd_linux.c, cd_bsd.c etc..
<item>In windows, alternative CD drives are accessible by "<bf>quakespasm -cddev F</bf>" (for example)
<item>Quakespasm allows loading new games (mods) on the fly with "<bf>game</bf> <em>GAMENAME</em>"
</itemize>
</p>
<sect2>Music Playback<p>
From 0.85.4 Quakespasm can play back external MP3, OGG and Wave music files.
<itemize>
<item>Tracks should be named "track01.ogg, track02.ogg" ... (for example), and placed into "Quake/id1/music".
<item>Linux users may need some extra libraries installed : libmad for MP3, and libogg and libvorbis for OGG.
<item>Use the "-nomusic" option to disable this feature.
</itemize>
<em> Visit the <url url="http://www.celephais.net/fitzquake" name="FitzQuake Homepage"> for a full run-down of this engine's features.</em>
<sect> Compiling <p>
Just extract the source tarball, then
After extracting the source tarball, browse the Makefile and edit the music streaming options, then
<code>
cd quakespasm-0.85.3
make
cp quakespasm /usr/local/games/quake (for example)
</code>
@ -60,16 +65,20 @@ Compile time options include
<item><bf>make DEBUG=1</bf> for debugging
<item><bf>make SDLNET=1</bf> to enable SDL_net (Otherwise the socket api will be used directly)
<item><bf>make SDL_CONFIG=</bf><em>/PATH/TO/SDL-CONFIG</em> for unusual SDL installs
<newline>
<newline>
<item>HOME directory support can be enabled via the <bf>Misc/homedir_0.patch</bf> diff
</itemize>
<newline>
If for any reason this doesn't work, the project can also be built with Codeblocks.
<p>Streaming music playback requires "libmad" for MP3, and "libogg", "libvorbis" for OGG files.
<p>HOME directory support can be enabled via the <bf>Misc/homedir_0.patch</bf> diff
<p><em>If for any reason this doesn't work, the project can also be built with Codeblocks.
This is a large, free, integrated development environment that requires wxWidgets and cmake to install.
The process is not for the faint hearted.
The process is not for the faint hearted</em></p>.
<sect> Changes<p>
<sect1> 0.85.4<p>
<itemize>
<item> Implement music (ogg, mp3, wav) playback
<item> A better fix for the infamous "SV_TouchLinks: next != l->next" problem
</itemize>
</p>
<sect1> 0.85.3<p>
<itemize>
<item> Fix the "-dedicated" option (thanks Oz) and add platform specific networking code (default) rather than SDL_net

80
README.txt
View File

@ -8,11 +8,14 @@
1. About
2. Downloads
3. Hints
3..1 Music Playback
4. Compiling
5. Changes
5.1 0.85.3
5.2 0.85.2
5.3 0.85.1
5.1 0.85.4
5.2 0.85.3
5.3 0.85.2
5.4 0.85.1
6. Todo
7. Links
@ -21,7 +24,7 @@
______________________________________________________________________
QuakeSpasm 0.85.3 (19 September 2010)
QuakeSpasm 0.85.4 (19 February 2011)
1. About
@ -38,47 +41,60 @@
Source
<http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.3.tgz/download>
<http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.4.tgz/download>
Linux binary
<http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.3_linux.tgz/download>
<http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.4_linux.tgz/download>
Windows
<http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.3_windows.zip/download>
<http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.4_windows.zip/download>
OSX universal binary
<http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.3_osx.zip/download>
<http://sourceforge.net/projects/quakespasm/files/quakespasm-0.85.4_osx.zip/download>
3. Hints
Visit the FitzQuake Homepage <http://www.celephais.net/fitzquake> for
a full run-down of engine's commands and variables.
o To disable some changes, use "quakespasm -fitz"
o For different sound drivers use "SDL_AUDIODRIVER=DRIVER
./quakespasm" , where DRIVER may be alsa, dsp, pulse, esd ...
o Shift+Escape draws the Console.
o From the console, use UP to browse the command line history, and
TAB to autocomplete command and map names.
o Quakespasm allows loading new games (mods) on the fly with "game
GAMENAME"
o There is currently no music volume support. cd_sdl.c needs
o There currently no CD Music volume support. cd_sdl.c needs
replacing with cd_linux.c, cd_bsd.c etc..
o In windows, alternative CD drives are accessible by "quakespasm
-cddev F" (for example)
Visit the FitzQuake Homepage <http://www.celephais.net/fitzquake> for
a full run-down of this engine's features.
o Quakespasm allows loading new games (mods) on the fly with "game
GAMENAME"
3.0.1. Music Playback
From 0.85.4 Quakespasm can play back external MP3, OGG and Wave music
files.
o Tracks should be named "track01.ogg, track02.ogg" ... (for
example), and placed into "Quake/id1/music".
o Linux users may need some extra libraries installed : libmad for
MP3, and libogg and libvorbis for OGG.
o Use the "-nomusic" option to disable this feature.
4. Compiling
Just extract the source tarball, then
After extracting the source tarball, browse the Makefile and edit the
music streaming options, then
______________________________________________________________________
cd quakespasm-0.85.3
make
cp quakespasm /usr/local/games/quake (for example)
______________________________________________________________________
@ -93,18 +109,29 @@
o make SDL_CONFIG=/PATH/TO/SDL-CONFIG for unusual SDL installs
o HOME directory support can be enabled via the Misc/homedir_0.patch
diff
If for any reason this doesn't work, the project can also be built
with Codeblocks. This is a large, free, integrated development
environment that requires wxWidgets and cmake to install. The
process is not for the faint hearted.
Streaming music playback requires "libmad" for MP3, and "libogg",
"libvorbis" for OGG files.
HOME directory support can be enabled via the Misc/homedir_0.patch
diff
If for any reason this doesn't work, the project can also be built
with Codeblocks. This is a large, free, integrated development
environment that requires wxWidgets and cmake to install. The process
is not for the faint hearted.
5. Changes
5.1. 0.85.3
5.1. 0.85.4
o Implement music (ogg, mp3, wav) playback
o A better fix for the infamous "SV_TouchLinks: next != l->next"
problem
5.2. 0.85.3
o Fix the "-dedicated" option (thanks Oz) and add platform specific
@ -142,7 +169,7 @@
some other CD tweaks.
5.2. 0.85.2
5.3. 0.85.2
o Replace the old "Screen size" slider with a "Scale" slider
@ -170,7 +197,7 @@
o Add OSX Makefile (tested?)
5.3. 0.85.1
5.4. 0.85.1
o 64 bit CPU support
@ -191,7 +218,6 @@
o Include real map name (sv.name) and skill in the status bar
o Remove confirm quit dialog
o Don't spam the console with PackFile seek requests