stupid typo corrected, thanks KadaverJack
[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.5 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.5 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 <li> <a class="link" href="#Is there some kind of rcon?">Is there some kind of rcon?</a></li>
135 <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>
136 </ul>
137 <li> <a class="link" href="#General questions">General questions</a></li>
138 <ul>
139 <li> <a class="link" href="#How do I install new maps?">How do I install new maps?</a></li>
140 <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>
141 <li> <a class="link" href="#How do I open the console?">How do I open the console?</a></li>
142 <li> <a class="link" href="#What console commands/variables are there?">What console commands/variables are there?</a></li>
143 <li> <a class="link" href="#How can I speed up my frame rate?">How can I speed up my frame rate?</a></li>
144 <li> <a class="link" href="#How can I activate colors in my name?">How can I activate colors in my name?</a></li>
145 <li> <a class="link" href="#How do i watch/record demos?">How do i watch/record demos?</a></li>
146 </ul>
147 <li> <a class="link" href="#Development">Development</a></li>
148 <ul>
149 <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>
150 <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>
151
152 </li>
153 </ul>
154 </ul>
155 <hr>
156 <!-- Start SectLevel1 -->
157 <h2><a name="Troubleshooting">Troubleshooting</a></h2>
158 <!-- Start SectLevel2 -->
159 <h3><a name="How do I install Nexuiz?">How do I install Nexuiz?</a></h3>
160 <p class="Body">
161 Just unzip the <tt>nexuiz15.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:
162 <div class="block"><pre>
163 Nexuiz
164 |-- data
165 |   |-- data*.pk3
166 |-- *.exe
167 |-- *.dll
168 `-- nexuiz-linux-*
169 </pre></div>
170 </p>
171 <!--End Section 2-->
172 <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>
173 <p class="Body">
174 This happens when the engine can't load the data*.pk3 file. The reasons could be:
175 <ol>
176 <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>
177 <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>
178 <li> your download might be corrupted</li>
179 </ol>
180 </p>
181 <!--End Section 2-->
182 <h3><a name="The sound is broken, it crackles and stutters">The sound is broken, it crackles and stutters</a></h3>
183 <p class="Body">
184 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>.
185 </p>
186 <!--End Section 2-->
187 <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>
188 <p class="Body">
189 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.
190 </p>
191 <!--End Section 2-->
192 <!-- End SectLevel2 -->
193 <!--End Section 1-->
194 <h2><a name="Server setup">Server setup</a></h2>
195 <!-- Start SectLevel2 -->
196 <h3><a name="How do I start a server?">How do I start a server?</a></h3>
197 <p class="Body">
198 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>.
199 </p>
200 <!--End Section 2-->
201 <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>
202 <p class="Body">
203 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).
204 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;.
205 </p>
206 <!--End Section 2-->
207 <h3><a name="Is there some kind of rcon?">Is there some kind of rcon?</a></h3>
208 <p class="Body">
209 Yes, but it is not compatible with Quake rcon (so you can't use quake rcon tools). 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>).
210 </p>
211 <!--End Section 2-->
212 <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>
213 <p class="Body">
214 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 #).
215 </p>
216 <!--End Section 2-->
217 <!-- End SectLevel2 -->
218 <!--End Section 1-->
219 <h2><a name="General questions">General questions</a></h2>
220 <!-- Start SectLevel2 -->
221 <h3><a name="How do I install new maps?">How do I install new maps?</a></h3>
222 <p class="Body">
223 Maps usually ship as *.pk3 file. All you have to do is to copy this file to your <tt>Nexuiz/data/</tt> directory.
224 </p>
225 <!--End Section 2-->
226 <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>
227 <p class="Body">
228 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:
229 <div class="block"><pre>
230 #!/bin/sh
231 cd `dirname $0`
232 ./nexuiz-linux-686-sdl &quot;$@&quot;   # or ./nexuiz-linux-x86_64-sdl if you're using an AMD64/EM64T distributions
233 </pre></div>
234 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:
235 <div class="block"><pre>
236 cd /path/to/Nexuiz
237 chmod a+x nexuiz.sh
238 </pre></div>
239 Finally you can add the <tt>nexuiz.sh</tt> file to your desktop like any other program.
240 </p>
241 <!--End Section 2-->
242 <h3><a name="How do I open the console?">How do I open the console?</a></h3>
243 <p class="Body">
244 Press <tt>[shift]+[escape]</tt>. To close it press <tt>[escape]</tt>
245 </p>
246 <!--End Section 2-->
247 <h3><a name="What console commands/variables are there?">What console commands/variables are there?</a></h3>
248 <p class="Body">
249 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>.
250 </p>
251 <!--End Section 2-->
252 <h3><a name="How can I speed up my frame rate?">How can I speed up my frame rate?</a></h3>
253 <p class="Body">
254 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).
255 </p>
256 <!--End Section 2-->
257 <h3><a name="How can I activate colors in my name?">How can I activate colors in my name?</a></h3>
258 <p class="Body">
259 Colors can be used in nicknames and chat messages by typing ^ followed by a number between 0 and 9.
260 </p>
261 <!-- 2 columns --><center><table cellspacing="0">
262 <caption>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;    </caption>
263 <tr><th> code   </th><th> color&nbsp;&nbsp;     </th></tr>
264 <tr><td> ^0     </td><td> black&nbsp;&nbsp;     </td></tr>
265 <tr><td> ^1     </td><td> red&nbsp;&nbsp;</td></tr>
266 <tr><td> ^2     </td><td> green&nbsp;&nbsp;     </td></tr>
267 <tr><td> ^3     </td><td> yellow&nbsp;&nbsp;    </td></tr>
268 <tr><td> ^4     </td><td> blue&nbsp;&nbsp;      </td></tr>
269 <tr><td> ^5     </td><td> aqua&nbsp;&nbsp;      </td></tr>
270 <tr><td> ^6     </td><td> pink&nbsp;&nbsp;      </td></tr>
271 <tr><td> ^7     </td><td> white&nbsp;&nbsp;     </td></tr>
272 <tr><td> ^8     </td><td> light grey&nbsp;&nbsp;</td></tr>
273 <tr><td> ^9     </td><td> dark grey&nbsp;&nbsp; </td></tr>
274 </table></center>
275 <!--End Section 2-->
276 <h3><a name="How do i watch/record demos?">How do i watch/record demos?</a></h3>
277 <p class="Body">
278 To record a demo: open the console and type <tt>rec &lt;name&gt;</tt>. 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).
279 To watch a demo: open the console and type <tt>ply &lt;name&gt;</tt> (<tt>name</tt> is the filename without extension). If you downloaded a demo, copy it to <tt>Nexuiz/data/demos</tt> first.
280 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.nexuiz.com/forums/index.php?showtopic=1766&amp;st=0&amp;p=13400&amp;#entry13400">here</a>.
281 </p>
282 <!--End Section 2-->
283 <!-- End SectLevel2 -->
284 <!--End Section 1-->
285 <h2><a name="Development">Development</a></h2>
286 <!-- Start SectLevel2 -->
287 <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>
288 <p class="Body">
289 There's a <a class="link" href="http://www.nexuiz.com/forums/index.php?showtopic=195">detailed guide</a> on gtkradiant setup in the forums. There are also a <a class="link" href="http://www.nexuiz.com/forums/index.php?showtopic=195&amp;view=findpost&amp;p=11176">Linux shell script</a> and a <a class="link" href="http://www.nexuiz.com/forums/index.php?showtopic=195&amp;view=findpost&amp;p=11838">Windows application</a> that will configure your gtkradiant (1.4) automagically.
290 </p>
291 <!--End Section 2-->
292 <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>
293 <p class="Body">
294 <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>)
295 </p>
296 <p class="Body">
297 <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
298 <div class="block"><pre>
299 svn co svn://svn.icculus.org/nexuiz/trunk/
300 </pre></div>
301 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/menuqc</tt> and once in <tt>data/qcsrc/server</tt>.
302 </p>
303 <!--End Section 2-->
304 <!-- End SectLevel2 -->
305 <!--End Section 1-->
306 <!-- End SectLevel1 -->
307 <hr>
308 <br>
309 <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>
310 </body>
311 </html>
312