added FAQ and moved all help files to Docs/
[divverent/nexuiz.git] / Docs / FAQ.aft
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
4 *Title: Nexuiz 1.3 FAQ
5                         http://nexuiz.com       http://alientrap.org
6
7 ------
8
9 *TOC
10
11 ------
12
13 * Troubleshooting
14
15 ** How do I install Nexuiz?
16 Just unzip the |nexuiz13.zip| file. You can do this with any archive program (like [7zip (http://7zip.org)]). It's very important to remain the directory structure while unpacking (in WinZip this option is called "Use folder names"). The directory structure should look like this afterwards:
17 ^<<
18 Nexuiz
19 |-- data
20 |   |-- data*.pk3
21 |-- *.exe
22 |-- *.dll
23 `-- nexuiz-linux-*
24 ^>>
25
26 ** When I start Nexuiz all I see is a black screen with some checkered squares
27 This happens when the engine can't load the data*.pk3 file. The reasons could be:
28         1. you unpacked the zip file without folder names (see [How do I install Nexuiz?])
29         2. on Linux: the current directory is not your Nexuiz/ folder (see [How can I place a shortcut to Nexuiz on my Linux desktop?])
30         3. your download might be corrupted
31
32 ** The sound is broken, it crackles and stutters
33 Try run |nexuiz-sdl.exe| (on Windows) or |nexuiz-linux-686-sdl| (on Linux). This version usually performs better on newer sound cards than |nexuiz.exe|/|nexuiz-linux-686-glx|.
34
35 ** When I join a server or after a map change I see nothing but a black screen, but I can still move and shoot
36 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 [wiki page (http://savage747.sa.funpic.de/wiki/pmwiki.php?n=Main.CustomMaps)] dedicated to new maps.
37
38
39
40 * Server setup
41
42 ** How do I start a server?
43 There's a tutorial on how to setup up an dedicated server in this [forum post (http://www.nexuiz.com/forums/index.php?showtopic=1236)].
44
45 ** Which ports do I have to open in firewall/forward from my router to run a server?
46 The default port is 26000 UDP. You can change that by starting Nexuiz with |nexuiz-sdl.exe -port <port>| (on Windows) or |nexuiz-linux-686-sdl -port <port>| (on Linux).
47 To add the command line argument on Windows, create a new shortcut to |nexuiz-sdl.exe| and right click on it. Select properties and |-port <port>| in the "Target:" line. Be sure that the "Start in:" line contains the full path to your Nexuiz folder and clock "OK".
48
49
50
51 * General questions
52
53 ** How do I install new maps?
54 Maps usually ship as *.pk3 file. All you have to do is to copy this file to your |Nexuiz/data/| directory.
55
56 ** How can I place a shortcut to Nexuiz on my Linux desktop?
57 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:
58 ^<<
59 #!/bin/sh
60 cd /path/to/Nexuiz              # replace this with the full path to your Nexuiz folder
61 ./nexuiz-linux-686-sdl "$@"     # or ./nexuiz-linux-x86_64-sdl if you're using an AMD64/EM64T distributions
62 ^>>
63 Save this in your Nexuiz directory as |nexuiz.sh|. Now you have to make this file executable by opening a xterm/konsole and typing:
64 ^<<
65 cd /path/to/Nexuiz
66 chmod a+x nexuiz.sh
67 ^>>
68 Finally you can add the |nexuiz.sh| file to your desktop like any other program.
69
70 ** How do I open the console?
71 Press |\[shift]+\[escape]|. To close it press |\[escape]|
72
73 ** What console commands/variables are there?
74 You can get a list of variables by entering |cvarlist| on the console. |cmdlist| will give you a list of available commands. An annotated version of that output can be found at the [Nexuiz wiki (http://savage747.sa.funpic.de/wiki/pmwiki.php?n=Main.ConsoleCommands)].
75
76 ** How can I speed up my frame rate?
77 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 |gl__picmip #; r__restart| (where # is a number between 0 and 10, 0 is the highest quality).
78
79 ** How can I activate colors in my name?
80 Colors can be used in nicknames and chat messages by typing ^ followed by a number between 0 and 9.
81
82         !                            !
83         ! code   ! color             !
84         !----------------------------!
85         ! ^0     ! black             !
86         !----------------------------!
87         ! ^1     ! red               !
88         !----------------------------!
89         ! ^2     ! green             !
90         !----------------------------!
91         ! ^3     ! yellow            !
92         !----------------------------!
93         ! ^4     ! blue              !
94         !----------------------------!
95         ! ^5     ! aqua              !
96         !----------------------------!
97         ! ^6     ! pink              !
98         !----------------------------!
99         ! ^7     ! white             !
100         !----------------------------!
101         ! ^8     ! light grey        !
102         !----------------------------!
103         ! ^9     ! dark grey         !
104         !----------------------------!