added FAQ and moved all help files to Docs/
[divverent/nexuiz.git] / Docs / FAQ.html
1 <!--  AFT (Almost Free Text) source file for Nexuiz FAQ -->
2 <!--  use AFT v5.096 or later (http://www.maplefish.com/todd/aft.html) -->
3 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
4 <html>
5 <head>
6 <title>Nexuiz 1.3 FAQ</title>
7         <meta name="author" content="">
8         <meta name="GENERATOR" content = "Almost Free Text v5.096; Copyright 1996-2005 Todd Coram. All rights reserved.">
9 <style type="text/css">
10   <!--
11 html { background: #eee; color: #000; }
12
13 body { background: #eee; color: #000; margin: 0; padding: 0;}
14
15 div.body {
16         background: #fff; color: #000;
17         margin: 0 1em 0 1em; padding: 1em;
18         font-family: serif;
19         font-size: 1em; line-height: 1.2em;
20         border-width: 0 1px 0 1px;
21         border-style: solid;
22         border-color: #aaa;
23 }
24
25 div.block {
26         background: #F8F8FF; color: #000;
27         margin: 1em; padding: 0 1em 0 1em;
28         border-width: 1px;
29         border-style: solid;
30         border-color: #909090;
31 }
32
33 table {
34         background: #F8F8F8; color: #000;
35         margin: 1em;
36         border-width: 0 0 0 1px;
37         border-style: solid;
38         border-color: #C0C0C0;
39 }
40
41 td {
42         border-width: 0 1px 1px 0;
43         border-style: solid;
44         border-color: #C0C0C0;
45 }
46
47 th {
48         background: #F8F8FF;
49         border-width: 1px 1px 2px 0;
50         border-style: solid;
51         border-color: #C0C0C0;
52 }
53
54
55 /* body text, headings, and rules */
56
57 p { margin: 0; text-indent: 0em; margin: 0 0 0.5em 0 }
58
59 h1, h2, h3, h4, h5, h6 {
60         color: #206020; background: transparent;
61         font-family: Optima, Arial, Helvetica, sans-serif;
62         font-weight: normal;
63 }
64
65 h1 { font-size: 1.69em; margin: 1.4em 0 0.4em 0; }
66 h2 { font-size: 1.44em; margin: 1.4em 0 0.4em 0; }
67 h3 { font-size: 1.21em; margin: 1.4em 0 0.4em 0; }
68 h4 { font-size: 1.00em; margin: 1.4em 0 0.4em 0; }
69 h5 { font-size: 0.81em; margin: 1.4em 0 0.4em 0; }
70 h6 { font-size: 0.64em; margin: 1.4em 0 0.4em 0; }
71
72 hr {
73         color: transparent; background: transparent;
74         height: 0px; margin: 0.6em 0;
75         border-width: 1px ;
76         border-style: solid;
77         border-color: #999;
78 }
79
80 /* bulleted lists and definition lists */
81
82 ul { margin: 0 1em 0.6em 2em; padding: 0; }
83 li { margin: 0.4em 0 0 0; }
84
85 dl { margin: 0.6em 1em 0.6em 2em; }
86 dt { color: #206020; }
87
88 tt { color: #602020; }
89
90 /* links */
91
92 a.link {
93         color: #33c; background: transparent;
94         text-decoration: none;
95 }
96
97 a:hover {
98         color: #000; background: transparent;
99 }
100
101 body > a {
102         font-family: Optima, Arial, Helvetica, sans-serif;
103         font-size: 0.81em;
104 }
105
106 h1, h2, h3, h4, h5, h6 {
107         color: #206020; background: transparent;
108         font-family: Optima, Arial, Helvetica, sans-serif;
109         font-weight: normal;
110 }
111
112   -->
113 </style>
114 </head>
115 <body>
116 <div class="body">
117
118 <br><center><h1><a name="AFT-top">Nexuiz 1.3 FAQ</a></h1></center>
119 <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>
120 <hr>
121 <!--  AFT Table of Contents (auto generated) -->
122 <ul>
123 <li> <a class="link" href="#Troubleshooting">Troubleshooting</a></li>
124 <ul>
125 <li> <a class="link" href="#How do I install Nexuiz?">How do I install Nexuiz?</a></li>
126 <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>
127 <li> <a class="link" href="#The sound is broken, it crackles and stutters">The sound is broken, it crackles and stutters</a></li>
128 <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>
129 </ul>
130 <li> <a class="link" href="#Server setup">Server setup</a></li>
131 <ul>
132 <li> <a class="link" href="#How do I start a server?">How do I start a server?</a></li>
133 <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>
134 </ul>
135 <li> <a class="link" href="#General questions">General questions</a></li>
136 <ul>
137 <li> <a class="link" href="#How do I install new maps?">How do I install new maps?</a></li>
138 <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>
139 <li> <a class="link" href="#How do I open the console?">How do I open the console?</a></li>
140 <li> <a class="link" href="#What console commands/variables are there?">What console commands/variables are there?</a></li>
141 <li> <a class="link" href="#How can I speed up my frame rate?">How can I speed up my frame rate?</a></li>
142 <li> <a class="link" href="#How can I activate colors in my name?">How can I activate colors in my name?</a>
143
144 </li>
145 </ul>
146 </ul>
147 <hr>
148 <!-- Start SectLevel1 -->
149 <h2><a name="Troubleshooting">Troubleshooting</a></h2>
150 <!-- Start SectLevel2 -->
151 <h3><a name="How do I install Nexuiz?">How do I install Nexuiz?</a></h3>
152 <p class="Body">
153 Just unzip the <tt>nexuiz13.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:
154 <div class="block"><pre>
155 Nexuiz
156 |-- data
157 |   |-- data*.pk3
158 |-- *.exe
159 |-- *.dll
160 `-- nexuiz-linux-*
161 </pre></div>
162 </p>
163 <!--End Section 2-->
164 <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>
165 <p class="Body">
166 This happens when the engine can't load the data*.pk3 file. The reasons could be:
167 <ol>
168 <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>
169 <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>
170 <li> your download might be corrupted</li>
171 </ol>
172 </p>
173 <!--End Section 2-->
174 <h3><a name="The sound is broken, it crackles and stutters">The sound is broken, it crackles and stutters</a></h3>
175 <p class="Body">
176 Try run <tt>nexuiz-sdl.exe</tt> (on Windows) or <tt>nexuiz-linux-686-sdl</tt> (on Linux). This version usually performs better on newer sound cards than <tt>nexuiz.exe</tt>/<tt>nexuiz-linux-686-glx</tt>.
177 </p>
178 <!--End Section 2-->
179 <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>
180 <p class="Body">
181 This is probably because you don't have the map, that's running on the server. There is no map/content download in Nexuiz at the moment so you have to get the map the old fashioned way. Most servers will have a download URL in their name or welcome message. There is also a <a class="link" href="http://savage747.sa.funpic.de/wiki/pmwiki.php?n=Main.CustomMaps">wiki page</a> dedicated to new maps.
182 </p>
183 <!--End Section 2-->
184 <!-- End SectLevel2 -->
185 <!--End Section 1-->
186 <h2><a name="Server setup">Server setup</a></h2>
187 <!-- Start SectLevel2 -->
188 <h3><a name="How do I start a server?">How do I start a server?</a></h3>
189 <p class="Body">
190 There's a tutorial on how to setup up an dedicated server in this <a class="link" href="http://www.nexuiz.com/forums/index.php?showtopic=1236">forum post</a>.
191 </p>
192 <!--End Section 2-->
193 <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>
194 <p class="Body">
195 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).
196 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 clock &quot;OK&quot;.
197 </p>
198 <!--End Section 2-->
199 <!-- End SectLevel2 -->
200 <!--End Section 1-->
201 <h2><a name="General questions">General questions</a></h2>
202 <!-- Start SectLevel2 -->
203 <h3><a name="How do I install new maps?">How do I install new maps?</a></h3>
204 <p class="Body">
205 Maps usually ship as *.pk3 file. All you have to do is to copy this file to your <tt>Nexuiz/data/</tt> directory.
206 </p>
207 <!--End Section 2-->
208 <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>
209 <p class="Body">
210 Before you can create a desktop/menu item you have to create a little shell script. Open a text editor (like gedit or kate) and paste the following lines:
211 <div class="block"><pre>
212 #!/bin/sh
213 cd /path/to/Nexuiz              # replace this with the full path to your Nexuiz folder
214 ./nexuiz-linux-686-sdl &quot;$@&quot;   # or ./nexuiz-linux-x86_64-sdl if you're using an AMD64/EM64T distributions
215 </pre></div>
216 Save this in your Nexuiz directory as <tt>nexuiz.sh</tt>. Now you have to make this file executable by opening a xterm/konsole and typing:
217 <div class="block"><pre>
218 cd /path/to/Nexuiz
219 chmod a+x nexuiz.sh
220 </pre></div>
221 Finally you can add the <tt>nexuiz.sh</tt> file to your desktop like any other program.
222 </p>
223 <!--End Section 2-->
224 <h3><a name="How do I open the console?">How do I open the console?</a></h3>
225 <p class="Body">
226 Press <tt>[shift]+[escape]</tt>. To close it press <tt>[escape]</tt>
227 </p>
228 <!--End Section 2-->
229 <h3><a name="What console commands/variables are there?">What console commands/variables are there?</a></h3>
230 <p class="Body">
231 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://savage747.sa.funpic.de/wiki/pmwiki.php?n=Main.ConsoleCommands">Nexuiz wiki</a>.
232 </p>
233 <!--End Section 2-->
234 <h3><a name="How can I speed up my frame rate?">How can I speed up my frame rate?</a></h3>
235 <p class="Body">
236 The greatest performance boost can be achieved by turning off dynamic lights and shadows. Bloom is also quite resource intensive. 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 and type <tt>gl_picmip #; r_restart</tt> (where # is a number between 0 and 10, 0 is the highest quality).
237 </p>
238 <!--End Section 2-->
239 <h3><a name="How can I activate colors in my name?">How can I activate colors in my name?</a></h3>
240 <p class="Body">
241 Colors can be used in nicknames and chat messages by typing ^ followed by a number between 0 and 9.
242 </p>
243 <!-- 2 columns --><center><table cellspacing="0">
244 <caption>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;    </caption>
245 <tr><th> code   </th><th> color&nbsp;&nbsp;     </th></tr>
246 <tr><td> ^0     </td><td> black&nbsp;&nbsp;     </td></tr>
247 <tr><td> ^1     </td><td> red&nbsp;&nbsp;</td></tr>
248 <tr><td> ^2     </td><td> green&nbsp;&nbsp;     </td></tr>
249 <tr><td> ^3     </td><td> yellow&nbsp;&nbsp;    </td></tr>
250 <tr><td> ^4     </td><td> blue&nbsp;&nbsp;      </td></tr>
251 <tr><td> ^5     </td><td> aqua&nbsp;&nbsp;      </td></tr>
252 <tr><td> ^6     </td><td> pink&nbsp;&nbsp;      </td></tr>
253 <tr><td> ^7     </td><td> white&nbsp;&nbsp;     </td></tr>
254 <tr><td> ^8     </td><td> light grey&nbsp;&nbsp;</td></tr>
255 <tr><td> ^9     </td><td> dark grey&nbsp;&nbsp; </td></tr>
256 </table></center>
257 <!--End Section 2-->
258 <!-- End SectLevel2 -->
259 <!--End Section 1-->
260 <!-- End SectLevel1 -->
261 <hr>
262 <br>
263 <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>
264 </body>
265 </html>
266