fte/quakespasm
2
0
Fork 0
mirror of https://github.com/Shpoike/Quakespasm.git synced 2024-11-10 07:21:58 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update doco a little for recent changes.

Browse source 
git-svn-id: svn://svn.code.sf.net/p/quakespasm/code/trunk/quakespasm@1008 af15c1b1-3010-417e-b628-4374ebc0bcbd
This commit is contained in:
Steven 2014-09-09 01:52:00 +00:00
parent 7724318518
commit fb9bf2e527
3 changed files with 108 additions and 86 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
Linux/sgml/Quakespasm.sgml
View file

@ -4,15 +4,16 @@
<toc>
<verb></verb>
<em>Page last edited Sep. 08, 2014</em>
<em>Page last edited Sep. 9, 2014</em>
<sect> About <p>
QuakeSpasm is a Quake 1 engine based on the SDL port of FitzQuake.
It includes 64bit CPU support, a new sound driver, several networking fixes and a few graphical niceities.
<url url="http://quakespasm.sourceforge.net">
<url url="http://quakespasm.sourceforge.net" name="QuakeSpasm">
is a Quake 1 engine based on the SDL port of
<url url="http://www.celephais.net/fitzquake" name="FitzQuake">.
</p><p>
It includes support for 64 bit CPUs and custom music playback, and includes a new
sound driver, some graphical niceities, and numerous bug-fixes and minor improvements.
<sect> Downloads <p>
@ -29,6 +30,8 @@ It includes 64bit CPU support, a new sound driver, several networking fixes and
<itemize>
<item>To disable some changes, use "<bf>quakespasm -fitz</bf>"
<item>Quakespasm's custom data is stored in "quakespasm.pak". Install this file alongside your id1 directory to enable the custom console background and other minor features.
<item>For different sound drivers use "<bf>SDL_AUDIODRIVER=</bf><em>DRIVER</em><bf> ./quakespasm</bf>"
, where DRIVER may be alsa, dsp, pulse, esd ...
@ -38,12 +41,12 @@ It includes 64bit CPU support, a new sound driver, several networking fixes and
<item>There is 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>"
<item>Quakespasm allows loading new games (mods) on the fly with "<bf>game</bf> <em>GAMENAME {-quoth/hipnotic/rogue}</em>"
</itemize>
</p>
<sect1>Music Playback<p>
Since version 0.85.4, Quakespasm can play back external MP3, OGG and Wave music files.
Quakespasm can play various external music formats, including MP3, OGG and FLAC.
<itemize>
<item>Tracks should be named like "track02.ogg", "track03.ogg" ... (there is no track01) and placed into "Quake/id1/music".
<item>Unix users may need some extra libraries installed: "libmad" or "libmpg123" for MP3, and "libogg" and "libvorbis" for OGG.
@ -53,10 +56,9 @@ Since version 0.85.4, Quakespasm can play back external MP3, OGG and Wave music
</itemize>
<sect> Compiling <p>
<p>To check-out the latest version of QuakeSpasm, use :
<newline>
<em>svn co svn://svn.code.sf.net/p/quakespasm/code/trunk/quakespasm</em></p>
<sect> Compiling and Installation<p>
<p>Quakespasm's (optional) custom data is now stored in the file <bf>quakespasm.pak</bf>. This file should be placed alongside your quakespasm binary and <bf>id1</bf> directory.</p>
<p><em>To check-out the latest version of QuakeSpasm, use</em> <bf>svn co svn://svn.code.sf.net/p/quakespasm/code/trunk/quakespasm</bf></p>
<sect1> Linux/Unix <p>
After extracting the source tarball, browse the Makefile and edit the music streaming options, then
@ -311,20 +313,24 @@ OS X has a well known gamma issue where the screen turns dark, but we currently
<url url="http://creativecommons.org/licenses/by/3.0/legalcode" name="CREATIVE COMMONS PUBLIC LICENSE">
</itemize>
<sect> Contact <p>
<itemize>
<item><url url="http://sourceforge.net/projects/quakespasm" name="QuakeSpasm Project page">
<item><url url="http://sourceforge.net/p/quakespasm/bugs/?source=navbar" name="Bug reports">
<item><url url="mailto:gmail - dot - com - username - sezeroz" name="Ozkan"> (project leader),
<url url="mailto:gmail - dot - com - username - ewasylishen" name="Eric">,
<url url="mailto:gmail - dot - com - username - a.h.vandijk" name="Sander">,
<url url="mailto:yahoo - dot - com - username - stevenaaus" name="Stevenaaus">
</itemize>
<sect> Links <p>
<itemize>
<item><url url="http://quakespasm.sourceforge.net" name="QuakeSpasm Homepage">
<item><url url="http://sourceforge.net/projects/quakespasm" name="QuakeSpasm Project page">
<item><url url="http://quakespasm.sourceforge.net/download.htm" name="Downloads">
<item><url url="http://www.celephais.net/fitzquake" name="FitzQuake Homepage">
<item><url url="http://www.kristianduske.com/fitzquake" name="Sleepwalkr's Original SDL Port">
<item><url name="Baker's 0.85 Source Code" url="http://quakeone.com/proquake/src_other/fitzquake_sdl_20090510_src_beta_1.zip">
<item><url url="http://www.celephais.net/board/view_thread.php?id=60452" name="Func Quakespasm forum">
<item><url url="http://www.celephais.net/board/view_thread.php?id=60172" name="Func SDL Fitzquake forum">
<item><url url="mailto:gmail - dot - com - username - sezeroz" name="Ozkan's email">
<item><url url="mailto:yahoo - dot - com - username - stevenaaus" name="Stevenaaus email">
<item><url url="mailto:gmail - dot - com - username - inveigle" name="Kristian's email">
<item><url url="mailto:gmail - dot - com - username - a.h.vandijk" name="Sander's email">
<item><url url="http://forums.inside3d.com/viewforum.php?f=14" name="Inside 3D forums">
</itemize>
</article>

64
Quakespasm.html
View file

@ -12,7 +12,7 @@
<PRE>
</PRE>
</P>
<P><EM>Page last edited Sep. 08, 2014</EM></P>
<P><EM>Page last edited Sep. 9, 2014</EM></P>
<P>
<H2><A NAME="toc1">1.</A> <A HREF="Quakespasm.html#s1">About </A></H2>
@ -27,7 +27,7 @@
<LI><A NAME="toc3.1">3.1</A> <A HREF="Quakespasm.html#ss3.1">Music Playback</A>
</UL>
<P>
<H2><A NAME="toc4">4.</A> <A HREF="Quakespasm.html#s4">Compiling </A></H2>
<H2><A NAME="toc4">4.</A> <A HREF="Quakespasm.html#s4">Compiling and Installation</A></H2>
<UL>
<LI><A NAME="toc4.1">4.1</A> <A HREF="Quakespasm.html#ss4.1">Linux/Unix </A>
@ -59,18 +59,22 @@
<H2><A NAME="toc8">8.</A> <A HREF="Quakespasm.html#s8">Copyright </A></H2>
<P>
<H2><A NAME="toc9">9.</A> <A HREF="Quakespasm.html#s9">Links </A></H2>
<H2><A NAME="toc9">9.</A> <A HREF="Quakespasm.html#s9">Contact </A></H2>
<P>
<H2><A NAME="toc10">10.</A> <A HREF="Quakespasm.html#s10">Links </A></H2>
<HR>
<H2><A NAME="s1">1.</A> <A HREF="#toc1">About </A></H2>
<P>QuakeSpasm is a Quake 1 engine based on the SDL port of FitzQuake.
It includes 64bit CPU support, a new sound driver, several networking fixes and a few graphical niceities.</P>
<P>
<A HREF="http://quakespasm.sourceforge.net">http://quakespasm.sourceforge.net</A></P>
<A HREF="http://quakespasm.sourceforge.net">QuakeSpasm</A>
is a Quake 1 engine based on the SDL port of
<A HREF="http://www.celephais.net/fitzquake">FitzQuake</A>.</P>
<P>It includes support for 64 bit CPUs and custom music playback, and includes a new
sound driver, some graphical niceities, and numerous bug-fixes and minor improvements.</P>
<H2><A NAME="s2">2.</A> <A HREF="#toc2">Downloads </A></H2>
@ -94,6 +98,8 @@ It includes 64bit CPU support, a new sound driver, several networking fixes and
<UL>
<LI>To disable some changes, use "<B>quakespasm -fitz</B>"
</LI>
<LI>Quakespasm's custom data is stored in "quakespasm.pak". Install this file alongside your id1 directory to enable the custom console background and other minor features.
</LI>
<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>
@ -103,13 +109,13 @@ It includes 64bit CPU support, a new sound driver, several networking fixes and
<LI>There is 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>
<LI>Quakespasm allows loading new games (mods) on the fly with "<B>game</B> <EM>GAMENAME {-quoth/hipnotic/rogue}</EM>"</LI>
</UL>
</P>
<H2><A NAME="ss3.1">3.1</A> <A HREF="#toc3.1">Music Playback</A>
</H2>
<P>Since version 0.85.4, Quakespasm can play back external MP3, OGG and Wave music files.
<P>Quakespasm can play various external music formats, including MP3, OGG and FLAC.
<UL>
<LI>Tracks should be named like "track02.ogg", "track03.ogg" ... (there is no track01) and placed into "Quake/id1/music".</LI>
<LI>Unix users may need some extra libraries installed: "libmad" or "libmpg123" for MP3, and "libogg" and "libvorbis" for OGG.</LI>
@ -121,11 +127,11 @@ It includes 64bit CPU support, a new sound driver, several networking fixes and
</P>
<H2><A NAME="s4">4.</A> <A HREF="#toc4">Compiling </A></H2>
<H2><A NAME="s4">4.</A> <A HREF="#toc4">Compiling and Installation</A></H2>
<P>To check-out the latest version of QuakeSpasm, use :<BR>
<EM>svn co svn://svn.code.sf.net/p/quakespasm/code/trunk/quakespasm</EM></P>
<P>Quakespasm's (optional) custom data is now stored in the file <B>quakespasm.pak</B>. This file should be placed alongside your quakespasm binary and <B>id1</B> directory.</P>
<P><EM>To check-out the latest version of QuakeSpasm, use</EM> <B>svn co svn://svn.code.sf.net/p/quakespasm/code/trunk/quakespasm</B></P>
<H2><A NAME="ss4.1">4.1</A> <A HREF="#toc4.1">Linux/Unix </A>
</H2>
@ -416,7 +422,23 @@ these patched libSDL binaries may help.
</UL>
</P>
<H2><A NAME="s9">9.</A> <A HREF="#toc9">Links </A></H2>
<H2><A NAME="s9">9.</A> <A HREF="#toc9">Contact </A></H2>
<P>
<UL>
<LI>
<A HREF="http://sourceforge.net/projects/quakespasm">QuakeSpasm Project page</A></LI>
<LI>
<A HREF="http://sourceforge.net/p/quakespasm/bugs/?source=navbar">Bug reports</A></LI>
<LI>
<A HREF="mailto:gmail - dot - com - username - sezeroz">Ozkan</A> (project leader),
<A HREF="mailto:gmail - dot - com - username - ewasylishen">Eric</A>,
<A HREF="mailto:gmail - dot - com - username - a.h.vandijk">Sander</A>,
<A HREF="mailto:yahoo - dot - com - username - stevenaaus">Stevenaaus</A></LI>
</UL>
</P>
<H2><A NAME="s10">10.</A> <A HREF="#toc10">Links </A></H2>
<P>
@ -424,25 +446,13 @@ these patched libSDL binaries may help.
<LI>
<A HREF="http://quakespasm.sourceforge.net">QuakeSpasm Homepage</A></LI>
<LI>
<A HREF="http://sourceforge.net/projects/quakespasm">QuakeSpasm Project page</A></LI>
<A HREF="http://quakespasm.sourceforge.net/download.htm">Downloads</A></LI>
<LI>
<A HREF="http://www.celephais.net/fitzquake">FitzQuake Homepage</A></LI>
<LI>
<A HREF="http://www.kristianduske.com/fitzquake">Sleepwalkr's Original SDL Port</A></LI>
<LI>
<A HREF="http://quakeone.com/proquake/src_other/fitzquake_sdl_20090510_src_beta_1.zip">Baker's 0.85 Source Code</A></LI>
<LI>
<A HREF="http://www.celephais.net/board/view_thread.php?id=60452">Func Quakespasm forum</A></LI>
<LI>
<A HREF="http://www.celephais.net/board/view_thread.php?id=60172">Func SDL Fitzquake forum</A></LI>
<LI>
<A HREF="mailto:gmail - dot - com - username - sezeroz">Ozkan's email</A></LI>
<LI>
<A HREF="mailto:yahoo - dot - com - username - stevenaaus">Stevenaaus email</A></LI>
<LI>
<A HREF="mailto:gmail - dot - com - username - inveigle">Kristian's email</A></LI>
<LI>
<A HREF="mailto:gmail - dot - com - username - a.h.vandijk">Sander's email</A></LI>
<A HREF="http://forums.inside3d.com/viewforum.php?f=14">Inside 3D forums</A></LI>
</UL>
</P>

84
Quakespasm.txt
View file

@ -10,7 +10,7 @@
3. Hints
3.1 Music Playback
4. Compiling
4. Compiling and Installation
4.1 Linux/Unix
4.2 Windows
4.3 Mac OS X
@ -30,21 +30,24 @@
7. Todo
8. Copyright
9. Links
9. Contact
10. Links
______________________________________________________________________
Page last edited Sep. 08, 2014
Page last edited Sep. 9, 2014
1. About
QuakeSpasm is a Quake 1 engine based on the SDL port of FitzQuake. It
includes 64bit CPU support, a new sound driver, several networking
fixes and a few graphical niceities.
QuakeSpasm <http://quakespasm.sourceforge.net> is a Quake 1 engine
based on the SDL port of FitzQuake
<http://www.celephais.net/fitzquake>.
<http://quakespasm.sourceforge.net>
It includes support for 64 bit CPUs and custom music playback, and
includes a new sound driver, some graphical niceities, and numerous
bug-fixes and minor improvements.
2. Downloads
@ -58,9 +61,12 @@
Visit the FitzQuake Homepage <http://www.celephais.net/fitzquake> for
a full run-down of the engine's commands and variables.
o To disable some changes, use "quakespasm -fitz"
o Quakespasm's custom data is stored in "quakespasm.pak". Install
this file alongside your id1 directory to enable the custom console
background and other minor features.
o For different sound drivers use "SDL_AUDIODRIVER=DRIVER
./quakespasm" , where DRIVER may be alsa, dsp, pulse, esd ...
@ -76,12 +82,12 @@
-cddev F" (for example)
o Quakespasm allows loading new games (mods) on the fly with "game
GAMENAME"
GAMENAME {-quoth/hipnotic/rogue}"
3.1. Music Playback
Since version 0.85.4, Quakespasm can play back external MP3, OGG and
Wave music files.
Quakespasm can play various external music formats, including MP3, OGG
and FLAC.
o Tracks should be named like "track02.ogg", "track03.ogg" ... (there
is no track01) and placed into "Quake/id1/music".
@ -96,10 +102,14 @@
o See <Quakespasm-Music.txt> for more details.
4. Compiling
4. Compiling and Installation
To check-out the latest version of QuakeSpasm, use :
svn co svn://svn.code.sf.net/p/quakespasm/code/trunk/quakespasm
Quakespasm's (optional) custom data is now stored in the file
quakespasm.pak. This file should be placed alongside your quakespasm
binary and id1 directory.
To check-out the latest version of QuakeSpasm, use svn co
svn://svn.code.sf.net/p/quakespasm/code/trunk/quakespasm
4.1. Linux/Unix
@ -116,6 +126,7 @@
o make DEBUG=1 for debugging
o make SDL_CONFIG=/PATH/TO/SDL-CONFIG for unusual SDL installations
Streaming music playback requires "libmad" or "libmpg123" for MP3, and
@ -126,7 +137,6 @@
The project can also be built with Codeblocks (project files
included).
4.2. Windows
The QuakeSpasm developers cross-compile windows binaries using MinGW
@ -248,6 +258,7 @@
o Fixes for several undefined behaviors in C code (gcc-4.8 support.)
o Implemented Hor+ style field of view (FOV) scaling, useful for
widescreen resolutions. Configured by new cvar fov_adapt: set it to
1 and your fov will be scaled automatically according to the
@ -313,6 +324,7 @@
o Support for Solaris.
o Switched to using libmad instead of libmpg123 for MP3 playback on
Mac OS X.
@ -324,7 +336,6 @@
o Increased string buffer size from 256 to 384 for PF_VarString to
work around broken mods such as UQC.
o Restored original behavior for Quake registered version detection.
o Minor demo recording/playback tweaks.
@ -377,6 +388,7 @@
o Minor SDL video fixes.
6.6. Changes in 0.85.5
@ -390,7 +402,6 @@
o Added workaround against GL texture flicker (z fighting),
controlled by new cvar 'gl_zfix'
o Read video variables early so that a vid_restart isn't necessary
after init
@ -443,6 +454,7 @@
o Fix the "-dedicated" option (thanks Oz) and add platform specific
networking code (default) rather than SDL_net
o Much needed OSX framework stuff from Kristian
o Add a persistent history feature (thanks Baker)
@ -456,7 +468,6 @@
o Connect status bar size to the scale slider
o Include an ISNAN (is not-a-number) fix to catch the occassional
quake C bug giving traceline problems
@ -522,7 +533,6 @@
o Show helpful info on start-up
o Include real map name (sv.name) and skill in the status bar
o Remove confirm quit dialog
@ -564,35 +574,31 @@
CREATIVE COMMONS PUBLIC LICENSE
<http://creativecommons.org/licenses/by/3.0/legalcode>
9. Links
9. Contact
o QuakeSpasm Homepage <http://quakespasm.sourceforge.net>
o QuakeSpasm Project page
<http://sourceforge.net/projects/quakespasm>
o Bug reports
<http://sourceforge.net/p/quakespasm/bugs/?source=navbar>
o Ozkan <mailto:gmail - dot - com - username - sezeroz> (project
leader), Eric <mailto:gmail - dot - com - username - ewasylishen>,
Sander <mailto:gmail - dot - com - username - a.h.vandijk>,
Stevenaaus <mailto:yahoo - dot - com - username - stevenaaus>
10. Links
o QuakeSpasm Homepage <http://quakespasm.sourceforge.net>
o Downloads <http://quakespasm.sourceforge.net/download.htm>
o FitzQuake Homepage <http://www.celephais.net/fitzquake>
o Sleepwalkr's Original SDL Port
<http://www.kristianduske.com/fitzquake>
o Baker's 0.85 Source Code
<http://quakeone.com/proquake/src_other/fitzquake_sdl_20090510_src_beta_1.zip>
o Func Quakespasm forum
<http://www.celephais.net/board/view_thread.php?id=60452>
o Func SDL Fitzquake forum
<http://www.celephais.net/board/view_thread.php?id=60172>
o Ozkan's email <mailto:gmail - dot - com - username - sezeroz>
o Stevenaaus email <mailto:yahoo - dot - com - username - stevenaaus>
o Kristian's email <mailto:gmail - dot - com - username - inveigle>
o Sander's email <mailto:gmail - dot - com - username - a.h.vandijk>
o Inside 3D forums <http://forums.inside3d.com/viewforum.php?f=14>