Docs/FAQ.html

   1 <!--  AFT (Almost Free Text) source file for Nexuiz FAQ -->
   2 <!--  WARNING: ALWAYS RUN AFT TWICE! (otherwise the toc is missing/not up to date) -->
   3 <!--  use AFT v5.096 or later (http://www.maplefish.com/todd/aft.html) -->
   4 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   5 <html>
   6 <head>
   7 <title>Nexuiz 3 FAQ</title>
   8         <meta name="author" content="">
   9         <meta name="GENERATOR" content = "Almost Free Text v5.096; Copyright 1996-2005 Todd Coram. All rights reserved.">
  10 <style type="text/css">
  11   <!--
  12 html { background: #eee; color: #000; }
  13
  14 body { background: #eee; color: #000; margin: 0; padding: 0;}
  15
  16 div.body {
  17         background: #fff; color: #000;
  18         margin: 0 1em 0 1em; padding: 1em;
  19         font-family: serif;
  20         font-size: 1em; line-height: 1.2em;
  21         border-width: 0 1px 0 1px;
  22         border-style: solid;
  23         border-color: #aaa;
  24 }
  25
  26 div.block {
  27         background: #F8F8FF; color: #000;
  28         margin: 1em; padding: 0 1em 0 1em;
  29         border-width: 1px;
  30         border-style: solid;
  31         border-color: #909090;
  32 }
  33
  34 table {
  35         background: #F8F8F8; color: #000;
  36         margin: 1em;
  37         border-width: 0 0 0 1px;
  38         border-style: solid;
  39         border-color: #C0C0C0;
  40 }
  41
  42 td {
  43         border-width: 0 1px 1px 0;
  44         border-style: solid;
  45         border-color: #C0C0C0;
  46 }
  47
  48 th {
  49         background: #F8F8FF;
  50         border-width: 1px 1px 2px 0;
  51         border-style: solid;
  52         border-color: #C0C0C0;
  53 }
  54
  55
  56 /* body text, headings, and rules */
  57
  58 p { margin: 0; text-indent: 0em; margin: 0 0 0.5em 0 }
  59
  60 h1, h2, h3, h4, h5, h6 {
  61         color: #206020; background: transparent;
  62         font-family: Optima, Arial, Helvetica, sans-serif;
  63         font-weight: normal;
  64 }
  65
  66 h1 { font-size: 1.69em; margin: 1.4em 0 0.4em 0; }
  67 h2 { font-size: 1.44em; margin: 1.4em 0 0.4em 0; }
  68 h3 { font-size: 1.21em; margin: 1.4em 0 0.4em 0; }
  69 h4 { font-size: 1.00em; margin: 1.4em 0 0.4em 0; }
  70 h5 { font-size: 0.81em; margin: 1.4em 0 0.4em 0; }
  71 h6 { font-size: 0.64em; margin: 1.4em 0 0.4em 0; }
  72
  73 hr {
  74         color: transparent; background: transparent;
  75         height: 0px; margin: 0.6em 0;
  76         border-width: 1px ;
  77         border-style: solid;
  78         border-color: #999;
  79 }
  80
  81 /* bulleted lists and definition lists */
  82
  83 ul { margin: 0 1em 0.6em 2em; padding: 0; }
  84 li { margin: 0.4em 0 0 0; }
  85
  86 dl { margin: 0.6em 1em 0.6em 2em; }
  87 dt { color: #206020; }
  88
  89 tt { color: #602020; }
  90
  91 /* links */
  92
  93 a.link {
  94         color: #33c; background: transparent;
  95         text-decoration: none;
  96 }
  97
  98 a:hover {
  99         color: #000; background: transparent;
 100 }
 101
 102 body > a {
 103         font-family: Optima, Arial, Helvetica, sans-serif;
 104         font-size: 0.81em;
 105 }
 106
 107 h1, h2, h3, h4, h5, h6 {
 108         color: #206020; background: transparent;
 109         font-family: Optima, Arial, Helvetica, sans-serif;
 110         font-weight: normal;
 111 }
 112
 113   -->
 114 </style>
 115 </head>
 116 <body>
 117 <div class="body">
 118
 119 <br><center><h1><a name="AFT-top">Nexuiz 3 FAQ</a></h1></center>
 120 <center><a class="link" href="http://nexuiz.com">http://nexuiz.com</a>&nbsp;&nbsp;<a class="link" href="http://alientrap.org">http://alientrap.org</a></center>
 121 <hr>
 122 <!--  AFT Table of Contents (auto generated) -->
 123 <ul>
 124 <li> <a class="link" href="#Troubleshooting">Troubleshooting</a></li>
 125 <ul>
 126 <li> <a class="link" href="#How do I install Nexuiz?">How do I install Nexuiz?</a></li>
 127 <li> <a class="link" href="#When I start Nexuiz all I see is a black screen or a black screen with some checkered squares">When I start Nexuiz all I see is a black screen or a black screen with some checkered squares</a></li>
 128 <li> <a class="link" href="#The sound is broken, it crackles and stutters">The sound is broken, it crackles and stutters</a></li>
 129 <li> <a class="link" href="#I can't switch to 32 bit color depth (on Windows)">I can't switch to 32 bit color depth (on Windows)</a></li>
 130 <li> <a class="link" href="#When I join a server or after a map change I see nothing but a black screen, but I can still move and shoot">When I join a server or after a map change I see nothing but a black screen, but I can still move and shoot</a></li>
 131 </ul>
 132 <li> <a class="link" href="#Server setup">Server setup</a></li>
 133 <ul>
 134 <li> <a class="link" href="#How do I start a server?">How do I start a server?</a></li>
 135 <li> <a class="link" href="#Which ports do I have to open in firewall/forward from my router to run a server?">Which ports do I have to open in firewall/forward from my router to run a server?</a></li>
 136 <li> <a class="link" href="#Is there some kind of rcon?">Is there some kind of rcon?</a></li>
 137 <li> <a class="link" href="#How can i kick people who are using special characters in their names?">How can i kick people who are using special characters in their names?</a></li>
 138 </ul>
 139 <li> <a class="link" href="#General questions">General questions</a></li>
 140 <ul>
 141 <li> <a class="link" href="#How do I install new maps?">How do I install new maps?</a></li>
 142 <li> <a class="link" href="#How can I place a shortcut to Nexuiz on my Linux desktop?">How can I place a shortcut to Nexuiz on my Linux desktop?</a></li>
 143 <li> <a class="link" href="#How do I open the console?">How do I open the console?</a></li>
 144 <li> <a class="link" href="#What console commands/variables are there?">What console commands/variables are there?</a></li>
 145 <li> <a class="link" href="#How can I speed up my frame rate?">How can I speed up my frame rate?</a></li>
 146 <li> <a class="link" href="#How can I activate colors in my name?">How can I activate colors in my name?</a></li>
 147 <li> <a class="link" href="#How do i watch/record demos?">How do i watch/record demos?</a></li>
 148 </ul>
 149 <li> <a class="link" href="#Development">Development</a></li>
 150 <ul>
 151 <li> <a class="link" href="#How do i set up gtkradiant to create/edit Nexuiz maps?">How do i set up gtkradiant to create/edit Nexuiz maps?</a></li>
 152 <li> <a class="link" href="#Where can i get latest development versions of the source code?">Where can i get latest development versions of the source code?</a>
 153
 154 </li>
 155 </ul>
 156 </ul>
 157 <hr>
 158 <!-- Start SectLevel1 -->
 159 <h2><a name="Troubleshooting">Troubleshooting</a></h2>
 160 <!-- Start SectLevel2 -->
 161 <h3><a name="How do I install Nexuiz?">How do I install Nexuiz?</a></h3>
 162 <p class="Body">
 163 Just unzip the <tt>nexuiz-&lt;version&gt;.zip</tt> file. You can do this with any archive program (like <a class="link" href="http://7zip.org">7zip</a>). It's very important to keep the directory structure while unpacking (in WinZip this option is called &quot;Use folder names&quot;). The directory structure should look like this afterwards:
 164 <div class="block"><pre>
 165 Nexuiz
 166 |-- Docs
 167 |-- Nexuiz-SDL.app
 168 |   |-- *
 169 |-- data
 170 |   |-- data*.pk3
 171 |-- *.exe
 172 |-- *.dll
 173 `-- nexuiz-linux-*
 174 </pre></div>
 175 </p>
 176 <!--End Section 2-->
 177 <h3><a name="When I start Nexuiz all I see is a black screen or a black screen with some checkered squares">When I start Nexuiz all I see is a black screen or a black screen with some checkered squares</a></h3>
 178 <p class="Body">
 179 This happens when the engine can't load the data*.pk3 file or has trouble to initialize OpenGL. The reasons could be:
 180 <ol>
 181 <li> you unpacked the zip file without folder names (see <a class="link" href="#How do I install Nexuiz?">How do I install Nexuiz?</a>)</li>
 182 <li> on Linux: the current directory is not your Nexuiz/ folder. See <a class="link" href="#How can I place a shortcut to Nexuiz on my Linux desktop?">How can I place a shortcut to Nexuiz on my Linux desktop?</a> on how to fix this</li>
 183 <li> on Mac: you tried to extract and move the files from a Nexuiz update and it deleted the old files. When using the mac GUI please be sure to move only the files not the folders as that will delete the old files or use the mv console command which will not delete the old files</li>
 184 <li> the engine could not initialize OpenGL. Please install the latest drivers for your graphic card. You will probably find one for your card there: <a class="link" href="http://intel.com">intel</a> <a class="link" href="http://ati.com">ati</a> <a class="link" href="http://nvidia.com">nvidia</a></li>
 185 <li> your download might be corrupted, please download Nexuiz again</li>
 186 </ol>
 187 </p>
 188 <!--End Section 2-->
 189 <h3><a name="The sound is broken, it crackles and stutters">The sound is broken, it crackles and stutters</a></h3>
 190 <p class="Body">
 191 Try run <tt>nexuiz-sdl.exe</tt> instead of <tt>nexuiz.exe</tt> (on Windows). Adding the command line options <tt>-sndspeed 48000</tt> and/or <tt>-sndstereo</tt> can also help on some systems (on Linux, Mac, Windows).
 192 </p>
 193 <!--End Section 2-->
 194 <h3><a name="I can't switch to 32 bit color depth (on Windows)">I can't switch to 32 bit color depth (on Windows)</a></h3>
 195 <p class="Body">
 196 Check if your desktop color depth is set to 32 bits per pixel. If it's just set to 16, Nexuiz can't switch to 32 bit mode.
 197 </p>
 198 <!--End Section 2-->
 199 <h3><a name="When I join a server or after a map change I see nothing but a black screen, but I can still move and shoot">When I join a server or after a map change I see nothing but a black screen, but I can still move and shoot</a></h3>
 200 <p class="Body">
 201 This is probably because you don't have the map that's running on the server. As Nexuiz does now supports map/content download the server might not be be setup to support this and you will have to get the map the old fashioned way. Those servers will have a download URL in their name or welcome message. There is also a <a class="link" href="http://alientrap.org/wiki/pmwiki.php?n=Main.CustomMaps">wiki page</a> dedicated to new maps.
 202 For Linux users: you need to have libcurl installed, otherwise you won't be able to download any maps. libcurl should be available in any Linux distribution, just search for &quot;libcurl&quot; and install it in your distribution's package manager.
 203 </p>
 204 <!--End Section 2-->
 205 <!-- End SectLevel2 -->
 206 <!--End Section 1-->
 207 <h2><a name="Server setup">Server setup</a></h2>
 208 <!-- Start SectLevel2 -->
 209 <h3><a name="How do I start a server?">How do I start a server?</a></h3>
 210 <p class="Body">
 211 Use the <tt>Create</tt> menu to start a <tt>listen server</tt>. You will always have to play in a <tt>listen server</tt>.
 212 If you want to create a server without being forced to play yourself please take a look at the file <tt>readme.txt</tt> in the <tt>Docs/server/</tt> directory where the <tt>dedicated server</tt> is explained.
 213 </p>
 214 <!--End Section 2-->
 215 <h3><a name="Which ports do I have to open in firewall/forward from my router to run a server?">Which ports do I have to open in firewall/forward from my router to run a server?</a></h3>
 216 <p class="Body">
 217 The default port is 26000 UDP. You can change that by starting Nexuiz with the parameter <tt>-port &lt;port&gt;</tt> or having a line <tt>port &lt;port&gt;</tt> in the server config file.
 218 If you follow the tutorial mentioned above you do not need this command line argument as it will be done in the config file created for the server. To add the command line argument on Windows, create a new shortcut to <tt>nexuiz.exe</tt> or <tt>nexuiz-dedicated.exe</tt> and right click on it. Select properties and <tt>-port &lt;port&gt;</tt> in the &quot;Target:&quot; line. Be sure that the &quot;Start in:&quot; line contains the full path to your Nexuiz folder and click &quot;OK&quot;. The parameter will be used if you start Nexuiz via that new shortcut.
 219 </p>
 220 <!--End Section 2-->
 221 <h3><a name="Is there some kind of rcon?">Is there some kind of rcon?</a></h3>
 222 <p class="Body">
 223 Yes starting with Nexuiz 2.0 there is rcon (QuakeWorld compatible). To use it you must enter <tt>rcon_password &lt;password&gt;</tt> in the server console or server config file. The Nexuiz client has to set the same password in the same fashion. You can then issue commands with <tt>rcon &lt;command&gt;</tt> if you are connected to the server or have set <tt>rcon_address &lt;ip/hostname&gt;</tt> or <tt>rcon_address &lt;ip/hostname&gt;:&lt;port&gt;</tt> to point to the server. There are also external rcon tools but make sure you use a QW compatible rcon tool.
 224 </p>
 225 <!--End Section 2-->
 226 <h3><a name="How can i kick people who are using special characters in their names?">How can i kick people who are using special characters in their names?</a></h3>
 227 <p class="Body">
 228 Enter <tt>status</tt> at the server console. You will see a list of all players. In front of their names you will see a number (the player id). You can kick the player you don't like with <tt>kick # &lt;player id&gt; &lt;reason&gt;</tt> (notice the space after #).
 229 </p>
 230 <!--End Section 2-->
 231 <!-- End SectLevel2 -->
 232 <!--End Section 1-->
 233 <h2><a name="General questions">General questions</a></h2>
 234 <!-- Start SectLevel2 -->
 235 <h3><a name="How do I install new maps?">How do I install new maps?</a></h3>
 236 <p class="Body">
 237 Maps usually ship as *.pk3 file. All you have to do is to copy this file to the <tt>Nexuiz/data/</tt> (on Linux, Mac, Windows) OR <tt>~/.nexuiz/data/</tt> (on Linux, Mac) directory.
 238 </p>
 239 <!--End Section 2-->
 240 <h3><a name="How can I place a shortcut to Nexuiz on my Linux desktop?">How can I place a shortcut to Nexuiz on my Linux desktop?</a></h3>
 241 <p class="Body">
 242 Use the script <tt>nexuiz-linux-sdl.sh</tt> or <tt>nexuiz-linux-glx.sh</tt> instead of the binaries. The scripts will use the correct <tt>working directory</tt>,choose the right version (32 or 64 bit) and also allow you to start a extra X server.
 243 </p>
 244 <!--End Section 2-->
 245 <h3><a name="How do I open the console?">How do I open the console?</a></h3>
 246 <p class="Body">
 247 Press <tt>[shift]+[escape]</tt>. To close it press <tt>[escape]</tt>
 248 </p>
 249 <!--End Section 2-->
 250 <h3><a name="What console commands/variables are there?">What console commands/variables are there?</a></h3>
 251 <p class="Body">
 252 You can get a list of variables by entering <tt>cvarlist</tt> on the console (<a class="link" href="#How do I open the console?">How do I open the console?</a>). <tt>cmdlist</tt> will give you a list of available commands. An annotated version of that output can be found at the <a class="link" href="http://alientrap.org/wiki/pmwiki.php?n=Main.ConsoleCommands">Nexuiz wiki</a>.
 253 </p>
 254 <!--End Section 2-->
 255 <h3><a name="How can I speed up my frame rate?">How can I speed up my frame rate?</a></h3>
 256 <p class="Body">
 257 The greatest performance boost can be achieved by turning off dynamic lights and shadows in the menu <tt>Options / Effects</tt>. Bloom is also quite resource intensive. Other fps boots include disabling <tt>Deluxemapping</tt> and <tt>Coronas</tt>. On older graphics cards or on-board/notebook chips with little video ram you can try to lower the texture quality in the menu <tt>Options / Video</tt>. Some older cards also run faster when you disable <tt>OpenGL 2.0 Shaders</tt> but in general for most cards it should be active. Nexuiz also includes config files that will adjust your graphic settings. Open the console (<a class="link" href="#How do I open the console?">How do I open the console?</a>) and type <tt>exec normal.cfg</tt> to get the default setting (back). <tt>exec med.cfg</tt> and <tt>exec low.cfg</tt> are of lower quality but will make Nexuiz run faster. <tt>exec high.cfg</tt>, <tt>exec ultra.cfg</tt> and <tt>exec ultimate.cfg</tt> will show what Nexuiz is able to look like but do require a very fast PC and graphic card. Some of the settings in those config files require you to either restart Nexuiz or also type <tt>vid_restart</tt> in the console after exec'ing the config files.
 258 </p>
 259 <!--End Section 2-->
 260 <h3><a name="How can I activate colors in my name?">How can I activate colors in my name?</a></h3>
 261 <p class="Body">
 262 Colors can be used in nicknames and chat messages by typing ^ followed by a number between 0 and 9.
 263 </p>
 264 <!-- 2 columns --><center><table cellspacing="0">
 265 <caption>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;    </caption>
 266 <tr><th> code   </th><th> color&nbsp;&nbsp;     </th></tr>
 267 <tr><td> ^0     </td><td> black&nbsp;&nbsp;     </td></tr>
 268 <tr><td> ^1     </td><td> red&nbsp;&nbsp;</td></tr>
 269 <tr><td> ^2     </td><td> green&nbsp;&nbsp;     </td></tr>
 270 <tr><td> ^3     </td><td> yellow&nbsp;&nbsp;    </td></tr>
 271 <tr><td> ^4     </td><td> blue&nbsp;&nbsp;      </td></tr>
 272 <tr><td> ^5     </td><td> aqua&nbsp;&nbsp;      </td></tr>
 273 <tr><td> ^6     </td><td> pink&nbsp;&nbsp;      </td></tr>
 274 <tr><td> ^7     </td><td> white&nbsp;&nbsp;     </td></tr>
 275 <tr><td> ^8     </td><td> light grey&nbsp;&nbsp;</td></tr>
 276 <tr><td> ^9     </td><td> dark grey&nbsp;&nbsp; </td></tr>
 277 </table></center>
 278 <!--End Section 2-->
 279 <h3><a name="How do i watch/record demos?">How do i watch/record demos?</a></h3>
 280 <p class="Body">
 281 You can access your demos in the <tt>Demos</tt> menu. Click on the demo you want to watch and then on <tt>Start</tt> to watch the demo. Or type <tt>ply &lt;name&gt;</tt> in the console (<a class="link" href="#How do I open the console?">How do I open the console?</a>).
 282 To record a demo yourself open the console and type <tt>rec &lt;name&gt;</tt> before playing. That is before starting a game or connecting to a server. The demo file will be stored in <tt>Nexuiz/data/demos/&lt;name&gt;.dem</tt> (on Windows) or <tt>~/.nexuiz/data/demos/&lt;name&gt;.dem</tt> (on Linux, Mac).
 283 If you downloaded a demo, copy it to <tt>Nexuiz/data/demos/&lt;name&gt;.dem</tt> (on Linux, Mac, Windows) or <tt>~/.nexuiz/data/demos/&lt;name&gt;.dem</tt> (on Linux, Mac). You might have to create this directory if you have never recorded a demo before.
 284 You can list all your demo files by typing <tt>dem</tt> on the console. Some useful key bindings for viewing demos are listed <a class="link" href="http://www.alientrap.org/forum/viewtopic.php?p=357#357">here</a>. A simple way to automatically record demos can be found <a class="link" href="http://www.alientrap.org/forum/viewtopic.php?t=90">here</a>
 285 </p>
 286 <!--End Section 2-->
 287 <!-- End SectLevel2 -->
 288 <!--End Section 1-->
 289 <h2><a name="Development">Development</a></h2>
 290 <!-- Start SectLevel2 -->
 291 <h3><a name="How do i set up gtkradiant to create/edit Nexuiz maps?">How do i set up gtkradiant to create/edit Nexuiz maps?</a></h3>
 292 <p class="Body">
 293 There's a <a class="link" href="http://www.alientrap.org/forum/viewtopic.php?t=10">guide</a> on gtkradiant setup in the forums.
 294 There are also <a class="link" href="http://www.alientrap.org/forum/viewtopic.php?p=33">Windows tool</a> that will help you to setup gtkradiant 1.4 and a <a class="link" href="http://www.alientrap.org/forum/viewtopic.php?p=841">Linux script</a> to configure gtkradiant 1.5.
 295 </p>
 296 <!--End Section 2-->
 297 <h3><a name="Where can i get latest development versions of the source code?">Where can i get latest development versions of the source code?</a></h3>
 298 <p class="Body">
 299 <strong>Engine:</strong> instructions are available at <a class="link" href="http://icculus.org/twilight/darkplaces/download.html">http://icculus.org/twilight/darkplaces/download.html</a> look for <tt>Accessing the SVN server</tt> (you will need a <a class="link" href="http://subversion.tigris.org/project_packages.html">svn client</a>, beta builds are available <a class="link" href="http://icculus.org/twilight/darkplaces/files/">here</a>)
 300 </p>
 301 <p class="Body">
 302 <strong>Game data:</strong> to check out the Nexuiz svn, you'll need a <a class="link" href="http://subversion.tigris.org/project_packages.html">svn client</a>. To check out the repository with a command line svn client, do
 303 <div class="block"><pre>
 304 svn co svn://svn.icculus.org/nexuiz/trunk/
 305 </pre></div>
 306 To compile the game code you need <a class="link" href="http://sourceforge.net/project/showfiles.php?group_id=116842&amp;package_id=129507">fteqcc</a>. Just download it and run it twice, once in <tt>data/qcsrc/menu</tt> and once in <tt>data/qcsrc/server</tt>.
 307 </p>
 308 <!--End Section 2-->
 309 <!-- End SectLevel2 -->
 310 <!--End Section 1-->
 311 <!-- End SectLevel1 -->
 312 <hr>
 313 <br>
 314 <p align="right"> <small>This document was generated using <a class="link" href="http://www.maplefish.com/todd/aft.html">AFT v5.096</a></small> </p>
 315 </body>
 316 </html>
 317