From ecdc407d9c0866c532a93abbe4e1968f18893670 Mon Sep 17 00:00:00 2001
From: stevenaaus
Date: Sat, 14 Aug 2010 07:40:48 +0000
Subject: [PATCH] README changes
git-svn-id: http://svn.code.sf.net/p/quakespasm/code/trunk/quakespasm@270 af15c1b1-3010-417e-b628-4374ebc0bcbd
---
README.html | 176 +++++++++++++++++++++++++++++-----------------------
README.sgml | 81 +++++++++++++-----------
README.txt | 129 ++++++++++++++++++++------------------
3 files changed, 211 insertions(+), 175 deletions(-)
diff --git a/README.html b/README.html
index e25815bd..67309b00 100644
--- a/README.html
+++ b/README.html
@@ -17,13 +17,8 @@
-
+
-
@@ -31,10 +26,18 @@
-
+
+
+
+
+
-
+
@@ -42,85 +45,30 @@
QuakeSpasm is a Quake 1 engine based on the SDL port of FitzQuake.
-It includes 64bit CPU cupport, a new sound driver, and a few graphical niceities.
-The main feature is it works on virtually all platforms, and supports large Q1 mods.
+It includes 64bit CPU cupport, a new sound driver, several networking fixes, and a few graphical niceities.
-QuakeSpasm Homepage
-To disable some changes, use quakespasm -fitz
-For different sound drivers:
-SDL_AUDIODRIVER=DRIVER ./quakespasm
-Where DRIVER may be alsa, dsp, pulse, esd ...
-Shift+Escape now draws the Console.
+http://quakespasm.sourceforge.net
+
-
-
-
-
-- Fix the "-dedicated" option (thanks Oz) and add platform specific networking code (default) cwrather than SDLnet
-- Much needed OSX framework stuff from Kristian
-- Add a persistent history feature (thanks Baker)
-- Add a slider for scr_sbaralpha, which now defaults to 0.95 (slightly transparent, allowing for nicer sbar)
-- Sockaddr fix for FreeBSD/OSX/etc networking
-- Connect status bar size to the scale slider
-- Include an ISNAN (is not-a-number) fix to catch the occassional quake C bug giving traceline problems
-- Enumerate options menus
-- Small fix to Sound Block/Unblock on win32
-- Lots of code fixes (some from uhexen2)
-- Shift+Escape opens console
-- Sys_Error calls Host_Shutdown
+
- To disable some changes, use "quakespasm -fitz"
+
+- For different sound drivers use "SDL_AUDIODRIVER=DRIVER ./quakespasm"
+, 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"
-
-
-
-
-- Replace the old "Screen size" slider with a "Scale" slider
-- Don't constantly open and close condebug log
-- Heap of C clean-ups
-- Fix mapname sorting
-- Alias the "mods" command to "games"
-- Block/Unblock sound upon focus loss/gain
-- NAT fix (networking protocol fix)
-- SDLNet_ResolveHost bug-fix allowing connection to ports other than 26000
-- sv_main.c (localmodels) Bumped array size from 5 to 6 in order for it to operate correctly with the raised limits of fitzquake-0.85
-- Accept commandline options like "+connect ip:port"
-- Add OSX Makefile (tested?)
-
-
-
-
-
-
-
-- 64 bit CPU support
-- Restructured SDL sound driver
-- Custom conback
-- Tweaked the command line completion , and added a map/changelevel autocompletion function
-- Alt+Enter toggles fullscreen
-- Disable Draw_BeginDisc which causes core dumps when called excessively
-- Show helpful info on start-up
-- Include real map name (sv.name) and skill in the status bar
-- Remove confirm quit dialog
-- Don't spam the console with PackFile seek requests
-- Default to window mode
-- Withdraw console when playing demos
-- Don't play demos on program init
-- Default Heapsize is 64meg
-- Changes to default console alpha, speed
-- Changes to cvar persistence gl_flashblend(default 0), r_shadow, r_wateralpha, r_dynamic, r_novis
-
-
-
-
@@ -146,7 +94,77 @@ If for any reason this doesn't work, the project can also be built with Codebloc
This is a large, free, integrated development environment that requires wxWidgets and cmake to install.
The process is not for the faint hearted.
-
+
+
+
+
+
+
+
+- Fix the "-dedicated" option (thanks Oz) and add platform specific networking code (default) rather than SDL_net
+- Much needed OSX framework stuff from Kristian
+- Add a persistent history feature (thanks Baker)
+- Add a slider for scr_sbaralpha, which now defaults to 0.95 (slightly transparent, allowing for nicer status bar)
+- Allow for player messages longer than 32 chars
+- Sockaddr fix for FreeBSD/OSX/etc networking
+- Connect status bar size to the scale slider
+- Include an ISNAN (is not-a-number) fix to catch the occassional quake C bug giving traceline problems
+- Enumerate options menus
+- Add a "prev weapon" menu item (from Sander)
+- Small fix to Sound Block/Unblock on win32
+- Lots of code fixes (some from uhexen2)
+- Shift+Escape opens console
+- Sys_Error calls Host_Shutdown
+
+
+
+
+
+
+
+
+- Replace the old "Screen size" slider with a "Scale" slider
+- Don't constantly open and close condebug log
+- Heap of C clean-ups
+- Fix mapname sorting
+- Alias the "mods" command to "games"
+- Block/Unblock sound upon focus loss/gain
+- NAT fix (networking protocol fix)
+- SDLNet_ResolveHost bug-fix allowing connection to ports other than 26000
+- sv_main.c (localmodels) Bumped array size from 5 to 6 in order for it to operate correctly with the raised limits of fitzquake-0.85
+- Accept commandline options like "+connect ip:port"
+- Add OSX Makefile (tested?)
+
+
+
+
+
+
+
+- 64 bit CPU support
+- Restructured SDL sound driver
+- Custom conback
+- Tweaked the command line completion , and added a map/changelevel autocompletion function
+- Alt+Enter toggles fullscreen
+- Disable Draw_BeginDisc which causes core dumps when called excessively
+- Show helpful info on start-up
+- Include real map name (sv.name) and skill in the status bar
+- Remove confirm quit dialog
+- Don't spam the console with PackFile seek requests
+- Default to window mode
+- Withdraw console when playing demos
+- Don't play demos on program init
+- Default Heapsize is 64meg
+- Changes to default console alpha, speed
+- Changes to cvar persistence gl_flashblend(default 0), r_shadow, r_wateralpha, r_dynamic, r_novis
+
+
+
+
+
@@ -158,7 +176,7 @@ The process is not for the faint hearted.
-
+
diff --git a/README.sgml b/README.sgml
index 99a9926f..ba56a7f7 100644
--- a/README.sgml
+++ b/README.sgml
@@ -9,33 +9,66 @@ QuakeSpasm 0.85.3 (unreleased) (18 September 2010)
About
QuakeSpasm is a Quake 1 engine based on the SDL port of FitzQuake.
-It includes 64bit CPU cupport, a new sound driver, and a few graphical niceities.
-The main feature is it works on virtually all platforms, and supports large Q1 mods.
+It includes 64bit CPU cupport, a new sound driver, several networking fixes, and a few graphical niceities.
-
+
-To disable some changes, use quakespasm -fitz
+ Hints
-For different sound drivers:
+
+- To disable some changes, use "quakespasm -fitz"
+
+
- For different sound drivers use "SDL_AUDIODRIVER=DRIVER ./quakespasm"
+, 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"
+
+
+
+ Downloads
+
+
-SDL_AUDIODRIVER=DRIVER ./quakespasm
+
+
+
-Where DRIVER may be alsa, dsp, pulse, esd ...
-
-Shift+Escape now draws the Console.
+ Compiling
+Just extract the source tarball, then
+
+cd quakespasm-0.85.3
+make
+cp quakespasm /usr/local/games/quake (for eg)
+
+Use make DEBUG=1 for debugging.
+
+
+Optionally, 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.
Changes
0.85.3
-- Fix the "-dedicated" option (thanks Oz) and add platform specific networking code (default) cwrather than SDLnet
+
- Fix the "-dedicated" option (thanks Oz) and add platform specific networking code (default) rather than SDL_net
- Much needed OSX framework stuff from Kristian
- Add a persistent history feature (thanks Baker)
-
- Add a slider for scr_sbaralpha, which now defaults to 0.95 (slightly transparent, allowing for nicer sbar)
+
- Add a slider for scr_sbaralpha, which now defaults to 0.95 (slightly transparent, allowing for nicer status bar)
+
- Allow for player messages longer than 32 chars
- Sockaddr fix for FreeBSD/OSX/etc networking
- Connect status bar size to the scale slider
- Include an ISNAN (is not-a-number) fix to catch the occassional quake C bug giving traceline problems
- Enumerate options menus
+
- Add a "prev weapon" menu item (from Sander)
- Small fix to Sound Block/Unblock on win32
- Lots of code fixes (some from uhexen2)
- Shift+Escape opens console
@@ -79,32 +112,6 @@ Where DRIVER may be alsa, dsp, pulse, esd ...
- Downloads
-
-
-
-
-
-
-
-
- Compiling
-Just extract the source tarball, then
-
-cd quakespasm-0.85.3
-make
-cp quakespasm /usr/local/games/quake (for eg)
-
-Use make DEBUG=1 for debugging.
-
-
-Optionally, 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.
-
Todo
- Ogg/Mp3 music file support
diff --git a/README.txt b/README.txt
index bf2436a2..24f9f77c 100644
--- a/README.txt
+++ b/README.txt
@@ -6,15 +6,16 @@
1. About
- 2. Changes
- 2.1 0.85.3
- 2.2 0.85.2
- 2.3 0.85.1
-
+ 2. Hints
3. Downloads
4. Compiling
- 5. Todo
- 6. Links
+ 5. Changes
+ 5.1 0.85.3
+ 5.2 0.85.2
+ 5.3 0.85.1
+
+ 6. Todo
+ 7. Links
______________________________________________________________________
@@ -27,36 +28,75 @@
QuakeSpasm is a Quake 1 engine based on the SDL port of FitzQuake. It
- includes 64bit CPU cupport, a new sound driver, and a few graphical
- niceities. The main feature is it works on virtually all platforms,
- and supports large Q1 mods.
+ includes 64bit CPU cupport, a new sound driver, several networking
+ fixes, and a few graphical niceities.
- QuakeSpasm Homepage
-
- To disable some changes, use quakespasm -fitz
-
- For different sound drivers:
- SDL_AUDIODRIVER=DRIVER ./quakespasm
- Where DRIVER may be alsa, dsp, pulse, esd ...
-
- Shift+Escape now draws the Console.
+
- 2. Changes
+ 2. Hints
- 2.1. 0.85.3
+ 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"
+
+
+ 3. Downloads
+
+
+ Source
+
+ Linux binary
+
+ Windows
+
+ 4. Compiling
+
+ Just extract the source tarball, then
+
+ ______________________________________________________________________
+ cd quakespasm-0.85.3
+ make
+ cp quakespasm /usr/local/games/quake (for eg)
+ ______________________________________________________________________
+
+
+ Use make DEBUG=1 for debugging.
+ Optionally, HOME directory support can be enabled via the Misc/home-
+ dir_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 envi-
+ ronment that requires wxWidgets and cmake to install. The process is
+ not for the faint hearted.
+
+
+ 5. Changes
+
+
+ 5.1. 0.85.3
o Fix the "-dedicated" option (thanks Oz) and add platform specific
- networking code (default) cwrather than SDLnet
+ networking code (default) rather than SDL_net
o Much needed OSX framework stuff from Kristian
o Add a persistent history feature (thanks Baker)
o Add a slider for scr_sbaralpha, which now defaults to 0.95
- (slightly transparent, allowing for nicer sbar)
+ (slightly transparent, allowing for nicer status bar)
+
+ o Allow for player messages longer than 32 chars
o Sockaddr fix for FreeBSD/OSX/etc networking
@@ -67,6 +107,8 @@
o Enumerate options menus
+ o Add a "prev weapon" menu item (from Sander)
+
o Small fix to Sound Block/Unblock on win32
o Lots of code fixes (some from uhexen2)
@@ -76,13 +118,14 @@
o Sys_Error calls Host_Shutdown
- 2.2. 0.85.2
+ 5.2. 0.85.2
o Replace the old "Screen size" slider with a "Scale" slider
o Don't constantly open and close condebug log
+
o Heap of C clean-ups
o Fix mapname sorting
@@ -104,7 +147,7 @@
o Add OSX Makefile (tested?)
- 2.3. 0.85.1
+ 5.3. 0.85.1
o 64 bit CPU support
@@ -125,7 +168,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
@@ -144,38 +186,7 @@
r_wateralpha, r_dynamic, r_novis
- 3. Downloads
-
-
- Source
-
- Linux binary
-
- Windows
-
-
-
- 4. Compiling
-
- Just extract the source tarball, then
-
- ______________________________________________________________________
- cd quakespasm-0.85.3
- make
- cp quakespasm /usr/local/games/quake (for eg)
- ______________________________________________________________________
-
-
- Use make DEBUG=1 for debugging.
- Optionally, HOME directory support can be enabled via the Misc/home-
- dir_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 envi-
- ronment that requires wxWidgets and cmake to install. The process is
- not for the faint hearted.
-
-
- 5. Todo
+ 6. Todo
o Ogg/Mp3 music file support
@@ -189,7 +200,7 @@
o Tie down the "-window/-fullscreen" options / behaviour ?
- 6. Links
+ 7. Links
QuakeSpasm Homepage