Docs/FAQ.aft

   1 #--- AFT (Almost Free Text) source file for Nexuiz FAQ
   2 #--- WARNING: ALWAYS RUN AFT TWICE! (otherwise the toc is missing/not up to date)
   3 #--- use AFT v5.096 or later (http://www.maplefish.com/todd/aft.html)
   4
   5 #---SET nexversion=3
   6 #---SET zipname=nexuiz-<version>.zip
   7
   8 *Title: Nexuiz %nexversion% FAQ
   9                         http://nexuiz.com       http://alientrap.org
  10
  11 ------
  12
  13 *TOC
  14
  15 ------
  16
  17 * Troubleshooting
  18
  19 ** How do I install Nexuiz?
  20 Just unzip the |%zipname%| file. You can do this with any archive program (like [7zip (http://7zip.org)]). It's very important to keep the directory structure while unpacking (in WinZip this option is called "Use folder names"). The directory structure should look like this afterwards:
  21 ^<<
  22 Nexuiz
  23 |-- Docs
  24 |-- Nexuiz-SDL.app
  25 |   |-- *
  26 |-- data
  27 |   |-- data*.pk3
  28 |-- *.exe
  29 |-- *.dll
  30 `-- nexuiz-linux-*
  31 ^>>
  32
  33 ** When I start Nexuiz all I see is a black screen or a black screen with some checkered squares
  34 This happens when the engine can't load the data*.pk3 file or has trouble to initialize OpenGL. The reasons could be:
  35         1. you unpacked the zip file without folder names (see [How do I install Nexuiz?])
  36         2. on Linux: the current directory is not your Nexuiz/ folder. See [How can I place a shortcut to Nexuiz on my Linux desktop?] on how to fix this
  37         3. on Mac: you tried to extract and move the files from a Nexuiz update and it deleted the old files. When using the mac GUI please be sure to move only the files not the folders as that will delete the old files or use the mv console command which will not delete the old files
  38         4. the engine could not initialize OpenGL. Please install the latest drivers for your graphic card. You will probably find one for your card there: [intel (http://intel.com)] [ati (http://ati.com)] [nvidia (http://nvidia.com)]
  39         5. your download might be corrupted, please download Nexuiz again
  40
  41 ** The sound is broken, it crackles and stutters
  42 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 Linux, Mac, Windows).
  43
  44 ** I can't switch to 32 bit color depth (on Windows)
  45 Check if your desktop color depth is set to 32 bits per pixel. If it's just set to 16, Nexuiz can't switch to 32 bit mode.
  46
  47 ** When I join a server or after a map change I see nothing but a black screen, but I can still move and shoot
  48 This is probably because you don't have the map that's running on the server. As Nexuiz does now supports map/content download the server might not be be setup to support this and you will have to get the map the old fashioned way. Those servers will have a download URL in their name or welcome message. There is also a [wiki page (http://alientrap.org/wiki/pmwiki.php?n=Main.CustomMaps)] dedicated to new maps.
  49 For Linux users: you need to have libcurl installed, otherwise you won't be able to download any maps. libcurl should be available in any Linux distribution, just search for "libcurl" and install it in your distribution's package manager.
  50
  51 * Server setup
  52
  53 ** How do I start a server?
  54 Use the |Create| menu to start a |listen server|. You will always have to play in a |listen server|.
  55 If you want to create a server without being forced to play yourself please take a look at the file |readme.txt| in the |Docs/server/| directory where the |dedicated server| is explained.
  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 the parameter |-port <port>| or having a line |port <port>| in the server config file.
  59 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. To add the command line argument on Windows, create a new shortcut to |nexuiz.exe| or |nexuiz-dedicated.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". The parameter will be used if you start Nexuiz via that new shortcut.
  60
  61 ** Is there some kind of rcon?
  62 Yes starting with Nexuiz 2.0 there is rcon (QuakeWorld compatible). To use it you must enter |rcon__password <password>| in the server console or server config file. The Nexuiz client has to set the same password in the same fashion. You can then issue commands with |rcon <command>| if you are connected to the server or have set |rcon__address <ip/hostname>| or |rcon__address <ip/hostname>:<port>| to point to the server. There are also external rcon tools but make sure you use a QW compatible rcon tool.
  63
  64 ** How can i kick people who are using special characters in their names?
  65 Enter |status| at the server 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 #).
  66
  67
  68 * General questions
  69
  70 ** How do I install new maps?
  71 Maps usually ship as *.pk3 file. All you have to do is to copy this file to the |Nexuiz/data/| (on Linux, Mac, Windows) OR |~/.nexuiz/data/| (on Linux, Mac) directory.
  72
  73 ** How can I place a shortcut to Nexuiz on my Linux desktop?
  74 Use the script |nexuiz-linux-sdl.sh| or |nexuiz-linux-glx.sh| instead of the binaries. The scripts will use the correct |working directory|,choose the right version (32 or 64 bit) and also allow you to start a extra X server.
  75
  76 ** How do I open the console?
  77 Press |\[shift]+\[escape]|. To close it press |\[escape]|
  78
  79 ** What console commands/variables are there?
  80 You can get a list of variables by entering |cvarlist| on the console ([How do I open 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://alientrap.org/wiki/pmwiki.php?n=Main.ConsoleCommands)].
  81
  82 ** How can I speed up my frame rate?
  83 The greatest performance boost can be achieved by turning off dynamic lights and shadows in the menu |Options / Effects|. Bloom is also quite resource intensive. Other fps boots include disabling |Deluxemapping| and |Coronas|. On older graphics cards or on-board/notebook chips with little video ram you can try to lower the texture quality in the menu |Options / Video|. Some older cards also run faster when you disable |OpenGL 2.0 Shaders| but in general for most cards it should be active. Nexuiz also includes config files that will adjust your graphic settings. Open the console ([How do I open the console?]) and type |exec normal.cfg| to get the default setting (back). |exec med.cfg| and |exec low.cfg| are of lower quality but will make Nexuiz run faster. |exec high.cfg|, |exec ultra.cfg| and |exec ultimate.cfg| will show what Nexuiz is able to look like but do require a very fast PC and graphic card. Some of the settings in those config files require you to either restart Nexuiz or also type |vid_restart| in the console after exec'ing the config files.
  84
  85 ** How can I activate colors in my name?
  86 Colors can be used in nicknames and chat messages by typing ^ followed by a number between 0 and 9.
  87
  88         !                            !
  89         ! code   ! color             !
  90         !----------------------------!
  91         ! ^0     ! black             !
  92         !----------------------------!
  93         ! ^1     ! red               !
  94         !----------------------------!
  95         ! ^2     ! green             !
  96         !----------------------------!
  97         ! ^3     ! yellow            !
  98         !----------------------------!
  99         ! ^4     ! blue              !
 100         !----------------------------!
 101         ! ^5     ! aqua              !
 102         !----------------------------!
 103         ! ^6     ! pink              !
 104         !----------------------------!
 105         ! ^7     ! white             !
 106         !----------------------------!
 107         ! ^8     ! light grey        !
 108         !----------------------------!
 109         ! ^9     ! dark grey         !
 110         !----------------------------!
 111
 112 ** How do i watch/record demos?
 113 You can access your demos in the |Demos| menu. Click on the demo you want to watch and then on |Start| to watch the demo. Or type |ply <name>| in the console ([How do I open the console?]).
 114 To record a demo yourself open the console and type |rec <name>| before playing. That is before starting a game or connecting to a server. The demo file will be stored in |Nexuiz/data/demos/<name>.dem| (on Windows) or |~/.nexuiz/data/demos/<name>.dem| (on Linux, Mac).
 115 If you downloaded a demo, copy it to |Nexuiz/data/demos/<name>.dem| (on Linux, Mac, Windows) or |~/.nexuiz/data/demos/<name>.dem| (on Linux, Mac). You might have to create this directory if you have never recorded a demo before.
 116 You can list all your demo files by typing |dem| on the console. Some useful key bindings for viewing demos are listed [here (http://www.alientrap.org/forum/viewtopic.php?p=357#357)]. A simple way to automatically record demos can be found [here (http://www.alientrap.org/forum/viewtopic.php?t=90)]
 117
 118
 119 * Development
 120
 121 ** How do i set up gtkradiant to create/edit Nexuiz maps?
 122 There's a [guide (http://www.alientrap.org/forum/viewtopic.php?t=10)] on gtkradiant setup in the forums.
 123 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.
 124
 125 ** Where can i get latest development versions of the source code?
 126 _Engine:_ instructions are available at http://icculus.org/twilight/darkplaces/download.html look for |Accessing the SVN server| (you will need a [svn client (http://subversion.tigris.org/project_packages.html)], beta builds are available [here (http://icculus.org/twilight/darkplaces/files/)])
 127
 128 _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 command line svn client, do
 129 ^<<
 130 svn co svn://svn.icculus.org/nexuiz/trunk/
 131 ^>>
 132 To compile the game code 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/qcsrc/menu| and once in |data/qcsrc/server|.