From ef6a6119d98ed4c67cac37f640a80a56ecbe4e0c Mon Sep 17 00:00:00 2001 From: stevenaaus Date: Mon, 10 Jan 2011 03:09:09 +0000 Subject: [PATCH] Doco update git-svn-id: http://svn.code.sf.net/p/quakespasm/code/trunk/quakespasm@383 af15c1b1-3010-417e-b628-4374ebc0bcbd --- Quake/Makefile | 26 ++++++++-------- Quake/bgmnull.c | 2 +- Quake/bgmusic.c | 4 +-- Quake/bgmusic.h | 4 +-- README.html | 75 ++++++++++++++++++++++++++++------------------ README.sgml | 49 +++++++++++++++++------------- README.txt | 80 ++++++++++++++++++++++++++++++++----------------- 7 files changed, 146 insertions(+), 94 deletions(-) diff --git a/Quake/Makefile b/Quake/Makefile index cc81c72f..9b953fc9 100644 --- a/Quake/Makefile +++ b/Quake/Makefile @@ -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 diff --git a/Quake/bgmnull.c b/Quake/bgmnull.c index 5dba2681..7a8784f7 100644 --- a/Quake/bgmnull.c +++ b/Quake/bgmnull.c @@ -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... * diff --git a/Quake/bgmusic.c b/Quake/bgmusic.c index 867dc0ab..8a466946 100644 --- a/Quake/bgmusic.c +++ b/Quake/bgmusic.c @@ -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 + * Copyright (C) 2011 O.Sezer * * 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 diff --git a/Quake/bgmusic.h b/Quake/bgmusic.h index 8d71ea2b..b139b09a 100644 --- a/Quake/bgmusic.h +++ b/Quake/bgmusic.h @@ -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 + * Copyright (C) 2011 O.Sezer * * $Id: bgmusic.h 3818 2010-12-19 09:04:17Z sezero $ * diff --git a/README.html b/README.html index b4ac0a10..5f69221f 100644 --- a/README.html +++ b/README.html @@ -11,7 +11,7 @@

-

QuakeSpasm 0.85.3 (19 September 2010)

+

QuakeSpasm 0.85.4 (19 February 2011)

1. About

@@ -29,9 +29,10 @@

5. Changes

6. Todo

@@ -53,14 +54,16 @@ It includes 64bit CPU cupport, a new sound driver, several networking fixes, and

-Source
-Linux binary
-Windows
-OSX universal binary

+Source
+Linux binary
+Windows
+OSX universal binary

3. Hints

+

Visit the +FitzQuake Homepage for a full run-down of engine's commands and variables.

  • To disable some changes, use "quakespasm -fitz" @@ -68,28 +71,32 @@ It includes 64bit CPU cupport, a new sound driver, several networking fixes, and
  • For different sound drivers use "SDL_AUDIODRIVER=DRIVER ./quakespasm" , where DRIVER may be alsa, dsp, pulse, esd ...
    • -
  • Shift+Escape draws the Console. -
    • +
  • Shift+Escape draws the Console.
  • From the console, use UP to browse the command line history, and -TAB to autocomplete command and map names. -
    • -
  • Quakespasm allows loading new games (mods) on the fly with "game GAMENAME" -
    • -
  • There is currently no music volume support. cd_sdl.c needs replacing with cd_linux.c, cd_bsd.c etc.. -
    • +TAB to autocomplete command and map names. +
  • There currently no CD Music volume support. cd_sdl.c needs replacing with cd_linux.c, cd_bsd.c etc..
  • In windows, alternative CD drives are accessible by "quakespasm -cddev F" (for example)
    • +
  • Quakespasm allows loading new games (mods) on the fly with "game GAMENAME"

-

Visit the -FitzQuake Homepage for a full run-down of this engine's features.

+

Music Playback

+ +

From 0.85.4 Quakespasm can play back external MP3, OGG and Wave music files. +

    +
  • Tracks should be named "track01.ogg, track02.ogg" ... (for example), and placed into "Quake/id1/music".
    • +
  • Linux users may need some extra libraries installed : libmad for MP3, and libogg and libvorbis for OGG.
    • +
  • 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)
@@ -99,18 +106,28 @@ Compile time options include
  • make DEBUG=1 for debugging
  • make SDLNET=1 to enable SDL_net (Otherwise the socket api will be used directly)
    • -
  • make SDL_CONFIG=/PATH/TO/SDL-CONFIG for unusual SDL installs

    • -
  • HOME directory support can be enabled via the Misc/homedir_0.patch diff
    • +
  • make SDL_CONFIG=/PATH/TO/SDL-CONFIG for unusual SDL installs
-
-If for any reason this doesn't work, the project can also be built with Codeblocks. +

+

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.

- +The process is not for the faint hearted

+.

5. Changes

-

5.1 0.85.3 +

5.1 0.85.4 +

+ +

+

    +
  • Implement music (ogg, mp3, wav) playback
    • +
  • A better fix for the infamous "SV_TouchLinks: next != l->next" problem
    • +
+

+

5.2 0.85.3

@@ -134,7 +151,7 @@ The process is not for the faint hearted.

-

5.2 0.85.2 +

5.3 0.85.2

@@ -153,7 +170,7 @@ The process is not for the faint hearted.

-

5.3 0.85.1 +

5.4 0.85.1

diff --git a/README.sgml b/README.sgml index d22d2267..471512b0 100644 --- a/README.sgml +++ b/README.sgml @@ -4,7 +4,7 @@ -QuakeSpasm 0.85.3 (19 September 2010) +QuakeSpasm 0.85.4 (19 February 2011) About

@@ -15,17 +15,19 @@ It includes 64bit CPU cupport, a new sound driver, several networking fixes, and Downloads

- + - + - + - + Hints

+ Visit the for a full run-down of engine's commands and variables. + To disable some changes, use "quakespasm -fitz" @@ -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 ... Shift+Escape draws the Console. - From the console, use UP to browse the command line history, and TAB to autocomplete command and map names. - -Quakespasm allows loading new games (mods) on the fly with "game GAMENAME" - -There is currently no music volume support. cd_sdl.c needs replacing with cd_linux.c, cd_bsd.c etc.. - +There currently no CD Music volume support. cd_sdl.c needs replacing with cd_linux.c, cd_bsd.c etc.. In windows, alternative CD drives are accessible by "quakespasm -cddev F" (for example) +Quakespasm allows loading new games (mods) on the fly with "game GAMENAME" + +

+Music Playback

+From 0.85.4 Quakespasm can play back external MP3, OGG and Wave music files. + +Tracks should be named "track01.ogg, track02.ogg" ... (for example), and placed into "Quake/id1/music". +Linux users may need some extra libraries installed : libmad for MP3, and libogg and libvorbis for OGG. +Use the "-nomusic" option to disable this feature. - Visit the for a full run-down of this engine's features. + 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) @@ -60,16 +65,20 @@ Compile time options include make DEBUG=1 for debugging make SDLNET=1 to enable SDL_net (Otherwise the socket api will be used directly) make SDL_CONFIG=/PATH/TO/SDL-CONFIG for unusual SDL installs - - -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. +

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. +The process is not for the faint hearted

. Changes

+ 0.85.4

+ + Implement music (ogg, mp3, wav) playback + A better fix for the infamous "SV_TouchLinks: next != l->next" problem + +

0.85.3

Fix the "-dedicated" option (thanks Oz) and add platform specific networking code (default) rather than SDL_net diff --git a/README.txt b/README.txt index f319ae1a..4c20a604 100644 --- a/README.txt +++ b/README.txt @@ -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 - + Linux binary - + Windows - + OSX universal binary - + 3. Hints + Visit the FitzQuake Homepage 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 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