home *** CD-ROM | disk | FTP | other *** search
/ GameStar 2001 July / Gamestar_31_2001-07_cd1.bin / PATCHE / NOLFUpdate003.exe / Game / serverreadme.txt < prev    next >
Text File  |  2001-04-27  |  20KB  |  415 lines

  1. ===============================================================================
  2.                               NO ONE LIVES FOREVER
  3.                          NolfServ Readme Version 1.003
  4.                                April 27, 2001
  5. ===============================================================================
  6.  
  7. NolfServ Wizard
  8. ---------------
  9.  
  10. You can run a dedicated server on the Internet, or on your local LAN.  You must
  11. have a FULL install of No One Lives Forever v1.003 to run NolfServ v1.003.  Ideally, 
  12. the hosting system will exceed the minimum system spec for processor speed and 
  13. RAM. Players will experience smoother gameplay on your server if it has more of 
  14. both of these things. A high-bandwidth Internet connection (ISDN or faster) is 
  15. also preferable.
  16.  
  17. Run the dedicated server either by clicking the NolfServ server icon in your 
  18. start menu, or by double-clicking the NolfServ.exe in your Nolf installation 
  19. folder. You will then go through a multiplayer setup wizard.  The pages of the 
  20. wizard correspond to the in-game hosting menus.  Please refer to manual about 
  21. the in game hosting server options.
  22.  
  23. New to NolfServ v1.003 is the Customization Options page of the setup Wizard.
  24. This will be the first page displayed if you have a Custom folder containing
  25. Add-on .rez files (see the No One Lives Forever Update 1.003 readme for more
  26. information about custom levels).  The Customization Options page allows you
  27. to run custom Add-on .rez files containing new levels/resources on your server.
  28.  
  29.  
  30. The NOLF Server Setup Wizard page allows you to set the following settings:
  31.  
  32.     * Session Name: This is the name of your server as seen by players when 
  33.                     they are looking for a server to join.
  34.  
  35.     * Game Type: This is either "H.A.R.M. vs. UNITY" or "Deathmatch"
  36.  
  37.     * Max Players: Maximum number of players allowed to play (2-16)
  38.  
  39.     * Port: This is the port the host server is on.  It can be a number between 
  40.             1 and 65535.
  41.  
  42.     * Bandwidth: Target bytes per second to send over the network layer. This 
  43.                  MUST be set correctly to avoid send overflow. For a detailed
  44.                  explanation of how to use this feature, please see the section
  45.                  of this document labeled "limiting bandwidth".
  46.     
  47.     * Password: This specifies whether the game is password protected and what 
  48.                 password to use.
  49.  
  50.  
  51. The Options page allows you to set the following settings:
  52.  
  53.     * Run Speed: How fast the player runs.  This is a percentage between 50 and 
  54.                  150 percent.
  55.  
  56.     * Respawn Scale: How fast powerups respawn.  This is a percentage between 
  57.                      50 and 150 percent.
  58.  
  59.     * Default Weapon: This specifies the weapon that you are carrying when you 
  60.                       respawn.
  61.  
  62.     * Weapon Stay: Do weapon powerups respawn immediately when picked up, or do 
  63.                    they respawn based on the time set by the level designer.
  64.  
  65.     * Location Based Damage:  Is location based damage turned on (e.g., a head-shot
  66.                               does more damage than a body shot).
  67.  
  68.     * Audio Taunts: Are audio taunts allowed.
  69.  
  70.     * Fall Damage: How much damage if caused by falling.  This is a percentage 
  71.                    between 0 and 100.
  72.  
  73.     * Armor Health Bonus: A Health bonus that is given when armor powerups are
  74.                           picked up.  This is a value between 0 and 100.
  75.  
  76.  
  77. The Deathmatch Options page allows you to set the following settings:
  78.  
  79.     * Level Ending Condition: The condition that determines when the level should 
  80.                               end.  This can be set to "Frag limit reached", "Time 
  81.                               limit reached", "Frag or time limit reached", or "none".
  82.  
  83.     * Frag Limit: This indicates the number of frags (kills) a player must get for 
  84.                   the Frag limit to be reached.  This must be a value between 5 and 
  85.                   50.
  86.  
  87.     * Time Limit: This indicates the time (in minutes) that a level must be running 
  88.                   before the time limit is reached.  This must be a value between 5 
  89.                   and 60.
  90.  
  91.  
  92. The H.A.R.M. vs UNITY Options page allows you to set the following settings:
  93.  
  94.     * Level Ending Condition: The condition that determines when the level should 
  95.                               end.  This can be set to "Score reached", "Time limit
  96.                               reached", "Score or time limit reached", or "none".
  97.  
  98.     * Time Limit: This indicates the time (in minutes) that a level must be running 
  99.                   before the time limit is reached.  This must be a value between 5 
  100.                   and 60.
  101.  
  102.     * Winning Score: This indicates the score that a team must reach for the winning
  103.                      score to be reached.  This must be a value between 30 and 200.
  104.  
  105.     * Intelligence Score:  This is the score that is given for successfully 
  106.                            "capturing" an Intelligence item.
  107.  
  108.     * Frag Scoring: This indicates if frags should add to a player/team's score.
  109.  
  110.     * Friendly Fire:  This indicates whether team mates can damage each other or not.
  111.  
  112.  
  113. The Worlds page allows you to add/remove maps to/from the rotation.  When hit the 
  114. Finish button on the Worlds page, there will be a pause while the server starts and 
  115. the first world is loaded.  When the server starts running, you will see the 
  116. dedicated-server main window.  This window is broken up into 5 sections that are 
  117. described below:
  118.  
  119.     SERVER INFO
  120.  
  121.         * Name: This is the name of your server as seen by players when they are 
  122.                 looking for a server to join.
  123.  
  124.         * Running Time: This shows the total time your server has been running.
  125.  
  126.         * Total Players: This shows the total number of players that have visited 
  127.                          your server.
  128.  
  129.         * Peak Players: This shows the highest number of players that were on your 
  130.                         server at one time.
  131.  
  132.     GAME INFO
  133.  
  134.         * Players: This shows the number of players currently on your server.
  135.  
  136.         * Time in Level: Shows the time the current level has been running.
  137.  
  138.         * Average Ping: Shows the average ping of the players currently in your 
  139.                         level.
  140.  
  141.     PLAYERS
  142.  
  143.     This shows the list of players that are currently on your server.  The list has 
  144.     the following columns that describe each player:
  145.  
  146.         * Name: The name of the player.
  147.  
  148.         * Ping: The ping from the player to the server.
  149.  
  150.         * Kills: The number of kills the player has scored in this level.
  151.  
  152.         * Time: The length of time this player has been on the server.
  153.  
  154.     There is a button below the list of players labeled "Boot".  Use this button to 
  155.     remove a player from your server.
  156.  
  157.     LEVELS
  158.  
  159.     This shows a list of levels that the server will be running and the order they 
  160.     will run in.  The current level is indicated with a black dot to the left of 
  161.     the level name. Below the list of levels, there are three buttons which are 
  162.     described below:
  163.  
  164.         * Next Level:  Go to the next level immediately without having to wait for 
  165.                        the level ending conditions to be met.
  166.  
  167.         * Select Level:  Go to the currently highlighted level immediately without 
  168.                          having to wait for the level ending conditions to be met.  
  169.                          You can also just double click the level.
  170.  
  171.         * Stop Server:  This will stop the server and close NolfServ.
  172.  
  173.     CONSOLE
  174.  
  175.     This shows a scrolling display of the server's internal commands and status. 
  176.     Chat messages from players will also appear here.  To send players messages from 
  177.     the command line interface at the bottom, precede the message with "say" and 
  178.     enclose the message in quotes.  For instance if you entered: say "hello 
  179.     everyone!" all clients would see the message "hello everyone!" from "Host". 
  180.     Advanced users can enter Lithtech console commands in this command line. 
  181.     To clear the display entirely, click the Clear button.
  182.  
  183.  
  184.     ADVANCED SERVER:  For advanced server setup, the following commands are available:
  185.  
  186.       General Commands (compiled by "ShagnWagn"):
  187.       -------------------------------------------
  188.  
  189.         * NetDefaultWeapon:  This is used to set the default weapon players get when
  190.                              the respawn.  Valid values:
  191.              
  192.                                   20 = None
  193.                                   21 = Shepard Arms P38 9mm Pistol
  194.                                   22 = Petri .38 Airweight Revolver
  195.                                   23 = Braun 9mm Parabellum
  196.                                   24 = Gordon 9mm SMG
  197.                                   25 = Hampton MPL 9mm SMG
  198.                                   26 = AK-47 Assault Rifle
  199.                                   27 = Sportsman EX Crossbow
  200.                                   28 = Hampton Carbine
  201.                                   29 = Geldmacher SVD Sniper Rifle
  202.                                   30 = Morris Model 14 Spear Gun
  203.                                   31 = Laser Gun
  204.                                   32 = Super Atomic Laser Weapon
  205.                                   33 = Bacalov Corrector
  206.                                   34 = M79 Grenade Launcher
  207.                                   35 = Briefcase
  208.                                   36 = Lipstick Impact Explosive
  209.                                   37 = Lipstick Proximity Explosive
  210.                                   38 = Lipstick Timed Explosive
  211.                                   39 = Sleeping Gas
  212.                                   40 = Stun Gas
  213.                                   41 = Acid Gas
  214.                                   42 = Belt Buckle/Zipcord
  215.  
  216.         * NetMaxPlayers:  Sets the maximum number of players that can join the server.
  217.                           NOTE:  User with caution:  if you set it with 16 players 
  218.                           in the server wizard then lower it with this to 4 (or any 
  219.                           other amount), Gamespy still allows people to join even 
  220.                           when full).  Valid values: 2-16
  221.  
  222.         * NetHitLocation:  Turns location-based damage on/off (0=off, 1=on).
  223.  
  224.         * NetFragScore: Turns frag scoring in H.A.R.M. vs UNITY games on/off (0=off,
  225.                         1=on).
  226.  
  227.         * RunSpeed: Used to adjust the run speed.  This value represents a percent
  228.                     of the normal run speed.  Valid values: 0.5-1.5 (i.e., 50-150%).
  229.  
  230.         * NetFallDamageScale:  Percentage of fall damage players take.  Valid values:
  231.                                0.0-1.0 (i.e., 0-100%)
  232.  
  233.         * RespawnScale:  Used to adjust the rate at which powerups respawn.  This
  234.                          value represents a percent of the normal respawn time.
  235.                          Valid values: 0.5-1.5 (i.e., 50-150%).
  236.         
  237.         * NetArmorHealthPercent:  Used to give players a health bonus when they pick
  238.                                   up armor powerups.  This value represents a percent
  239.                                   of the armor value that should be given to the player
  240.                                   as a health bonus.  Valid values: 0.0-1.0 (i.e.,
  241.                                   0-100%).
  242.  
  243.         * NetFriendlyFire: Turns friendly-fire on/off in H.A.R.M. vs UNITY games
  244.                            (0=off, 1=on).
  245.  
  246.         * NetIntelScore:  This represents how much "capturing" on intelligence item
  247.                           is worth in H.A.R.M. vs UNITY games.  Valid values: 5-50.
  248.  
  249.         * NetAudioTaunts:  This is used to enable/disable audio taunts. (0=off, 1=on).
  250.  
  251.         * NetUsePassword:  This is used to toggle password protection. (0=off, 1=on)
  252.  
  253.         * NetEndFrags:  This represents the winning score in Deathmatch games.  Valid
  254.                         values: 5-50.
  255.  
  256.         * NetEndScore:  This represents the winning score in H.A.R.M. vs UNITY games.
  257.                         Valid values: 30-200
  258.  
  259.         * NetEndTime:  This represents the length of time (in minutes) each level 
  260.                        last.  Valid values: 5-60
  261.  
  262.         * NetSessionName:  Name of the server.  Valid value: (<= 24 Characters).  For
  263.                            example: NetSessionName MyCoolServer.
  264.  
  265.         * NetCAGameEnd:  Level ending conditions for H.A.R.M. vs UNITY games.  Valid
  266.                          values:
  267.  
  268.                               0 = Score Reached
  269.                               1 = Time Limit Reached
  270.                               2 = Score or Time Limit Reached
  271.                               3 = None
  272.  
  273.         * NetDMGameEnd:  Level ending conditions for Deathmatch games.  Valid values:
  274.  
  275.                               0 = Frag Limit Reached
  276.                               1 = Time Limit Reached
  277.                               2 = Frag or Time Limit Reached
  278.                               3 = None
  279.  
  280.         * NetWeaponStay:  Toggles weapons instantly respawning after they are picked
  281.                           up. (0=off, 1=on).
  282.  
  283.  
  284.       Advanced Commands:
  285.       ------------------
  286.  
  287.         * LeashLen: Specifies the allowable distance between the client's position 
  288.                     and where the server thinks the client should be. Defaults to 2.0.
  289.  
  290.         * LeashSpring: Specifies the distance inside of which the server will 
  291.                        interpolate the server's position to match the client's
  292.                        position. Outside of this distance, the server's position will
  293.                        be forced to the client's position. Defaults to 150.0. 
  294.  
  295.         * LeashSpringRate: Defines how quickly the interpolation will happen between 
  296.                            the server and client positions, in the range 0.0-1.0. 
  297.                            Lower numbers lead to slower interpolation.  (Which gives 
  298.                            smoother movement, but greater error.) 0.0 will stay at 
  299.                            the server's position, and 1.0 will teleport the server 
  300.                            object to the client's position.  The default value is 0.1.
  301.  
  302.         * SendBandwidth BPS: Target bytes per second to send over the network layer.
  303.                              This MUST be set correctly to avoid send overflow. For a
  304.                              detailed explanation of how to use this feature, please
  305.                              see the section of this document labeled "limiting
  306.                              bandwidth".
  307.  
  308.       Debug Commands:
  309.       ---------------
  310.  
  311.         * IPDebug: Show debug messages for the TCP/IP layer (addresses & ports for 
  312.                    connection/disconnection/etc.)  (0 or 1)
  313.  
  314.         * ShowConnStats: Turn on the connection bandwidth usage spew. (0 or 1)
  315.  
  316.  
  317.  
  318.  
  319. Command Line Arguments
  320. ----------------------
  321.  
  322. Launching NolfServ can be automated by the command line parameter "-nowiz".  This 
  323. forces NolfServ to skip the setup wizard and use the options that were chose the 
  324. last time the wizard was used.  So, the full command line would look like:
  325.  
  326.      NolfServ.exe -nowiz
  327.  
  328. There are additional command line parameters, but they are for advanced users only.
  329.  
  330. The additional command line parameters set values that appear in the setup wizard.  
  331. To set parameters and not show the wizard, combine the "-nowiz" parameter as show 
  332. above.  The full command line syntax is:
  333.  
  334.      NolfServ.exe [Parameter1 [Value1]] [Parameter2 [Value2]]
  335.  
  336. Most parameters must be followed by a value for that parameter.  Values that require 
  337. strings can be surrounded by double quotes so that they may contain spaces.  An 
  338. example value that requires double quotes is:  "My Server".  Here is a table of the 
  339. available command line parameters:
  340.  
  341. Parameter         Description                     Value Type    Value Default
  342. ---------------------------------------------------------------------------------
  343. -NetSessionName | Server name seen when joining    | String      | "Good vs. Evil" |
  344. -NetUsePassword | Lock server with password     | Float       | 0.0f (FALSE)    | 
  345. -NetPassword    | Server password               | String      | "password"      |
  346. -NetMaxPlayers  | Maximum number of players     |             |                 | 
  347.                 | allowed on server at once     | Float       | 16              | 
  348. -NetPort        | Port to host server on        | Float       | 27888           |
  349. -nowiz          | Skip the setup wizard         | -none-      | -none-          |
  350. ---------------------------------------------------------------------------------
  351.  
  352.  
  353.  
  354. Recommended Player Limits
  355. -------------------------
  356.  
  357. Connection              Machine Spec                   # of Players 
  358. -----------------------------------------------------------------------------
  359. 56K                   | Minimum Server (Host)          | 2 (including host) | 
  360. ISDN (128 kb up/down) | Fast Server (Dedicated)        | 4                  | 
  361. DSL/Cable*            | Fast Server (Dedicated)        | 4-8                |  
  362. T1                    | Minimum Server (Dedicated)     | 8-16               | 
  363. T3                    | Minimum Server (Dedicated)     | 8-16               | 
  364. T3                    | Fast Server** (Host/Dedicated) | 16                 | 
  365. -----------------------------------------------------------------------------
  366.  
  367. * Dependant on upload speed, Cable and DSL connections vary.
  368. ** Fast Server system requirements are above a P3 550 + 256 MB RAM 
  369.  
  370.  
  371.  
  372. Limiting Bandwidth
  373. ------------------
  374.  
  375. New to version 1.003 is the ability to restrict upload bandwidth.  This feature
  376. was implemented to give server operators the ability to limit the amount of data
  377. that's being sent to players on high bandwidth connections.  When used correctly,
  378. this feature can greatly improve performance.
  379.  
  380. There are two ways to change your bandwith limit with NOLFserv.  The first and
  381. easiest way is to use the bandwith option in the setup wizard.  Here, you can use
  382. one of 5 preset values, or enter a custom value.
  383.  
  384. The list of available connection types and the values used for each are as follows:
  385.  
  386. 56k modem: 4,000 bytes per second
  387. Cable:     16,000 bytes per second    
  388. DSL:       32,000 bytes per second
  389. T1:        1,000,000 bytes per second
  390. T3:        10,000,000 bytes per second
  391.  
  392. Since the actual upload bandwidth of your connection may vary greatly from these,
  393. you can also enter a custom value.  To determine this value, just follow these steps:
  394.  
  395. Determine your maximum upload bandwidth.  This information can be obtained from your ISP.
  396. Multiplay this value by 1024.
  397. Divide the result by 8.
  398.  
  399. For example, if your upstream bandwidth is 128k:
  400.  
  401. 128 x 1024 = 131072
  402. 131072 / 8 = 16384
  403.  
  404. So, to avoid send overflow on a 128kbps upload bandwidth connection, you would set your
  405. custom value to 16384.  
  406.  
  407. To fine tune this setting while the server is actually running, just type "SendBandwidth"
  408. and the value you wish to use in the console, and then press <Enter>.
  409. (i.e. SendBandwidth 16384)
  410.  
  411. NOTE:  It is VERY imporant that you set this value correctly.  Setting the limit too high 
  412.        may result in very poor performance for players with a high ping.  Similarly, setting
  413.        it too low may result in choppiness for low ping players.  You should experiment with
  414.        different values to find the best setting for your particular situation!
  415.