Corrected Docs to say Nexuiz 2.0
[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 2.0 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 2.0 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 <li> <a class="link" href="#Nexuiz is too slow">Nexuiz is too slow</a></li>
130 </ul>
131 <li> <a class="link" href="#Server setup">Server setup</a></li>
132 <ul>
133 <li> <a class="link" href="#How do I start a server?">How do I start a server?</a></li>
134 <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>
135 <li> <a class="link" href="#Is there some kind of rcon?">Is there some kind of rcon?</a></li>
136 <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>
137 </ul>
138 <li> <a class="link" href="#General questions">General questions</a></li>
139 <ul>
140 <li> <a class="link" href="#How do I install new maps?">How do I install new maps?</a></li>
141 <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>
142 <li> <a class="link" href="#How do I open the console?">How do I open the console?</a></li>
143 <li> <a class="link" href="#What console commands/variables are there?">What console commands/variables are there?</a></li>
144 <li> <a class="link" href="#How can I speed up my frame rate?">How can I speed up my frame rate?</a></li>
145 <li> <a class="link" href="#How can I activate colors in my name?">How can I activate colors in my name?</a></li>
146 <li> <a class="link" href="#How do i watch/record demos?">How do i watch/record demos?</a></li>
147 </ul>
148 <li> <a class="link" href="#Development">Development</a></li>
149 <ul>
150 <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>
151 <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>
152
153 </li>
154 </ul>
155 </ul>
156 <hr>
157 <!-- Start SectLevel1 -->
158 <h2><a name="Troubleshooting">Troubleshooting</a></h2>
159 <!-- Start SectLevel2 -->
160 <h3><a name="How do I install Nexuiz?">How do I install Nexuiz?</a></h3>
161 <p class="Body">
162 Just unzip the <tt>nexuiz20.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:
163 <div class="block"><pre>
164 Nexuiz
165 |-- Docs
166 |-- Nexuiz-SDL.app
167 |   |-- *
168 |-- data
169 |   |-- data*.pk3
170 |-- navnodeedit
171 |   |-- progs.dat
172 |   |-- *.cfg
173 |   |-- *
174 |-- *.exe
175 |-- *.dll
176 `-- nexuiz-linux-*
177 </pre></div>
178 </p>
179 <!--End Section 2-->
180 <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>
181 <p class="Body">
182 This happens when the engine can't load the data*.pk3 file. The reasons could be:
183 <ol>
184 <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>
185 <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>
186 <li> your download might be corrupted</li>
187 </ol>
188 </p>
189 <!--End Section 2-->
190 <h3><a name="The sound is broken, it crackles and stutters">The sound is broken, it crackles and stutters</a></h3>
191 <p class="Body">
192 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).
193 </p>
194 <!--End Section 2-->
195 <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>
196 <p class="Body">
197 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.
198 </p>
199 <!--End Section 2-->
200 <h3><a name="Nexuiz is too slow">Nexuiz is too slow</a></h3>
201 <p class="Body">
202 To speed up Nexuiz turn off some of the settings in the menu <tt>Options / Effects</tt>. Turning off some or all of the <tt>realtime effects</tt> will help the most. Other fps boots include disabeling <tt>Deluxemapping</tt>, <tt>Bloom</tt> and <tt>Coronas</tt>.
203 Nexuiz does also include config files that will adjust your graphic settings. Open the console as explained in this FAQ 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 off what Nexuiz is able to look like but do require a very fast PC.
204 </p>
205 <!--End Section 2-->
206 <!-- End SectLevel2 -->
207 <!--End Section 1-->
208 <h2><a name="Server setup">Server setup</a></h2>
209 <!-- Start SectLevel2 -->
210 <h3><a name="How do I start a server?">How do I start a server?</a></h3>
211 <p class="Body">
212 There's a tutorial on how to setup up an dedicated server in this <a class="link" href="http://www.alientrap.org/forum/viewtopic.php?t=18">forum post</a>.
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 <tt>nexuiz-sdl.exe -port &lt;port&gt;</tt> (on Windows) or <tt>nexuiz-linux-686-sdl -port &lt;port&gt;</tt> (on Linux).
218 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;.
219 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.
220 </p>
221 <!--End Section 2-->
222 <h3><a name="Is there some kind of rcon?">Is there some kind of rcon?</a></h3>
223 <p class="Body">
224 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.
225 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>).
226 </p>
227 <!--End Section 2-->
228 <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>
229 <p class="Body">
230 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 #).
231 </p>
232 <!--End Section 2-->
233 <!-- End SectLevel2 -->
234 <!--End Section 1-->
235 <h2><a name="General questions">General questions</a></h2>
236 <!-- Start SectLevel2 -->
237 <h3><a name="How do I install new maps?">How do I install new maps?</a></h3>
238 <p class="Body">
239 Maps usually ship as *.pk3 file. All you have to do is to copy this file to your <tt>Nexuiz/data/</tt> directory.
240 </p>
241 <!--End Section 2-->
242 <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>
243 <p class="Body">
244 Use the script <tt>nexuiz-linux.sh</tt> instead of the binary. It will use the right version (32 or 64 bit).
245 </p>
246 <!--End Section 2-->
247 <h3><a name="How do I open the console?">How do I open the console?</a></h3>
248 <p class="Body">
249 Press <tt>[shift]+[escape]</tt>. To close it press <tt>[escape]</tt>
250 </p>
251 <!--End Section 2-->
252 <h3><a name="What console commands/variables are there?">What console commands/variables are there?</a></h3>
253 <p class="Body">
254 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>.
255 </p>
256 <!--End Section 2-->
257 <h3><a name="How can I speed up my frame rate?">How can I speed up my frame rate?</a></h3>
258 <p class="Body">
259 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).
260 </p>
261 <!--End Section 2-->
262 <h3><a name="How can I activate colors in my name?">How can I activate colors in my name?</a></h3>
263 <p class="Body">
264 Colors can be used in nicknames and chat messages by typing ^ followed by a number between 0 and 9.
265 </p>
266 <!-- 2 columns --><center><table cellspacing="0">
267 <caption>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;    </caption>
268 <tr><th> code   </th><th> color&nbsp;&nbsp;     </th></tr>
269 <tr><td> ^0     </td><td> black&nbsp;&nbsp;     </td></tr>
270 <tr><td> ^1     </td><td> red&nbsp;&nbsp;</td></tr>
271 <tr><td> ^2     </td><td> green&nbsp;&nbsp;     </td></tr>
272 <tr><td> ^3     </td><td> yellow&nbsp;&nbsp;    </td></tr>
273 <tr><td> ^4     </td><td> blue&nbsp;&nbsp;      </td></tr>
274 <tr><td> ^5     </td><td> aqua&nbsp;&nbsp;      </td></tr>
275 <tr><td> ^6     </td><td> pink&nbsp;&nbsp;      </td></tr>
276 <tr><td> ^7     </td><td> white&nbsp;&nbsp;     </td></tr>
277 <tr><td> ^8     </td><td> light grey&nbsp;&nbsp;</td></tr>
278 <tr><td> ^9     </td><td> dark grey&nbsp;&nbsp; </td></tr>
279 </table></center>
280 <!--End Section 2-->
281 <h3><a name="How do i watch/record demos?">How do i watch/record demos?</a></h3>
282 <p class="Body">
283 You can access your demos and demo settings in the <tt>Demos</tt> menu. Click on the demo you want to watch and then on <tt>Start</tt> to watch the demo.  You can enable demo recording if you click on the <tt>Off/On</tt> option besides <tt>Automaticly record a Demo when playing</tt>. The demo will be recorded as soon as you start a game or join a server.
284 You can also open the console and type <tt>rec &lt;name&gt;</tt> to record a demo. 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).
285 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.
286 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>.
287 </p>
288 <!--End Section 2-->
289 <!-- End SectLevel2 -->
290 <!--End Section 1-->
291 <h2><a name="Development">Development</a></h2>
292 <!-- Start SectLevel2 -->
293 <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>
294 <p class="Body">
295 There's a <a class="link" href="http://www.alientrap.org/forum/viewtopic.php?t=10">guide</a> on gtkradiant setup in the forums.
296 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.
297 </p>
298 <!--End Section 2-->
299 <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>
300 <p class="Body">
301 <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>)
302 </p>
303 <p class="Body">
304 <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
305 <div class="block"><pre>
306 svn co svn://svn.icculus.org/nexuiz/trunk/
307 </pre></div>
308 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>.
309 </p>
310 <!--End Section 2-->
311 <!-- End SectLevel2 -->
312 <!--End Section 1-->
313 <!-- End SectLevel1 -->
314 <hr>
315 <br>
316 <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>
317 </body>
318 </html>
319