fte
/
quakespasm
mirror of https://github.com/Shpoike/Quakespasm.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

updated the documentation, also removed obsolete sections from it.

This commit is contained in:
Ozkan Sezer 2021-08-29 17:28:40 +03:00
parent 83af8d060f
commit 7ff5902881
3 changed files with 54 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
Linux/sgml/Quakespasm.sgml
View File

@ -137,29 +137,29 @@ A Quakespasm App (including program launcher and update framework) can be made u
Alternatively, have a look at <bf>Makefile.darwin</bf> for more instructions on building from a console. Alternatively, have a look at <bf>Makefile.darwin</bf> for more instructions on building from a console.
</p> </p>
<sect> Known Bugs <p> <sect> Quake '2021 re-release' <p>
Brightness issues should be fixed with GLSL gamma in 0.90.1, if your system supports OpenGL 2. For reference on older systems: QuakeSpasm 0.93.3 has initial support for playing the 2021 re-release content:
<newline>
Some versions of Xorg and SDL have brightness issues.
<newline>
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> <itemize>
<item><url url="http://sf.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched.tgz/download" <item> Copy the quakespasm exe to your rerelease installation.
name="Gamma patched libSDL (i686-linux)"></li> <item> Note: Do not mix-and-match original and rerelease contents: results may be unpredictable.
<item><url url="http://sf.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched-AMD64.tgz/download" <item> Extract the English localization file in the rerelease directory:<newline>
name="Gamma patched libSDL (x86_64-linux)"> <em>unzip QuakeEX.kpf localization/loc_english.txt</em><newline>
Note: the extracted file should be in the 'rerelease/localization' directory, not 'rerelease'.
<item> Run quakespasm as you normally do.
</itemize> </itemize>
<sect> Changes<p> <sect> Changes<p>
<sect1> Changes in 0.93.3<p> <sect1> Changes in 0.93.3<p>
<itemize> <itemize>
<item> Initial support for playing the 'Quake 2021 re-release' content.
<item> Fix rendering bug when cl_bobcycle was set to zero (sf.net bug/41) <item> Fix rendering bug when cl_bobcycle was set to zero (sf.net bug/41)
<item> Fixed buffer overflow with large char skybox names (sf.net bug/38) <item> Fixed buffer overflow with large char skybox names (sf.net bug/38)
<item> Fixed a missing MAXALIASFRAMES bounds check (sf.net bug/37) <item> Fixed a missing MAXALIASFRAMES bounds check (sf.net bug/37)
<item> OpenGL: workaround Intel UHD 600 driver bug (sf.net bug/39) <item> OpenGL: workaround Intel UHD 600 driver bug (sf.net bug/39)
<item> OpenGL: merged surface mark & cull optimizations from vkQuake. <item> OpenGL: merged surface mark & cull optimizations from vkQuake.
<item> Reject lit files if they're the wrong size (eg hipnotic/start.bsp vs id1/start.lit or just a bsp that no longer has any coloured lits, etc) <item> Reject lit files if they're the wrong size (eg hipnotic/start.bsp vs id1/start.lit or just a bsp that no longer has any coloured lits, etc)
<item> Support for external vis files.
<item> Save: remove CR/LFs from level name to avoids broken saves, e.g. with autumn_sp map. <item> Save: remove CR/LFs from level name to avoids broken saves, e.g. with autumn_sp map.
<item> Music: improvements to mp3 tag detection / skipping. <item> Music: improvements to mp3 tag detection / skipping.
<item> Music: umx loader fix for malformed / crafted files. <item> Music: umx loader fix for malformed / crafted files.
@ -546,12 +546,6 @@ these patched libSDL binaries may help.
</itemize> </itemize>
<sect> Todo <p>
<itemize>
<item>Add uHexen2's first person camera (and menu item)
<item>Native CD audio support (if desired). cd_sdl.c doesn't have proper volume controls and SDL2 doesn't support CD audio
</itemize>
<sect> Copyright <p> <sect> Copyright <p>
<itemize> <itemize>
<item>Quake and Quakespasm are released under the <url url="http://www.gnu.org/licenses/gpl-2.0.html" name="GNU GENERAL PUBLIC LICENSE Version 2"> <item>Quake and Quakespasm are released under the <url url="http://www.gnu.org/licenses/gpl-2.0.html" name="GNU GENERAL PUBLIC LICENSE Version 2">

58
Quakespasm.html
View File

@ -36,7 +36,7 @@
<LI><A NAME="toc4.3">4.3</A> <A HREF="Quakespasm.html#ss4.3">Mac OS X </A> <LI><A NAME="toc4.3">4.3</A> <A HREF="Quakespasm.html#ss4.3">Mac OS X </A>
</UL> </UL>
<P> <P>
<H2><A NAME="toc5">5.</A> <A HREF="Quakespasm.html#s5">Known Bugs </A></H2> <H2><A NAME="toc5">5.</A> <A HREF="Quakespasm.html#s5">Quake '2021 re-release' </A></H2>
<P> <P>
<H2><A NAME="toc6">6.</A> <A HREF="Quakespasm.html#s6">Changes</A></H2> <H2><A NAME="toc6">6.</A> <A HREF="Quakespasm.html#s6">Changes</A></H2>
@ -62,21 +62,17 @@
<LI><A NAME="toc6.18">6.18</A> <A HREF="Quakespasm.html#ss6.18">Changes in 0.85.1</A> <LI><A NAME="toc6.18">6.18</A> <A HREF="Quakespasm.html#ss6.18">Changes in 0.85.1</A>
</UL> </UL>
<P> <P>
<H2><A NAME="toc7">7.</A> <A HREF="Quakespasm.html#s7">Todo </A></H2> <H2><A NAME="toc7">7.</A> <A HREF="Quakespasm.html#s7">Copyright </A></H2>
<P> <P>
<H2><A NAME="toc8">8.</A> <A HREF="Quakespasm.html#s8">Copyright </A></H2> <H2><A NAME="toc8">8.</A> <A HREF="Quakespasm.html#s8">Contact </A></H2>
<P> <P>
<H2><A NAME="toc9">9.</A> <A HREF="Quakespasm.html#s9">Contact </A></H2> <H2><A NAME="toc9">9.</A> <A HREF="Quakespasm.html#s9">Links </A></H2>
<P>
<H2><A NAME="toc10">10.</A> <A HREF="Quakespasm.html#s10">Links </A></H2>
<HR> <HR>
<H2><A NAME="s1">1.</A> <A HREF="#toc1">About </A></H2>
<H2><A NAME="s1">1.</A> <A HREF="#toc1">About </A></H2>
<P> <P>
<A HREF="http://quakespasm.sourceforge.net">QuakeSpasm</A> <A HREF="http://quakespasm.sourceforge.net">QuakeSpasm</A>
@ -89,7 +85,6 @@ SDL is probably less buggy, but SDL2 has nicer features and smoother mouse input
<H2><A NAME="s2">2.</A> <A HREF="#toc2">Downloads </A></H2> <H2><A NAME="s2">2.</A> <A HREF="#toc2">Downloads </A></H2>
<P> <P>
<UL> <UL>
<LI> <LI>
@ -104,7 +99,6 @@ SDL is probably less buggy, but SDL2 has nicer features and smoother mouse input
<H2><A NAME="s3">3.</A> <A HREF="#toc3">Hints </A></H2> <H2><A NAME="s3">3.</A> <A HREF="#toc3">Hints </A></H2>
<P><EM>Visit the <P><EM>Visit the
<A HREF="http://www.celephais.net/fitzquake">FitzQuake homepage</A> for a full run-down of the engine's commands and variables.</EM></P> <A HREF="http://www.celephais.net/fitzquake">FitzQuake homepage</A> for a full run-down of the engine's commands and variables.</EM></P>
<P> <P>
@ -195,7 +189,6 @@ quakespasm.pak contains a default.cfg which has been updated to give some defaul
<H2><A NAME="s4">4.</A> <A HREF="#toc4">Compiling and Installation</A></H2> <H2><A NAME="s4">4.</A> <A HREF="#toc4">Compiling and Installation</A></H2>
<P>See the Downloads section to get the sourcecode, then below for platform specific instructions. <P>See the Downloads section to get the sourcecode, then below for platform specific instructions.
Quakespasm can also be built with the cross-platform Codeblocks.<BR> Quakespasm can also be built with the cross-platform Codeblocks.<BR>
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> 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>
@ -226,35 +219,34 @@ Compile time options include
<P>A Quakespasm App (including program launcher and update framework) can be made using the <B>Xcode</B> template found in the MacOSX directory.</P> <P>A Quakespasm App (including program launcher and update framework) can be made using the <B>Xcode</B> template found in the MacOSX directory.</P>
<P>Alternatively, have a look at <B>Makefile.darwin</B> for more instructions on building from a console.</P> <P>Alternatively, have a look at <B>Makefile.darwin</B> for more instructions on building from a console.</P>
<H2><A NAME="s5">5.</A> <A HREF="#toc5">Known Bugs </A></H2> <H2><A NAME="s5">5.</A> <A HREF="#toc5">Quake '2021 re-release' </A></H2>
<P>Brightness issues should be fixed with GLSL gamma in 0.90.1, if your system supports OpenGL 2. For reference on older systems:<BR> <P>QuakeSpasm 0.93.3 has initial support for playing the 2021 re-release content:
Some versions of Xorg and SDL have brightness issues.<BR>
Try setting "export SDL_VIDEO_X11_NODIRECTCOLOR=1", or if you have Xorg >= 7.5 and broken brightness,
these patched libSDL binaries may help.
<UL> <UL>
<LI> <LI> Copy the quakespasm exe to your rerelease installation.</LI>
<A HREF="http://sf.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched.tgz/download">Gamma patched libSDL (i686-linux)</A></LI> <LI> Note: Do not mix-and-match original and rerelease contents: results may be unpredictable.</LI>
<LI> <LI> Extract the English localization file in the rerelease directory:<BR>
<A HREF="http://sf.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched-AMD64.tgz/download">Gamma patched libSDL (x86_64-linux)</A></LI> <EM>unzip QuakeEX.kpf localization/loc_english.txt</EM><BR>
Note: the extracted file should be in the 'rerelease/localization' directory, not 'rerelease'.</LI>
<LI> Run quakespasm as you normally do.</LI>
</UL> </UL>
</P> </P>
<H2><A NAME="s6">6.</A> <A HREF="#toc6">Changes</A></H2> <H2><A NAME="s6">6.</A> <A HREF="#toc6">Changes</A></H2>
<H2><A NAME="ss6.1">6.1</A> <A HREF="#toc6.1">Changes in 0.93.3</A> <H2><A NAME="ss6.1">6.1</A> <A HREF="#toc6.1">Changes in 0.93.3</A>
</H2> </H2>
<P> <P>
<UL> <UL>
<LI> Initial support for playing the 'Quake 2021 re-release' content.</LI>
<LI> Fix rendering bug when cl_bobcycle was set to zero (sf.net bug/41)</LI> <LI> Fix rendering bug when cl_bobcycle was set to zero (sf.net bug/41)</LI>
<LI> Fixed buffer overflow with large char skybox names (sf.net bug/38)</LI> <LI> Fixed buffer overflow with large char skybox names (sf.net bug/38)</LI>
<LI> Fixed a missing MAXALIASFRAMES bounds check (sf.net bug/37)</LI> <LI> Fixed a missing MAXALIASFRAMES bounds check (sf.net bug/37)</LI>
<LI> OpenGL: workaround Intel UHD 600 driver bug (sf.net bug/39)</LI> <LI> OpenGL: workaround Intel UHD 600 driver bug (sf.net bug/39)</LI>
<LI> OpenGL: merged surface mark &amp; cull optimizations from vkQuake.</LI> <LI> OpenGL: merged surface mark &amp; cull optimizations from vkQuake.</LI>
<LI> Reject lit files if they're the wrong size (eg hipnotic/start.bsp vs id1/start.lit or just a bsp that no longer has any coloured lits, etc)</LI> <LI> Reject lit files if they're the wrong size (eg hipnotic/start.bsp vs id1/start.lit or just a bsp that no longer has any coloured lits, etc)</LI>
<LI> Support for external vis files.</LI>
<LI> Save: remove CR/LFs from level name to avoids broken saves, e.g. with autumn_sp map.</LI> <LI> Save: remove CR/LFs from level name to avoids broken saves, e.g. with autumn_sp map.</LI>
<LI> Music: improvements to mp3 tag detection / skipping.</LI> <LI> Music: improvements to mp3 tag detection / skipping.</LI>
<LI> Music: umx loader fix for malformed / crafted files.</LI> <LI> Music: umx loader fix for malformed / crafted files.</LI>
@ -366,7 +358,6 @@ these patched libSDL binaries may help.
<H2><A NAME="ss6.7">6.7</A> <A HREF="#toc6.7">Changes in 0.91.0</A> <H2><A NAME="ss6.7">6.7</A> <A HREF="#toc6.7">Changes in 0.91.0</A>
</H2> </H2>
<H3>Bugfixes</H3> <H3>Bugfixes</H3>
<P> <P>
@ -426,7 +417,6 @@ these patched libSDL binaries may help.
<H2><A NAME="ss6.8">6.8</A> <A HREF="#toc6.8">Changes in 0.90.1</A> <H2><A NAME="ss6.8">6.8</A> <A HREF="#toc6.8">Changes in 0.90.1</A>
</H2> </H2>
<H3>Bugfixes</H3> <H3>Bugfixes</H3>
<P> <P>
@ -710,16 +700,7 @@ these patched libSDL binaries may help.
</P> </P>
<H2><A NAME="s7">7.</A> <A HREF="#toc7">Todo </A></H2> <H2><A NAME="s7">7.</A> <A HREF="#toc7">Copyright </A></H2>
<P>
<UL>
<LI>Add uHexen2's first person camera (and menu item)</LI>
<LI>Native CD audio support (if desired). cd_sdl.c doesn't have proper volume controls and SDL2 doesn't support CD audio</LI>
</UL>
</P>
<H2><A NAME="s8">8.</A> <A HREF="#toc8">Copyright </A></H2>
<P> <P>
<UL> <UL>
@ -730,7 +711,7 @@ these patched libSDL binaries may help.
</UL> </UL>
</P> </P>
<H2><A NAME="s9">9.</A> <A HREF="#toc9">Contact </A></H2> <H2><A NAME="s8">8.</A> <A HREF="#toc8">Contact </A></H2>
<P> <P>
<UL> <UL>
@ -745,8 +726,7 @@ these patched libSDL binaries may help.
</UL> </UL>
</P> </P>
<H2><A NAME="s10">10.</A> <A HREF="#toc10">Links </A></H2> <H2><A NAME="s9">9.</A> <A HREF="#toc9">Links </A></H2>
<P> <P>
<UL> <UL>

64
Quakespasm.txt
View File

@ -17,7 +17,8 @@
4.2 Windows 4.2 Windows
4.3 Mac OS X 4.3 Mac OS X
5. Known Bugs 5. Quake '2021 re-release'
6. Changes 6. Changes
6.1 Changes in 0.93.3 6.1 Changes in 0.93.3
6.2 Changes in 0.93.2 6.2 Changes in 0.93.2
@ -48,10 +49,9 @@
6.17 Changes in 0.85.2 6.17 Changes in 0.85.2
6.18 Changes in 0.85.1 6.18 Changes in 0.85.1
7. Todo 7. Copyright
8. Copyright 8. Contact
9. Contact 9. Links
10. Links
______________________________________________________________________ ______________________________________________________________________
@ -182,35 +182,22 @@
menu: menu:
o Back - alias for TAB o Back - alias for TAB
o Start - alias for ESC o Start - alias for ESC
o DPad, analog sticks - mapped to arrow keys o DPad, analog sticks - mapped to arrow keys
o A Button - alias for ENTER in menus o A Button - alias for ENTER in menus
o B Button - alias for ESC in menus o B Button - alias for ESC in menus
These buttons can be bound normally: These buttons can be bound normally:
o LTRIGGER - Left trigger o LTRIGGER - Left trigger
o RTRIGGER - Right trigger o RTRIGGER - Right trigger
o LSHOULDER - Left shoulder button o LSHOULDER - Left shoulder button
o RSHOULDER - Right shoulder button o RSHOULDER - Right shoulder button
o LTHUMB - Clicking the left thumbstick o LTHUMB - Clicking the left thumbstick
o RTHUMB - Clicking the right thumbstick o RTHUMB - Clicking the right thumbstick
o ABUTTON o ABUTTON
o BBUTTON o BBUTTON
o XBUTTON o XBUTTON
o YBUTTON o YBUTTON
quakespasm.pak contains a default.cfg which has been updated to give quakespasm.pak contains a default.cfg which has been updated to give
@ -267,21 +254,22 @@
building from a console. building from a console.
5. Known Bugs 5. Quake '2021 re-release'
Brightness issues should be fixed with GLSL gamma in 0.90.1, if your QuakeSpasm 0.93.3 has initial support for playing the 2021 re-release
system supports OpenGL 2. For reference on older systems: content:
Some versions of Xorg and SDL have brightness issues. o Copy the quakespasm exe to your rerelease installation.
Try setting "export SDL_VIDEO_X11_NODIRECTCOLOR=1", or if you have
Xorg >= 7.5 and broken brightness, these patched libSDL binaries may
help.
o Gamma patched libSDL (i686-linux) o Note: Do not mix-and-match original and rerelease contents: results
http://sf.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched.tgz/download may be unpredictable.
o Gamma patched libSDL (x86_64-linux) o Extract the English localization file in the rerelease directory:
http://sf.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched-AMD64.tgz/download unzip QuakeEX.kpf localization/loc_english.txt
Note: the extracted file should be in the 'rerelease/localization'
directory, not 'rerelease'.
o Run quakespasm as you normally do.
6. Changes 6. Changes
@ -289,6 +277,8 @@
6.1. Changes in 0.93.3 6.1. Changes in 0.93.3
o Initial support for playing the 'Quake 2021 re-release' content.
o Fix rendering bug when cl_bobcycle was set to zero (sf.net bug/41) o Fix rendering bug when cl_bobcycle was set to zero (sf.net bug/41)
o Fixed buffer overflow with large char skybox names (sf.net bug/38) o Fixed buffer overflow with large char skybox names (sf.net bug/38)
@ -303,6 +293,8 @@
vs id1/start.lit or just a bsp that no longer has any coloured vs id1/start.lit or just a bsp that no longer has any coloured
lits, etc) lits, etc)
o Support for external vis files.
o Save: remove CR/LFs from level name to avoids broken saves, e.g. o Save: remove CR/LFs from level name to avoids broken saves, e.g.
with autumn_sp map. with autumn_sp map.
@ -1032,15 +1024,7 @@
r_wateralpha, r_dynamic, r_novis r_wateralpha, r_dynamic, r_novis
7. Todo 7. Copyright
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 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
@ -1050,7 +1034,7 @@
http://creativecommons.org/licenses/by/3.0/legalcode http://creativecommons.org/licenses/by/3.0/legalcode
9. Contact 8. Contact
o QuakeSpasm Project page: o QuakeSpasm Project page:
https://sourceforge.net/projects/quakespasm/ https://sourceforge.net/projects/quakespasm/
@ -1063,7 +1047,7 @@
Sander <mailto:gmail - dot - com - username - a.h.vandijk> Sander <mailto:gmail - dot - com - username - a.h.vandijk>
10. Links 9. Links
o QuakeSpasm Homepage: http://quakespasm.sourceforge.net o QuakeSpasm Homepage: http://quakespasm.sourceforge.net