home *** CD-ROM | disk | FTP | other *** search
/ PC PowerPlay 11 / PCPP11.iso / patch / quake2 / qwsv.txt < prev    next >
Encoding:
Text File  |  1996-12-16  |  13.4 KB  |  374 lines
  1. ============================
  2. = QuakeWorld Server (QWSV) =
  3. ============================
  4. Released: Friday, December 13th, 1996
  5. Document Last Revision: Monday, December 16th, 1996
  6.  
  7. ============
  8. = Contents =
  9. ============
  10.  
  11. 1......Installation Instructions
  12. 2......Command Line Parameters
  13. 3......Console Commands
  14.        3.1......General
  15.        3.2......Security
  16. 4......The QuakeWorld Master
  17.        4.1......Overview
  18.        4.2......Features
  19.        4.3......To Do
  20. 5......Known Bugs
  21. 6......The QuakeWorld Team
  22.  
  23. ================================
  24. = 1. Installation Instructions =
  25. ================================
  26.  
  27. 1) Make a "QW" directory below your Quake root.
  28.  
  29.     cd \quake
  30.     md qw
  31.  
  32. 2) Make a skins directory below QW
  33.     
  34.     cd qw
  35.     md skins
  36.  
  37. 3) Copy the progs.dat included in the QWSV archive to the QW directory
  38.  
  39. 4) Make sure qwsv.exe is in the Quake directory
  40.  
  41. 5) Run qwsv.exe with optional command line parms described below
  42.  
  43. ==============================
  44. = 2. Command Line Parameters =
  45. ==============================
  46.  
  47. -master     Connects to an alternate master.
  48.  
  49.         By default, qwsv.exe will attempt a connection to id's master
  50.         server at 192.246.40.115. Should there be another master
  51.         server you wish your server to connect to, use this command.
  52.  
  53.         "qwsv -master 204.50.178.66"
  54.  
  55. -port       Specify an alternate port to listen for connections.
  56.         By default, qwsv listens on port 27000. Use this command 
  57.         to specify an alternate port.
  58.  
  59.         "qwsv -port 20593"
  60.  
  61. -game       Specify a directory to an alternate progs.dat or map files.
  62.  
  63.         Same as Quake. For example, if you wish to run CTF for
  64.         QuakeWorld, and have it installed in c:\quake\ctf and assuming
  65.         that you have qwsv.exe located in c:\quake, simply execute;
  66.  
  67.         "qwsv -game ctf"
  68.  
  69.         To choose the CTF progs.dat and support files.
  70.  
  71.  
  72.  
  73. =======================
  74. = 3. Console Commands =
  75. =======================
  76.  
  77. -----------
  78. 3.1 General
  79. -----------
  80.  
  81. Please Note: Most of these can be either prefixed with a + at the command 
  82. line, or may be included in a file called "server.cfg" (which is the
  83. equivalent of autoexec.cfg) which is loaded along with qwsv.exe.
  84.  
  85. map         Change to a new map
  86.  
  87.         "map dm2" would change to dm2
  88.  
  89. rcon_password   Set a password for remote administration
  90.  
  91.         "rcon_password llama" sets the rcon (Remote Console) password
  92.         to "llama" for your server. This would enable you to 
  93.         remotely administer your server from qwcl.exe.
  94.  
  95. status      Displays the present status of your server. CPU Utilization,
  96.         all connected clients with detailed statistics, as well as
  97.         the average response time to clients.
  98.  
  99. showpackets This is VERY verbose. Prints every packet received to the 
  100.         console. Generally, not a good idea to use unless you are 
  101.         debugging something
  102.  
  103.         "showpackets 0" turns it off (Default)
  104.         "showpackets 1" enables
  105.  
  106. showdrop    Shows you which client has dropped how many packets. Useful to
  107.         guage the quality of their play. The more packets they drop,
  108.         the worse their QuakeWorld experience.
  109.  
  110.         "showdrop 0" Turns off dropped packet display to the console
  111.         "showdrop 1" Enables display of dropped packet information
  112.  
  113. maxclients  What is the maximum number of clients you wish to allow to
  114.         connect to your server? (Default is 8)
  115.  
  116.         "maxclients 16" allows 16 clients to connect to your server.
  117.  
  118. samelevel   Toggles if QuakeWorld changes levels when someone exits
  119.         (Default is 0)
  120.  
  121.         "samelevel 0" allows advancing to the next level
  122.         "samelevel 1" the same level will be played over and over again
  123.               if someone exits
  124.         "samelevel 2" Same as noexit 1. Kills someone if they exit the
  125.               level
  126.         "samelevel 3" Same as noexit 2. Kills someone if they exit the
  127.               level except for the case of where the map is
  128.               start.bsp
  129.  
  130. fraglimit   Advances to the next level after n frags
  131.  
  132.         "fraglimit 25" Advances to the next level when someone achieves
  133.                25 frags
  134.  
  135. timelimit   Advances to the next level after n minutes of play
  136.  
  137.         "timelimit 15" Advances to the next level after 15 minutes of
  138.                gameplay have elapsed on the current level
  139.  
  140. hostname    What you wish to call your server. "unnamed" is the default
  141.  
  142.         "hostname RevCoWorld" gives your server the name of "RevCoWorld"
  143.  
  144. teamplay    Sets teamplay settings for your server
  145.  
  146.         "teamplay 0" No teams (default) Hurt everybody
  147.         "teamplay 1" You cannot hurt your teammates
  148.         "teamplay 2" You lose one frag for killing a teammate
  149.  
  150. say         What text do you wish to display to players
  151.  
  152.             "say Server going down in 5 minutes"
  153.  
  154.             ...displays "(Console) Server going down in 5 minutes"
  155.             to all players on your server
  156.  
  157. serverinfo  Displays all the vars for your current server configuration
  158.             or set's appropriate vars (See below)
  159.  
  160. serverinfo  noscore 1       Disables frag logging and rank/skill calculations
  161.                             for the master you are connected to. Any other
  162.                             value enables frag logging at the next heartbeat.
  163.                             Default is 0.
  164.  
  165.                             eg: "serverinfo noscore 1" Prevents score info
  166.                                                        from being calculated
  167.  
  168.                                 "serverinfo noscore 0" Enables score info
  169.                                                        calculation at the master
  170.  
  171.             private 1       Prevents your server from being listed in the 
  172.                             "servers" listing, or prevents QSpy from displaying
  173.                             your server to users. Any other value allows your
  174.                             server to be displayed. Default is 0.
  175.  
  176.                             eg: "serverinfo private 1" Does not allow your
  177.                                                        server to be listed
  178.  
  179.                                 "serverinfo private 0" Allows you server to be
  180.                                                        listed in a "servers"
  181.                                                        request.
  182.  
  183.                             *PLEASE NOTE* If someone knows the IP of your
  184.                             server, this will not prevent them from explicitly
  185.                             connecting to your server. Passwords will be
  186.                             implemented in a future version of QWSV.
  187.  
  188.             minskill/
  189.             maxskill        Only show the server to a user making a "servers"
  190.                             request if their skill level is between minskill
  191.                             and maxskill. Default for both is 0 (This disables
  192.                             this feature.)
  193.  
  194.                             eg: "serverinfo minskill 1000"
  195.                                 "serverinfo maxskill 2000"
  196.  
  197.                             Allows your server to be displayed only if the 
  198.                             person requesting "servers" has a skill level
  199.                             between 1000 and 2000. This will allow admins to
  200.                             run servers which cater to certain skill levels.
  201.  
  202.                             eg: "serverinfo minskill 0"
  203.                                 "serverinfo maxskill 0"
  204.  
  205.                             Enables your server to be included in a "servers"
  206.                             request viewable by users of all skill levels.
  207.  
  208.  
  209.             minrank/
  210.             maxrank         Only show the server to a user making a "servers"
  211.                             request if their rank is between minrank and
  212.                             maxrank. Default for both is 0 (This disables
  213.                             this feature.)
  214.  
  215.                             eg: "serverinfo minrank 500"
  216.                                 "serverinfo maxskill 3000"
  217.  
  218.                             Allows your server to be displayed only if the 
  219.                             person requesting "servers" has a rank between
  220.                             500 and 3000. This will allow admins to
  221.                             run servers which cater to certain rank levels.
  222.  
  223.                             eg: "serverinfo minrank 0"
  224.                                 "serverinfo maxrank 0"
  225.  
  226.                             Enables your server to be included in a "servers"
  227.                             request viewable by users of all ranking levels.
  228.  
  229. quit        Quits the server and returns you to the prompt disconnecting 
  230.         all connected users.
  231.  
  232. ------------
  233. 3.2 Security
  234. ------------
  235.  
  236. addip       Add a mask to the ban list
  237.  
  238.         "addip 204.212.39" bans any incoming connection from 
  239.                    204.212.39.*
  240.  
  241.             *Please Note* All bans placed by addip only apply to the current
  242.             session unless you issue "writeip" (See below) before the server
  243.             terminates.
  244.  
  245. removeip    Remove a mask from the ban list
  246.         (See listip)
  247.  
  248.         "removeip 204.212.39" removes the ban on 204.212.39.*
  249.     
  250. listip      Displays the present ban filter list
  251.  
  252. writeip     Writes out the ban list from memory do disk (permanent bans)
  253.  
  254. adduser     Add a userid to the ban list
  255.  
  256.         "adduser 5" would ban American McGee from playing on your 
  257.             server ;)
  258.  
  259.             *Please Note* All bans placed by adduser only apply to the current
  260.             session unless you issue "writeuser" (See below) before the server
  261.             terminates.
  262.  
  263.  
  264. removeuser  Remove a userid from the banlist
  265.  
  266.         "removeuser 5" would allow American McGee to play on your 
  267.                server again
  268.  
  269. listuser    Displays the present user id ban list
  270.  
  271. writeuser   Writes out the user id banlist from memory to disk.
  272.  
  273. ====================================
  274. = 4. QuakeWorld Master Server 1.04 =
  275. ====================================
  276. Last Updated: Monday, December 16th, 1996
  277.  
  278. ================
  279. = 4.1 Overview =
  280. ================
  281.  
  282.  The QuakeWorld Master Server, for all intents and purposes, is the central
  283. database controller for QuakeWorld servers (qwsv.exe). The QuakeWorld
  284. network architecture does not allow for straight client->server initial 
  285. connections. All initial connections must first be made to a master server.
  286.  
  287.  From there, the client may log in, request a list of servers, change their 
  288. user records, or join a game in progress on an available server.
  289.  
  290.  The master is in charge of keeping track of all stats, user records, and 
  291. logs significant events from servers connected to it (frags, what the user
  292. was last seen doing, etc.)
  293.  
  294. ================
  295. = 4.2 Features =
  296. ================
  297.  
  298. * Frag/Death Logging: QuakeWorld automatically keeps track of every users
  299. frag and death as well as their ranking and skill level
  300.  
  301. * Network Wide Bans: If there are rogue servers or users who consistently
  302. cause problems for users in the QuakeWorld network, we now have the ability
  303. to prevent them from connecting to the network from a central location. 
  304. Please Note: There should be multiple complaints before a user or IP mask is
  305. banned from QuakeWorld.
  306.  
  307. * Seen: Much like bots on IRC networks, QuakeWorld now has the ability to 
  308. request information on what a particular user name or user ID was last seen 
  309. doing. ("seen <name/userid>" from the console)
  310.  
  311. * Clan Access Control Lists: QuakeWorld has the ability to password protect
  312. key/value combos with a password. For example, if you are in clan "RevCo" 
  313. and wish to prevent others from using your skin (eg: revco.pcx or bearian.pcx),
  314. the QuakeWorld admins can password protect "setinfo skin bearian" with a
  315. password. You may only set your "skin" key to "bearian" if you provide the
  316. correct password.
  317.  
  318. * Unique Names: To prevent people from masquerading as another user, QuakeWorld
  319. only accepts one unique name per master. That way, there can only ever be one 
  320. "tokay" or "sCaryname" or "Disruptor" per master. 
  321.  
  322. =============
  323. = 4.3 To Do =
  324. =============
  325.  
  326. * Investigate a method to possibly sync up masters
  327. * Implement password protected servers
  328. * Fix server->client download problems
  329. * Find a method to have clan rankings, and work more on clan support in 
  330. general
  331.  
  332.  
  333. =================
  334. = 5. Known Bugs =
  335. =================
  336.  
  337.  - qwsv will not work if you have unpacked your Quake PAK files. 
  338.    You must have PAK0.PAK and PAK1.PAK in your \quake\id1 directory
  339.  
  340. ==========================
  341. = 6. The QuakeWorld Team =
  342. ==========================
  343.  
  344. John Carmack            
  345. New network code and game modifications, original Master Server Code
  346.  
  347. Michael Abrash                                  
  348. Video and Sound drivers (WinQuake Port)
  349.  
  350. Christian Antkow (aka: Disruptor)               qwmaster@idsoftware.com
  351. Master Server Development, QWSV Documentation, id Master Server 
  352. Administrator
  353.  
  354. Geoff Scully (aka: Tarok)                       gws@dis.on.ca
  355. Master Server Development, id Master Server Administator
  356.  
  357. Joe Powell (aka: QSpy)                          jep@sclsis.navy.mil     
  358. QSpy (QWFE) Programmer, Master Server Development
  359.  
  360. Dave Riller (aka: DRiller/Kevorkian)            qwdist@idsoftware.com
  361. QuakeWorld Distribution Co-Ordinator
  362.  
  363. Rick Brewer (aka: ^Drag0n^)                     tron@cyberportal.net
  364. QuakeWorld Clan Skins Administrator
  365.  
  366. Dave Kirsch (aka: Zoid)                         zoid@threewave.com
  367. QuakeWorld QC 1.01 to 1.06 Upgrade, QuakeWorld CTF Mods, 
  368. Moral Support
  369.  
  370. Ron Crisco (aka: RonSolo)                       ronsolo@stomped.com
  371. Scoring Systems Development, id QuakeWorld Webmaster and all around nice guy
  372.  
  373.  
  374.