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 with some checkered squares">When I start Nexuiz all I see is 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 (Windows)">I can't switch to 32 bit color depth (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-VERSION.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 remain 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 with some checkered squares">When I start Nexuiz all I see is 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. 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>)</li>
 183 <li> your download might be corrupted, please download Nexuiz again</li>
 184 </ol>
 185 </p>
 186 <!--End Section 2-->
 187 <h3><a name="The sound is broken, it crackles and stutters">The sound is broken, it crackles and stutters</a></h3>
 188 <p class="Body">
 189 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 Windows, Linux, Mac).
 190 </p>
 191 <!--End Section 2-->
 192 <h3><a name="I can't switch to 32 bit color depth (Windows)">I can't switch to 32 bit color depth (Windows)</a></h3>
 193 <p class="Body">
 194 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.
 195 </p>
 196 <!--End Section 2-->
 197 <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>
 198 <p class="Body">
 199 This is probably because you don't have the map, that's running on the server. As Nexuiz does now support map/content download the server might 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.
 200 </p>
 201 <!--End Section 2-->
 202 <!-- End SectLevel2 -->
 203 <!--End Section 1-->
 204 <h2><a name="Server setup">Server setup</a></h2>
 205 <!-- Start SectLevel2 -->
 206 <h3><a name="How do I start a server?">How do I start a server?</a></h3>
 207 <p class="Body">
 208 Please take a look at the file <tt>readme.txt</tt> in the <tt>Docs/server/</tt> directory where this topic is explained.
 209 </p>
 210 <!--End Section 2-->
 211 <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>
 212 <p class="Body">
 213 The default port is 26000 UDP. You can change that by starting Nexuiz with <tt>nexuiz-sdl.exe -port &lt;port&gt;</tt> (on Windows) or <tt>nexuiz-linux-686-sdl -port &lt;port&gt;</tt> (on Linux).
 214 To add the command line argument on Windows, create a new shortcut to <tt>nexuiz-sdl.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;.
 215 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.
 216 </p>
 217 <!--End Section 2-->
 218 <h3><a name="Is there some kind of rcon?">Is there some kind of rcon?</a></h3>
 219 <p class="Body">
 220 Yes starting with Nexuiz 2.0 there is rcon (QuakeWorld compatible). To use it you must enter <tt>set rcon_password hackme</tt> in the server console or server config file. The Nexuiz client has to set the same password in the same fasion. You can then issue commands with <tt>rcon &lt;command&gt;</tt>. There are also external rcon tools but make sure you use a QW compatible rcon tool.
 221 There is also a feature called <tt>client side commands</tt>. To enable it enter <tt>set sv_clientcommands 1</tt> on your server console. Don't forget to set a password with <tt>set sv_clientcommands_password hackme</tt>. Now you can become admin ingame by entering <tt>ccl hackme</tt> on the client console. To issue commands enter <tt>cc &lt;command&gt;</tt> (e.g. <tt>cc restart</tt> or <tt>cc chmap dm_nexdm12</tt>).
 222 </p>
 223 <!--End Section 2-->
 224 <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>
 225 <p class="Body">
 226 Enter <tt>status</tt> at the 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 #).
 227 </p>
 228 <!--End Section 2-->
 229 <!-- End SectLevel2 -->
 230 <!--End Section 1-->
 231 <h2><a name="General questions">General questions</a></h2>
 232 <!-- Start SectLevel2 -->
 233 <h3><a name="How do I install new maps?">How do I install new maps?</a></h3>
 234 <p class="Body">
 235 Maps usually ship as *.pk3 file. All you have to do is to copy this file to your <tt>Nexuiz/data/</tt> directory.
 236 </p>
 237 <!--End Section 2-->
 238 <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>
 239 <p class="Body">
 240 Use the script <tt>nexuiz-linux.sh</tt> instead of the binary. It will use the right version (32 or 64 bit).
 241 </p>
 242 <!--End Section 2-->
 243 <h3><a name="How do I open the console?">How do I open the console?</a></h3>
 244 <p class="Body">
 245 Press <tt>[shift]+[escape]</tt>. To close it press <tt>[escape]</tt>
 246 </p>
 247 <!--End Section 2-->
 248 <h3><a name="What console commands/variables are there?">What console commands/variables are there?</a></h3>
 249 <p class="Body">
 250 You can get a list of variables by entering <tt>cvarlist</tt> on the console. <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>.
 251 </p>
 252 <!--End Section 2-->
 253 <h3><a name="How can I speed up my frame rate?">How can I speed up my frame rate?</a></h3>
 254 <p class="Body">
 255 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. Other fps boots include disabeling <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 resolution. To do this open the console (<a class="link" href="#How do I open the console?">How do I open the console?</a>) and type <tt>gl_picmip #; r_restart</tt> (where # is a number between 0 and 10, 0 is the highest quality). Nexuiz now does also include config files that will adjust your graphic settings. Open the console as explained in and type <tt>exec normal.cfg</tt> to get the default setting. <tt>exec med.cfg</tt> and <tt>exec low.cfg</tt> are of lower quality but will make Nexuiz faster. <tt>exec high.cfg</tt> and <tt>exec ultra.cfg</tt> will show what Nexuiz is able to look like but do require a very fast PC and graphic card. Just like the <tt>gl<strong>picmip</tt> some of the settings in those config files require you to either restart Nexuiz or type <tt>vid</strong>restart</tt> in the console afterwards.
 256 </p>
 257 <!--End Section 2-->
 258 <h3><a name="How can I activate colors in my name?">How can I activate colors in my name?</a></h3>
 259 <p class="Body">
 260 Colors can be used in nicknames and chat messages by typing ^ followed by a number between 0 and 9.
 261 </p>
 262 <!-- 2 columns --><center><table cellspacing="0">
 263 <caption>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;    </caption>
 264 <tr><th> code   </th><th> color&nbsp;&nbsp;     </th></tr>
 265 <tr><td> ^0     </td><td> black&nbsp;&nbsp;     </td></tr>
 266 <tr><td> ^1     </td><td> red&nbsp;&nbsp;</td></tr>
 267 <tr><td> ^2     </td><td> green&nbsp;&nbsp;     </td></tr>
 268 <tr><td> ^3     </td><td> yellow&nbsp;&nbsp;    </td></tr>
 269 <tr><td> ^4     </td><td> blue&nbsp;&nbsp;      </td></tr>
 270 <tr><td> ^5     </td><td> aqua&nbsp;&nbsp;      </td></tr>
 271 <tr><td> ^6     </td><td> pink&nbsp;&nbsp;      </td></tr>
 272 <tr><td> ^7     </td><td> white&nbsp;&nbsp;     </td></tr>
 273 <tr><td> ^8     </td><td> light grey&nbsp;&nbsp;</td></tr>
 274 <tr><td> ^9     </td><td> dark grey&nbsp;&nbsp; </td></tr>
 275 </table></center>
 276 <!--End Section 2-->
 277 <h3><a name="How do i watch/record demos?">How do i watch/record demos?</a></h3>
 278 <p class="Body">
 279 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.
 280 To record a demo yourself open the console (<a class="link" href="#How do I open the console?">How do I open the console?</a>) and type <tt>rec &lt;name&gt;</tt> before playing. That is before starting a game or connection to a server. The demo file will be stored in <tt>~/.nexuiz/data/demos/&lt;name&gt;.dem</tt> (Linux) or <tt>Nexuiz/data/demos/&lt;name&gt;.dem</tt> (Windows).
 281 To watch a demo: open the console and type <tt>ply &lt;name&gt;</tt>. If you downloaded a demo, copy it to <tt>Nexuiz/data/demos</tt>. You might have to create this directory if you have never recorded a demo before.
 282 You can list all your demo files by typing <tt>dem</tt> on the console. Some usefull keybindings 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 automaticly record demos can be found <a class="link" href="http://www.alientrap.org/forum/viewtopic.php?t=90">here</a>
 283 </p>
 284 <!--End Section 2-->
 285 <!-- End SectLevel2 -->
 286 <!--End Section 1-->
 287 <h2><a name="Development">Development</a></h2>
 288 <!-- Start SectLevel2 -->
 289 <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>
 290 <p class="Body">
 291 There's a <a class="link" href="http://www.alientrap.org/forum/viewtopic.php?t=10">guide</a> on gtkradiant setup in the forums.
 292 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.
 293 </p>
 294 <!--End Section 2-->
 295 <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>
 296 <p class="Body">
 297 <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> (you will need a <a class="link" href="http://www.nongnu.org/cvs/">cvs client</a>, beta builds are available <a class="link" href="http://icculus.org/twilight/darkplaces/files/">here</a>)
 298 </p>
 299 <p class="Body">
 300 <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 commandline svn client, do
 301 <div class="block"><pre>
 302 svn co svn://svn.icculus.org/nexuiz/trunk/
 303 </pre></div>
 304 To compile the gamecode 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>.
 305 </p>
 306 <!--End Section 2-->
 307 <!-- End SectLevel2 -->
 308 <!--End Section 1-->
 309 <!-- End SectLevel1 -->
 310 <hr>
 311 <br>
 312 <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>
 313 </body>
 314 </html>
 315