fte/quakespasm
2
0
Fork 0
mirror of https://github.com/Shpoike/Quakespasm.git synced 2025-02-19 02:22:01 +00:00
Code Issues Projects Releases Packages Wiki Activity

minor doco edits

Browse source 
git-svn-id: svn+ssh://svn.code.sf.net/p/quakespasm/code/trunk@1327 af15c1b1-3010-417e-b628-4374ebc0bcbd
This commit is contained in:
sezero 2016-07-01 07:00:02 +00:00
parent 8b05d42508
commit eebbc64863
3 changed files with 72 additions and 84 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
quakespasm/Linux/sgml/Quakespasm.sgml
View file

@ -9,7 +9,7 @@
<sect> About <p>
<url url="http://quakespasm.sourceforge.net" name="QuakeSpasm">
is a modern, cross-platform, Quake 1 engine based on <url url="http://www.celephais.net/fitzquake" name="FitzQuake">.
is a modern, cross-platform Quake 1 engine based on <url url="http://www.celephais.net/fitzquake" name="FitzQuake">.
</p><p>
It includes support for 64 bit CPUs and custom music playback, a new
sound driver, some graphical niceities, and numerous bug-fixes and other improvements.
@ -34,7 +34,7 @@ SDL is probably less buggy, but SDL 2 has nicer features and smoother mouse inpu
<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>"
<item>For different sound backend drivers use "<bf>SDL_AUDIODRIVER=</bf><em>DRIVER</em><bf> ./quakespasm</bf>"
, where DRIVER may be alsa, dsp, pulse, esd ...
<item><bf>Shift+Escape</bf> draws the Console.
@ -147,9 +147,9 @@ Some versions of Xorg and SDL have brightness issues.
Try setting "export SDL_VIDEO_X11_NODIRECTCOLOR=1", or if you have Xorg >= 7.5 and broken brightness,
these patched libSDL binaries may help.
<itemize>
<item><url url="http://sourceforge.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched.tgz/download"
<item><url url="http://sf.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched.tgz/download"
name="Gamma patched libSDL (i686-linux)"></li>
<item><url url="http://sourceforge.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched-AMD64.tgz/download"
<item><url url="http://sf.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched-AMD64.tgz/download"
name="Gamma patched libSDL (x86_64-linux)">
</itemize>
<p>

8
quakespasm/Quakespasm.html
View file

@ -75,7 +75,7 @@
<P>
<A HREF="http://quakespasm.sourceforge.net">QuakeSpasm</A>
is a modern, cross-platform, Quake 1 engine based on
is a modern, cross-platform Quake 1 engine based on
<A HREF="http://www.celephais.net/fitzquake">FitzQuake</A>.</P>
<P>It includes support for 64 bit CPUs and custom music playback, a new
sound driver, some graphical niceities, and numerous bug-fixes and other improvements.</P>
@ -106,7 +106,7 @@ SDL is probably less buggy, but SDL 2 has nicer features and smoother mouse inpu
</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>"
<LI>For different sound backend 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>
@ -234,9 +234,9 @@ Try setting "export SDL_VIDEO_X11_NODIRECTCOLOR=1", or if you have Xorg >= 7.5 a
these patched libSDL binaries may help.
<UL>
<LI>
<A HREF="http://sourceforge.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched.tgz/download">Gamma patched libSDL (i686-linux)</A></LI>
<A HREF="http://sf.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched.tgz/download">Gamma patched libSDL (i686-linux)</A></LI>
<LI>
<A HREF="http://sourceforge.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched-AMD64.tgz/download">Gamma patched libSDL (x86_64-linux)</A></LI>
<A HREF="http://sf.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched-AMD64.tgz/download">Gamma patched libSDL (x86_64-linux)</A></LI>
</UL>
</P>
<P>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 config.cfg or special settings in a quake.rc won't be loaded. The only workaround is launching the engine with the -game command-line switch instead of using the game console command. Or, after running the game command, you can run "exec quake.rc" by yourself (YMMV).</P>

126
quakespasm/Quakespasm.txt
View file

@ -4,7 +4,6 @@
Table of Contents
1. About
2. Downloads
3. Hints
@ -49,16 +48,16 @@
9. Contact
10. Links
______________________________________________________________________
Page last edited: July 2016
1. About
QuakeSpasm <http://quakespasm.sourceforge.net> is a modern, cross-
platform, Quake 1 engine based on FitzQuake
platform Quake 1 engine based on FitzQuake
<http://www.celephais.net/fitzquake>.
It includes support for 64 bit CPUs and custom music playback, a new
@ -69,28 +68,28 @@
which one works best for you. SDL is probably less buggy, but SDL2
has nicer features and smoother mouse input - though no CD support.
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-sdl2/
o Automatic Builds <http://quakespasm.ericwa.com/job/quakespasm-
sdl2/>
3. Hints
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 ...
o For different sound backend drivers use :
"SDL_AUDIODRIVER=DRIVER ./quakespasm"
where DRIVER may be alsa, dsp, pulse, esd ...
o Shift+Escape draws the Console.
@ -126,7 +125,7 @@
o Use the "-noextmusic" option to disable this feature.
o See <Quakespasm-Music.txt> for more details.
o See Quakespasm-Music.txt for more details.
3.2. Controller Support
@ -137,13 +136,12 @@
the right for looking.
If your controller doesn't work you can try placing this file
<https://raw.githubusercontent.com/gabomdq/SDL_GameControllerDB/master/gamecontrollerdb.txt>
https://raw.githubusercontent.com/gabomdq/SDL_GameControllerDB/master/gamecontrollerdb.txt
in your Quake directory, it is a community-maintained database that
adds support for more controllers to SDL2.
3.2.1. Cvars
o joy_deadzone - Fraction of the stick travel to be deadzone, between
0 and 1. Default 0.2.
@ -174,7 +172,6 @@
Some of the controller buttons are hardcoded to allow navigating the
menu:
o Back - alias for TAB
o Start - alias for ESC
@ -187,7 +184,6 @@
These buttons can be bound normally:
o LTRIGGER - Left trigger
o RTRIGGER - Right trigger
@ -208,22 +204,23 @@
o YBUTTON
quakespasm.pak contains a default.cfg which has been updated to
give some default bindings. L/R shoulder buttons are bound to
weapon switching, and L/R triggers are jump and attack.
quakespasm.pak contains a default.cfg which has been updated to give
some default bindings. L/R shoulder buttons are bound to weapon
switching, and L/R triggers are jump and attack.
The controller support started as Jeremiah Sypult's implementation in
Quakespasm-Rift and also uses ideas and code from LordHavoc
(DarkPlaces).
4. Compiling and Installation
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 checkout the latest version of QuakeSpasm, do: svn co
svn://svn.code.sf.net/p/quakespasm/code/trunk/quakespasm
To checkout the latest version of QuakeSpasm, do:
svn co svn://svn.code.sf.net/p/quakespasm/code/trunk/quakespasm
4.1. Linux/Unix
@ -267,6 +264,7 @@
Alternatively, have a look at Makefile.darwin for more instructions on
building from a console.
5. Known Bugs
Brightness issues should be fixed with GLSL gamma in 0.90.1, if your
@ -278,11 +276,10 @@
help.
o Gamma patched libSDL (i686-linux)
<http://sourceforge.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched.tgz/download>
http://sf.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched.tgz/download
o Gamma patched libSDL (x86_64-linux)
<http://sourceforge.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched-
AMD64.tgz/download>
http://sf.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched-AMD64.tgz/download
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
@ -291,10 +288,11 @@
instead of using the game console command. Or, after running the game
command, you can run "exec quake.rc" by yourself (YMMV).
6. Changes
6.1. Changes in 0.92.0
6.1. Changes in 0.92.0
o SDL2 Game Controller support.
@ -330,11 +328,11 @@
o Updated some of the third-party libraries. Other fixes/clean-ups.
6.2. Changes in 0.91.0
6.2.1. Bugfixes
o Fix unwanted fog mode change upon video restart.
o Work around Intel 855 bug in status bar drawing with "r_oldwater 0"
@ -371,7 +369,6 @@
6.2.2. Visual improvements
o New cvars r_lavaalpha, r_slimealpha, r_telealpha for fine-tuning
specific liquid opacities (from DirectQ/RMQEngine, non-archived,
default to 0), and new worldspawn keys _wateralpha, _lavaalpha,
@ -383,7 +380,6 @@
6.2.3. Interface improvements
o New r_pos command to show player position.
o NaN detection in traceline with "developer 1" set now warns instead
@ -391,12 +387,10 @@
6.2.4. Code cleanup / Other
o Update third-party libraries.
6.2.5. Raised limits
o Default max_edicts 8192 (was 2048) and no longer saved to
config.cfg.
@ -406,18 +400,18 @@
o Raised MAX_SFX to 1024 (was 512).
6.3. Changes in 0.90.1
6.3.1. Bugfixes
o Fix dynamic light artifact where changing lightmap are rendered one
frame late (bug introduced in 0.90.0).
o Fix texture memory leak when changing video modes with SDL2.
o Fix rare incorrect mdl lighting on 64-bit builds. (details here.)
<http://forums.insideqc.com/viewtopic.php?f=3&t=5620>
o Fix rare incorrect mdl lighting on 64-bit builds. (details here:
http://forums.insideqc.com/viewtopic.php?f=3&t=5620)
o Fix fullbrights turning black after "kill" command (bug introduced
in 0.90.0).
@ -434,14 +428,12 @@
6.3.2. Performance
o Use multithreaded OpenGL on OS X for better performance.
o New, faster mdl renderer using GLSL. Disable with "-noglslalias".
6.3.3. Visual improvements
o New gamma correction implementation using GLSL. Fixes all known
gamma issues (affecting the full display, persisting after
quitting, or darkening the screen on OS X). Disable with
@ -456,7 +448,6 @@
6.3.4. Interface improvements
o Support pausing demo playback with the "pause" command.
o Autocompletion for "game", "record", "playdemo".
@ -474,18 +465,17 @@
6.3.5. Code cleanup
o Clean up IDE project files to build on fresh systems.
o Update 3rd-party libraries.
6.4. Changes in 0.90.0
6.4. Changes in 0.90.0
o Fix issues on Windows systems with DPI scaling.
o Unix/Mac user directories support. Disabled by default, 'make
DO_USERDIRS=1' to enable it.
o Unix/Mac user directories support. Disabled by default,
'make DO_USERDIRS=1' to enable it.
o SDL2 support. Disabled by default, 'make USE_SDL2=1' to enable it.
@ -587,8 +577,8 @@
o Other fixes and clean-ups.
6.5. Changes in 0.85.9
6.5. Changes in 0.85.9
o Fixes for several undefined behaviors in C code (gcc-4.8 support.)
@ -634,8 +624,8 @@
o Several other minor fixes/cleanups.
6.6. Changes in 0.85.8
6.6. Changes in 0.85.8
o Made Quake shareware 1.00 and 1.01 versions to be recognized
properly.
@ -681,8 +671,8 @@
o Miscellaneous source code cleanups.
6.7. Changes in 0.85.7
6.7. Changes in 0.85.7
o Added support for cross-level demo playback
@ -707,8 +697,8 @@
o Several other small changes mostly invisible to the end-user
6.8. Changes in 0.85.6
6.8. Changes in 0.85.6
o More work for string buffer safety
@ -720,8 +710,8 @@
o Minor SDL video fixes.
6.9. Changes in 0.85.5
6.9. Changes in 0.85.5
o SDL input driver updated adding native keymap and dead key support
to the console
@ -751,8 +741,8 @@
o Several code updates from uHexen2 project, several code cleanups.
6.10. Changes in 0.85.4
6.10. Changes in 0.85.4
o Implement music (OGG, MP3, WAV) playback
@ -779,8 +769,8 @@
o Other minor sound and cdaudio updates
6.11. Changes in 0.85.3
6.11. Changes in 0.85.3
o Fix the "-dedicated" option (thanks Oz) and add platform specific
networking code (default) rather than SDL_net
@ -816,8 +806,8 @@
o Add a "-cd" option to let the CD Player work in dedicated mode, and
some other CD tweaks.
6.12. Changes in 0.85.2
6.12. Changes in 0.85.2
o Replace the old "Screen size" slider with a "Scale" slider
@ -844,8 +834,8 @@
o Add OSX Makefile (tested?)
6.13. Changes in 0.85.1
6.13. Changes in 0.85.1
o 64 bit CPU support
@ -882,50 +872,48 @@
o Changes to cvar persistence gl_flashblend (default 0), r_shadow,
r_wateralpha, r_dynamic, r_novis
7. Todo
7. Todo
o Add uHexen2's first person camera (and menu item)
o Native CD audio support (if desired). cd_sdl.c doesn't have proper
volume controls and SDL2 doesn't support CD audio
8. Copyright
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
o Quakespasm console background image by AAS, released under the
CREATIVE COMMONS PUBLIC LICENSE
<http://creativecommons.org/licenses/by/3.0/legalcode>
CREATIVE COMMONS PUBLIC LICENSE:
http://creativecommons.org/licenses/by/3.0/legalcode
9. Contact
o QuakeSpasm Project page:
http://sourceforge.net/projects/quakespasm
o QuakeSpasm Project page
<http://sourceforge.net/projects/quakespasm>
o Bug reports:
http://sourceforge.net/p/quakespasm/bugs/?source=navbar
o Bug reports
<http://sourceforge.net/p/quakespasm/bugs/?source=navbar>
o Ozkan <mailto:gmail - dot - com - username - sezeroz>
Eric <mailto:gmail - dot - com - username - ewasylishen>
Sander <mailto:gmail - dot - com - username - a.h.vandijk>
Stevenaaus <mailto:yahoo - dot - com - username - stevenaaus>
o Ozkan <mailto:gmail - dot - com - username - sezeroz>, 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 QuakeSpasm Homepage <http://quakespasm.sourceforge.net>
o Downloads: http://quakespasm.sourceforge.net/download.htm
o Downloads <http://quakespasm.sourceforge.net/download.htm>
o FitzQuake Homepage <http://www.celephais.net/fitzquake>
o Func Quakespasm forum
<http://www.celephais.net/board/view_thread.php?id=60452>
o Inside3D forums <http://forums.insideqc.com>
o FitzQuake Homepage: http://www.celephais.net/fitzquake
o Func Quakespasm forum:
http://www.celephais.net/board/view_thread.php?id=60452
o Inside3D forums: http://forums.insideqc.com