update the plain text doc for possibly better readability.

git-svn-id: svn://svn.code.sf.net/p/quakespasm/code/trunk/quakespasm@1192 af15c1b1-3010-417e-b628-4374ebc0bcbd
This commit is contained in:
Ozkan Sezer 2015-03-17 21:56:01 +00:00
parent 5684bb72f6
commit 59fe64c7ab

View file

@ -4,7 +4,6 @@
Table of Contents Table of Contents
1. About 1. About
2. Downloads 2. Downloads
3. Hints 3. Hints
@ -38,12 +37,12 @@
9. Contact 9. Contact
10. Links 10. Links
______________________________________________________________________ ______________________________________________________________________
Page last edited Mar. 17, 2015 Page last edited Mar. 17, 2015
1. About 1. About
QuakeSpasm <http://quakespasm.sourceforge.net> is a Quake 1 engine QuakeSpasm <http://quakespasm.sourceforge.net> is a Quake 1 engine
@ -54,19 +53,19 @@
includes a new sound driver, some graphical niceities, and numerous includes a new sound driver, some graphical niceities, and numerous
bug-fixes and minor improvements. bug-fixes and minor improvements.
2. Downloads
2. Downloads
o Project Downloads <http://quakespasm.sourceforge.net/download.htm> o Project Downloads <http://quakespasm.sourceforge.net/download.htm>
o Automatic Builds <http://quakespasm.ericwa.com/job/quakespasm/> o Automatic Builds <http://quakespasm.ericwa.com/job/quakespasm/>
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 Quakespasm's custom data is stored in "quakespasm.pak". Install o Quakespasm's custom data is stored in "quakespasm.pak". Install
@ -108,6 +107,7 @@
o See <Quakespasm-Music.txt> for more details. o See <Quakespasm-Music.txt> for more details.
4. Compiling and Installation 4. Compiling and Installation
Quakespasm's (optional) custom data is now stored in the file Quakespasm's (optional) custom data is now stored in the file
@ -159,6 +159,7 @@
Alternatively, have a look at Makefile.darwin for more instructions on Alternatively, have a look at Makefile.darwin for more instructions on
building from a console. building from a console.
5. Known Bugs 5. Known Bugs
Brightness issues should be fixed with GLSL gamma in 0.90.1, if your Brightness issues should be fixed with GLSL gamma in 0.90.1, if your
@ -173,8 +174,7 @@
<http://sourceforge.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched.tgz/download> <http://sourceforge.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched.tgz/download>
o Gamma patched libSDL (x86_64-linux) o Gamma patched libSDL (x86_64-linux)
<http://sourceforge.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched- <http://sourceforge.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched-AMD64.tgz/download>
AMD64.tgz/download>
The "game" command doesn't execute quake.rc in the new game directory The "game" command doesn't execute quake.rc in the new game directory
being switched to. This means any custom key bindings in a mod's being switched to. This means any custom key bindings in a mod's
@ -183,12 +183,14 @@
instead of using the game console command. Or, after running the game instead of using the game console command. Or, after running the game
command, you can run "exec quake.rc" by yourself (YMMV). command, you can run "exec quake.rc" by yourself (YMMV).
6. Changes 6. Changes
6.1. Changes in 0.90.1 6.1. Changes in 0.90.1
6.1.1. Bugfixes
6.1.1. Bugfixes
o Fix dynamic light artifact where changing lightmap are rendered one o Fix dynamic light artifact where changing lightmap are rendered one
frame late (bug introduced in 0.90.0). frame late (bug introduced in 0.90.0).
@ -207,15 +209,15 @@
o Allow loading saves with } character in quoted strings, fixes issue o Allow loading saves with } character in quoted strings, fixes issue
with retrojam1_skacky.bsp. with retrojam1_skacky.bsp.
6.1.2. Performance
6.1.2. Performance
o Use multithreaded OpenGL on OS X for better performance. o Use multithreaded OpenGL on OS X for better performance.
o New, faster mdl renderer using GLSL. Disable with "-noglslalias". o New, faster mdl renderer using GLSL. Disable with "-noglslalias".
6.1.3. Interface/visual improvements
6.1.3. Interface/visual improvements
o Support pausing demo playback with the "pause" command. o Support pausing demo playback with the "pause" command.
@ -228,20 +230,20 @@
o Use high-quality water by default (r_oldwater 0). o Use high-quality water by default (r_oldwater 0).
6.1.4. Code cleanup
6.1.4. Code cleanup
o Clean up IDE project files to build on fresh systems. o Clean up IDE project files to build on fresh systems.
o Update 3rd-party libraries. o Update 3rd-party libraries.
6.2. Changes in 0.90.0
6.2. Changes in 0.90.0
o Fix issues on Windows systems with DPI scaling. o Fix issues on Windows systems with DPI scaling.
o Unix/Mac user directories support. Disabled by default, 'make o Unix/Mac user directories support. Disabled by default,
DO_USERDIRS=1' to enable it. 'make DO_USERDIRS=1' to enable it.
o SDL2 support. Disabled by default, 'make USE_SDL2=1' to enable it. o SDL2 support. Disabled by default, 'make USE_SDL2=1' to enable it.
@ -287,7 +289,7 @@
o Music and sfx now mixed at 44100Hz to avoid downsampling music. o Music and sfx now mixed at 44100Hz to avoid downsampling music.
Low-pass filter applied to the sfx if -sndspeed is 11025 (the Low-pass filter applied to the sfx if -sndspeed is 11025 (the
default), to preserve the same sound quality as 0.85.9. New default), to preserve the same sound quality as 0.85.9. New
-mixspeed option sets the rate for mixing sfx and music, and output -mixspeed option sets the rate for mixing sfx and music, and output
to the OS (default 44100), setting it to 11025 reverts to 0.85.9 to the OS (default 44100), setting it to 11025 reverts to 0.85.9
behaviour. New snd_filterquality cvar, value can be between 1 behaviour. New snd_filterquality cvar, value can be between 1
@ -343,8 +345,8 @@
o Other fixes and clean-ups. o Other fixes and clean-ups.
6.3. Changes in 0.85.9
6.3. Changes in 0.85.9
o Fixes for several undefined behaviors in C code (gcc-4.8 support.) o Fixes for several undefined behaviors in C code (gcc-4.8 support.)
@ -390,8 +392,8 @@
o Several other minor fixes/cleanups. o Several other minor fixes/cleanups.
6.4. Changes in 0.85.8
6.4. Changes in 0.85.8
o Made Quake shareware 1.00 and 1.01 versions to be recognized o Made Quake shareware 1.00 and 1.01 versions to be recognized
properly. properly.
@ -437,8 +439,8 @@
o Miscellaneous source code cleanups. o Miscellaneous source code cleanups.
6.5. Changes in 0.85.7
6.5. Changes in 0.85.7
o Added support for cross-level demo playback o Added support for cross-level demo playback
@ -463,8 +465,8 @@
o Several other small changes mostly invisible to the end-user o Several other small changes mostly invisible to the end-user
6.6. Changes in 0.85.6
6.6. Changes in 0.85.6
o More work for string buffer safety o More work for string buffer safety
@ -476,8 +478,8 @@
o Minor SDL video fixes. o Minor SDL video fixes.
6.7. Changes in 0.85.5
6.7. Changes in 0.85.5
o SDL input driver updated adding native keymap and dead key support o SDL input driver updated adding native keymap and dead key support
to the console to the console
@ -507,8 +509,8 @@
o Several code updates from uHexen2 project, several code cleanups. o Several code updates from uHexen2 project, several code cleanups.
6.8. Changes in 0.85.4
6.8. Changes in 0.85.4
o Implement music (OGG, MP3, WAV) playback o Implement music (OGG, MP3, WAV) playback
@ -535,8 +537,8 @@
o Other minor sound and cdaudio updates o Other minor sound and cdaudio updates
6.9. Changes in 0.85.3
6.9. Changes in 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
@ -572,8 +574,8 @@
o Add a "-cd" option to let the CD Player work in dedicated mode, and o Add a "-cd" option to let the CD Player work in dedicated mode, and
some other CD tweaks. some other CD tweaks.
6.10. Changes in 0.85.2
6.10. Changes in 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
@ -600,8 +602,8 @@
o Add OSX Makefile (tested?) o Add OSX Makefile (tested?)
6.11. Changes in 0.85.1
6.11. Changes in 0.85.1
o 64 bit CPU support o 64 bit CPU support
@ -638,8 +640,8 @@
o Changes to cvar persistence gl_flashblend (default 0), r_shadow, o Changes to cvar persistence gl_flashblend (default 0), r_shadow,
r_wateralpha, r_dynamic, r_novis r_wateralpha, r_dynamic, r_novis
7. Todo
7. Todo
o Add uHexen2's first person camera (and menu item) o Add uHexen2's first person camera (and menu item)
@ -648,8 +650,8 @@
o Test usb keyboards. o Test usb keyboards.
8. Copyright
8. Copyright
o Quake and Quakespasm are released under the GNU GENERAL PUBLIC o Quake and Quakespasm are released under the GNU GENERAL PUBLIC
LICENSE Version 2 <http://www.gnu.org/licenses/gpl-2.0.html> LICENSE Version 2 <http://www.gnu.org/licenses/gpl-2.0.html>
@ -658,8 +660,8 @@
CREATIVE COMMONS PUBLIC LICENSE CREATIVE COMMONS PUBLIC LICENSE
<http://creativecommons.org/licenses/by/3.0/legalcode> <http://creativecommons.org/licenses/by/3.0/legalcode>
9. Contact
9. Contact
o QuakeSpasm Project page o QuakeSpasm Project page
<http://sourceforge.net/projects/quakespasm> <http://sourceforge.net/projects/quakespasm>
@ -672,8 +674,8 @@
Sander <mailto:gmail - dot - com - username - a.h.vandijk>, Sander <mailto:gmail - dot - com - username - a.h.vandijk>,
Stevenaaus <mailto:yahoo - dot - com - username - stevenaaus> Stevenaaus <mailto:yahoo - dot - com - username - stevenaaus>
10. Links
10. Links
o QuakeSpasm Homepage <http://quakespasm.sourceforge.net> o QuakeSpasm Homepage <http://quakespasm.sourceforge.net>
@ -686,4 +688,3 @@
o Inside 3D forums <http://forums.inside3d.com/viewforum.php?f=14> o Inside 3D forums <http://forums.inside3d.com/viewforum.php?f=14>