From 23b12288544f8878c30f8c582be0cb8f85a9dd13 Mon Sep 17 00:00:00 2001 From: esteel Date: Sat, 10 Jun 2006 17:44:40 +0000 Subject: [PATCH] Updated Docs and removed cl_autodemo from menu git-svn-id: svn://svn.icculus.org/nexuiz/trunk@1547 f962a42d-fe04-0410-a3ab-8c8b0445ebaa --- Docs/FAQ.aft | 20 ++++++++------------ Docs/FAQ.html | 23 ++++++++--------------- Docs/mapdownload.txt | 6 +++--- Docs/server/readme.txt | 20 ++++++++++++++++---- Docs/server/server.cfg | 2 ++ data/menu/demos.menu | 4 ++++ 6 files changed, 41 insertions(+), 34 deletions(-) diff --git a/Docs/FAQ.aft b/Docs/FAQ.aft index f1eb1788e..cc06de25c 100644 --- a/Docs/FAQ.aft +++ b/Docs/FAQ.aft @@ -37,22 +37,18 @@ Nexuiz This happens when the engine can't load the data*.pk3 file. The reasons could be: 1. you unpacked the zip file without folder names (see [How do I install Nexuiz?]) 2. on Linux: the current directory is not your Nexuiz/ folder (see [How can I place a shortcut to Nexuiz on my Linux desktop?]) - 3. your download might be corrupted + 3. your download might be corrupted, please download Nexuiz again ** The sound is broken, it crackles and stutters 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). ** When I join a server or after a map change I see nothing but a black screen, but I can still move and shoot -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. - -** Nexuiz is too slow -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|. -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. +This is probably because you don't have the map, that's running on the server. As Nexuiz does now support map/content download the server might 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://savage747.sa.funpic.de/wiki/pmwiki.php?n=Main.CustomMaps)] dedicated to new maps. * Server setup ** How do I start a server? -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)]. +Please take a look at the file |readme.txt| in the |Docs/server/| directory where this topic is explained. ** Which ports do I have to open in firewall/forward from my router to run a server? The default port is 26000 UDP. You can change that by starting Nexuiz with |nexuiz-sdl.exe -port | (on Windows) or |nexuiz-linux-686-sdl -port | (on Linux). @@ -82,7 +78,7 @@ Press |\[shift]+\[escape]|. To close it press |\[escape]| 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)]. ** How can I speed up my frame rate? -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). +The greatest performance boost can be achieved by turning off dynamic lights and shadows in the menu |Options / Effects|. Bloom is also quite resource. Other fps boots include disabeling |Deluxemapping| and |Coronas|. 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 ([How do I open the console?]) and type |gl__picmip #; r__restart| (where # is a number between 0 and 10, 0 is the highest quality). Nexuiz now does also include config files that will adjust your graphic settings. Open the console as explained in 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 what Nexuiz is able to look like but do require a very fast PC and graphic card. Just like the |gl_picmip| some of the settings in those config files require you to either restart Nexuiz or type |vid_restart| in the console afterwards. ** How can I activate colors in my name? Colors can be used in nicknames and chat messages by typing ^ followed by a number between 0 and 9. @@ -112,10 +108,10 @@ Colors can be used in nicknames and chat messages by typing ^ followed by a numb !----------------------------! ** How do i watch/record demos? -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. -You can also open the console and type |rec | to record a demo. The demo file will be stored in |~/.nexuiz/data/demos/.dem| (Linux) or |Nexuiz/data/demos/.dem| (Windows). -To watch a demo: open the console and type |ply | (|name| is the filename without extension). If you downloaded a demo, copy it to |Nexuiz/data/demos| first. -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)]. +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. +To record a demo yourself open the console ([How do I open the console?]) and type |rec | before playing. That is before starting a game or connection to a server. The demo file will be stored in |~/.nexuiz/data/demos/.dem| (Linux) or |Nexuiz/data/demos/.dem| (Windows). +To watch a demo: open the console and type |ply |. If you downloaded a demo, copy it to |Nexuiz/data/demos|. You might have to create this directory if you have never recorded a demo before. +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)]. A simple way to automaticly record demos can be found [here (http://www.alientrap.org/forum/viewtopic.php?t=90)] * Development diff --git a/Docs/FAQ.html b/Docs/FAQ.html index ff0f190a6..1a2053ed9 100644 --- a/Docs/FAQ.html +++ b/Docs/FAQ.html @@ -126,7 +126,6 @@ h1, h2, h3, h4, h5, h6 {
  • When I start Nexuiz all I see is a black screen with some checkered squares
  • The sound is broken, it crackles and stutters
  • When I join a server or after a map change I see nothing but a black screen, but I can still move and shoot
    • -
  • Nexuiz is too slow
  • Server setup
      • @@ -183,7 +182,7 @@ This happens when the engine can't load the data*.pk3 file. The reasons could be
      1. you unpacked the zip file without folder names (see How do I install Nexuiz?)
      2. on Linux: the current directory is not your Nexuiz/ folder (see How can I place a shortcut to Nexuiz on my Linux desktop?)
        3. -
      3. your download might be corrupted
        4. +
      4. your download might be corrupted, please download Nexuiz again

      @@ -194,13 +193,7 @@ Try run nexuiz-sdl.exe instead of nexuiz.exe (on Windows). Add

      When I join a server or after a map change I see nothing but a black screen, but I can still move and shoot

      -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 dedicated to new maps. -

      - -

      Nexuiz is too slow

      -

      -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. -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. +This is probably because you don't have the map, that's running on the server. As Nexuiz does now support map/content download the server might 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 dedicated to new maps.

      @@ -209,7 +202,7 @@ Nexuiz does also include config files that will adjust your graphic settings. Op

      How do I start a server?

      -There's a tutorial on how to setup up an dedicated server in this forum post. +Please take a look at the file readme.txt in the Docs/server/ directory where this topic is explained.

      Which ports do I have to open in firewall/forward from my router to run a server?

      @@ -256,7 +249,7 @@ You can get a list of variables by entering cvarlist on the console.

      How can I speed up my frame rate?

      -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). +The greatest performance boost can be achieved by turning off dynamic lights and shadows in the menu Options / Effects. Bloom is also quite resource. Other fps boots include disabeling Deluxemapping and Coronas. 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 (How do I open the console?) and type gl_picmip #; r_restart (where # is a number between 0 and 10, 0 is the highest quality). Nexuiz now does also include config files that will adjust your graphic settings. Open the console as explained in 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 what Nexuiz is able to look like but do require a very fast PC and graphic card. Just like the glpicmip some of the settings in those config files require you to either restart Nexuiz or type vidrestart in the console afterwards.

      How can I activate colors in my name?

      @@ -280,10 +273,10 @@ Colors can be used in nicknames and chat messages by typing ^ followed by a numb

      How do i watch/record demos?

      -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. -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). -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. -You can list all your demo files by typing dem on the console. Some usefull keybindings for viewing demos are listed here. +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. +To record a demo yourself open the console (How do I open the console?) and type rec <name> before playing. That is before starting a game or connection to a server. The demo file will be stored in ~/.nexuiz/data/demos/<name>.dem (Linux) or Nexuiz/data/demos/<name>.dem (Windows). +To watch a demo: open the console and type ply <name>. If you downloaded a demo, copy it to Nexuiz/data/demos. You might have to create this directory if you have never recorded a demo before. +You can list all your demo files by typing dem on the console. Some usefull keybindings for viewing demos are listed here. A simple way to automaticly record demos can be found here

      diff --git a/Docs/mapdownload.txt b/Docs/mapdownload.txt index cb8276412..ab2704615 100644 --- a/Docs/mapdownload.txt +++ b/Docs/mapdownload.txt @@ -12,9 +12,9 @@ cvars for further tuning: cl_curl_maxspeed maximum total speed in KiB/s (default: 100) Downloaded packages end up in the "dlcache" subdirectory of your data -directory. They are not loaded by default. If you want to keep a package and -make it appear in the map selection menu, you can "accept" the package by -moving it one level up - right next to your config.cfg. +directory and are used till you exit Nexuiz. If you want to play them +localy or use them to setup a server of your own you can "accept" the +packages by moving it one level up - right next to your config.cfg. You should regularily clean up your cache to save space and make the maps you really want available from the menu. diff --git a/Docs/server/readme.txt b/Docs/server/readme.txt index 6ce199d13..4fae0e956 100644 --- a/Docs/server/readme.txt +++ b/Docs/server/readme.txt @@ -7,11 +7,23 @@ either into the Nexuiz/data directory where the big data*.pk3 file is or when running linux or a mac you can as well copy it into a special directory called ~/.nexuiz/data . -After you have adjusted the config file you can start the server by -executing the server script. The options in the config file are only -the most interesting and important ones. You can find more -information about setting up a dedicated server in the Nexuiz Wiki: +An important thing is to make sure that your firewall does allow to +contact your server. This typicly means you will have to open or +forward the port (see the line in your config.cfg +for the right port number) to the computer running your server. How +to do this does depend on your computer setup. + +If you plan to install custom maps on your server you should read the +file Docs/mapdownload.txt to learn how to setup automatic map +download. + +After you have setup everything and have adjusted the config file you +can start the server by executing the server script. The options in +the config file are only the most interesting and important ones. You +can find more information about setting up a dedicated server in the +Nexuiz Wiki: http://savage747.sa.funpic.de/wiki/pmwiki.php?n=Main.DedicatedServer + Some more info about the available variables and commands: http://savage747.sa.funpic.de/wiki/pmwiki.php?n=Main.GameTweaks http://savage747.sa.funpic.de/wiki/pmwiki.php?n=Main.ConsoleCommands diff --git a/Docs/server/server.cfg b/Docs/server/server.cfg index af19bc339..a442ec888 100644 --- a/Docs/server/server.cfg +++ b/Docs/server/server.cfg @@ -12,6 +12,7 @@ set "log_file" "server.log" // server console output will also be copied to this set "sv_clientcommands" "0" // "1" allows you to issue client side commands to the server set "sv_clientcommands_password" "hackme" // you will then need to authenticate with this password set "rcon_password" "" // you can also use rcon if this password is set and will need to authenticate with this password +set "sv_curl_defaulturl" "" //default download URL set "sv_vote_commands" "restart timelimit fraglimit chmap g_grappling_hook sv_defaultplayer_fbskin_green sv_defaultplayer_fbskin_red sv_defaultplayer_fbskin_orange sv_defaultplayer_fbskin_off" // players can vote for those commands set "sv_vote_call" "1" // "1" will allow people to call votes "0" will disable this feature @@ -21,6 +22,7 @@ set "sv_vote_wait" "120" // how long a votecaller has to wait if his vote did no set "sv_ready_restart" "0" // "1" to allow players to restart the server when all of them signal they are ready set "sv_autoscreenshot" "0" // "1" will force a screenshot for all clients when the map ends. Useful for the Nexuiz ladder. +set "sv_cullentities_trace" "0" // "1" will remove unseen objects so wallhacks to do work. It nor perfect but useful for the Nexuiz ladder set "sv_defaultcharacter" "0" // "1" will force a specific model for all players set "sv_defaultplayermodel" "models/player/nexus.zym" // this model will be used diff --git a/data/menu/demos.menu b/data/menu/demos.menu index 008020f66..b9b4568fe 100644 --- a/data/menu/demos.menu +++ b/data/menu/demos.menu @@ -63,6 +63,9 @@ Item Window Demos action Nex_Demos_Start } } +// until its fixed in the engine.. +Ignore +{ Item Layout Settings { size '1000 200' @@ -95,3 +98,4 @@ Item Window Demos } } } +} -- 2.39.2