Corrected Docs to say Nexuiz 2.0
[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 #---SET nexversion=2.0
5 #---SET zipname=nexuiz20.zip
6
7 *Title: Nexuiz %nexversion% FAQ
8                         http://nexuiz.com       http://alientrap.org
9
10 ------
11
12 *TOC
13
14 ------
15
16 * Troubleshooting
17
18 ** How do I install Nexuiz?
19 Just unzip the |%zipname%| 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:
20 ^<<
21 Nexuiz
22 |-- Docs
23 |-- Nexuiz-SDL.app
24 |   |-- *
25 |-- data
26 |   |-- data*.pk3
27 |-- navnodeedit
28 |   |-- progs.dat
29 |   |-- *.cfg
30 |   |-- *
31 |-- *.exe
32 |-- *.dll
33 `-- nexuiz-linux-*
34 ^>>
35
36 ** When I start Nexuiz all I see is a black screen with some checkered squares
37 This happens when the engine can't load the data*.pk3 file. The reasons could be:
38         1. you unpacked the zip file without folder names (see [How do I install Nexuiz?])
39         2. on Linux: the current directory is not your Nexuiz/ folder (see [How can I place a shortcut to Nexuiz on my Linux desktop?])
40         3. your download might be corrupted
41
42 ** The sound is broken, it crackles and stutters
43 Try run |nexuiz-sdl.exe| instead of |nexuiz.exe| (on Windows). Adding the command line options |-sndspeed 48000| and/or |-sndstereo| can also help on some systems (on Windows, Linux, Mac).
44
45 ** When I join a server or after a map change I see nothing but a black screen, but I can still move and shoot
46 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.
47
48 ** Nexuiz is too slow
49 To speed up Nexuiz turn off some of the settings in the menu |Options / Effects|. Turning off some or all of the |realtime effects| will help the most. Other fps boots include disabeling |Deluxemapping|, |Bloom| and |Coronas|.
50 Nexuiz does also include config files that will adjust your graphic settings. Open the console as explained in this FAQ and type |exec normal.cfg| to get the default setting. |exec med.cfg| and |exec low.cfg| are of lower quality but will make Nexuiz faster. |exec high.cfg| and |exec ultra.cfg| will show off what Nexuiz is able to look like but do require a very fast PC.
51
52 * Server setup
53
54 ** How do I start a server?
55 There's a tutorial on how to setup up an dedicated server in this [forum post (http://www.alientrap.org/forum/viewtopic.php?t=18)].
56
57 ** Which ports do I have to open in firewall/forward from my router to run a server?
58 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).
59 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 click "OK".
60 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.
61
62 ** Is there some kind of rcon?
63 Yes starting with Nexuiz 2.0 there is rcon (QuakeWorld compatible). To use it you must enter |set rcon__password hackme| 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 |rcon <command>|. There are also external rcon tools but make sure you use a QW compatible rcon tool.
64 There is also a feature called |client side commands|. To enable it enter |set sv__clientcommands 1| on your server console. Don't forget to set a password with |set sv__clientcommands__password hackme|. Now you can become admin ingame by entering |ccl hackme| on the client console. To issue commands enter |cc <command>| (e.g. |cc restart| or |cc chmap dm_nexdm12|).
65
66 ** How can i kick people who are using special characters in their names?
67 Enter |status| 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 |kick # <player id> <reason>| (notice the space after #).
68
69
70 * General questions
71
72 ** How do I install new maps?
73 Maps usually ship as *.pk3 file. All you have to do is to copy this file to your |Nexuiz/data/| directory.
74
75 ** How can I place a shortcut to Nexuiz on my Linux desktop?
76 Use the script |nexuiz-linux.sh| instead of the binary. It will use the right version (32 or 64 bit).
77
78 ** How do I open the console?
79 Press |\[shift]+\[escape]|. To close it press |\[escape]|
80
81 ** What console commands/variables are there?
82 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)].
83
84 ** How can I speed up my frame rate?
85 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).
86
87 ** How can I activate colors in my name?
88 Colors can be used in nicknames and chat messages by typing ^ followed by a number between 0 and 9.
89
90         !                            !
91         ! code   ! color             !
92         !----------------------------!
93         ! ^0     ! black             !
94         !----------------------------!
95         ! ^1     ! red               !
96         !----------------------------!
97         ! ^2     ! green             !
98         !----------------------------!
99         ! ^3     ! yellow            !
100         !----------------------------!
101         ! ^4     ! blue              !
102         !----------------------------!
103         ! ^5     ! aqua              !
104         !----------------------------!
105         ! ^6     ! pink              !
106         !----------------------------!
107         ! ^7     ! white             !
108         !----------------------------!
109         ! ^8     ! light grey        !
110         !----------------------------!
111         ! ^9     ! dark grey         !
112         !----------------------------!
113
114 ** How do i watch/record demos?
115 You can access your demos and demo settings in the |Demos| menu. Click on the demo you want to watch and then on |Start| to watch the demo.  You can enable demo recording if you click on the |Off/On| option besides |Automaticly record a Demo when playing|. The demo will be recorded as soon as you start a game or join a server.
116 You can also open the console and type |rec <name>| to record a demo. The demo file will be stored in |~/.nexuiz/data/demos/<name>.dem| (Linux) or |Nexuiz/data/demos/<name>.dem| (Windows).
117 To watch a demo: open the console and type |ply <name>| (|name| is the filename without extension). If you downloaded a demo, copy it to |Nexuiz/data/demos| first.
118 You can list all your demo files by typing |dem| on the console. Some usefull keybindings for viewing demos are listed [here (http://www.alientrap.org/forum/viewtopic.php?p=357#357)].
119
120
121 * Development
122
123 ** How do i set up gtkradiant to create/edit Nexuiz maps?
124 There's a [guide (http://www.alientrap.org/forum/viewtopic.php?t=10)] on gtkradiant setup in the forums.
125 There are also [Windows tool (http://www.alientrap.org/forum/viewtopic.php?p=33)] that will help you to setup gtkradiant 1.4 and a [Linux script (http://www.alientrap.org/forum/viewtopic.php?p=841)] to configure gtkradiant 1.5.
126
127 ** Where can i get latest development versions of the source code?
128 _Engine:_ instructions are available at http://icculus.org/twilight/darkplaces/download.html (you will need a [cvs client (http://www.nongnu.org/cvs/)], beta builds are available [here (http://icculus.org/twilight/darkplaces/files/)])
129
130 _Game data:_ to check out the Nexuiz svn, you'll need a [svn client (http://subversion.tigris.org/project_packages.html)]. To check out the repository with a commandline svn client, do
131 ^<<
132 svn co svn://svn.icculus.org/nexuiz/trunk/
133 ^>>
134 To compile the gamecode you need [fteqcc (http://sourceforge.net/project/showfiles.php?group\_id=116842&package\_id=129507)]. Just download it and run it twice, once in |data/menuqc| and once in |data/qcsrc/server|.