home *** CD-ROM | disk | FTP | other *** search
/ Gambler 19 / GAMBLERCD19.BIN / UTILS / 3D / MODY / VIKING09.ZIP / read_first!.txt < prev    next >
Text File  |  1998-05-08  |  13KB  |  300 lines
  1. ------------------------------------------------------------------------------
  2.                              Viking DM&CTF v0.97b
  3.                       http://www.planetquake.com/viking
  4.  
  5.                  bugreports, questions, suggestions to
  6.                     thedd@planetquake.com
  7. ------------------------------------------------------------------------------
  8.  
  9. About Viking................................................................º1
  10. Requirements................................................................º2
  11. Installation................................................................º3
  12. Server variables............................................................º4
  13. User classes................................................................º5
  14. Available commands..........................................................º6
  15. Server data files...........................................................º7
  16. MOTD files..................................................................º8
  17. Map cycling.................................................................º9
  18. Fun names..................................................................º10
  19. Credits....................................................................º11
  20.  
  21.  
  22. ------------------------------------------------------------------------------
  23. º1 : About Viking
  24. ------------------------------------------------------------------------------
  25. Viking is a mod for Quake2 3.14+. The main purpose with Viking is to give 
  26. administrators more power over their Quake2 servers, as well as extending 
  27. the current DM/CTF gameplay by adding new features.
  28.  
  29. It uses a number of config files to do this, all of them stored in the
  30. dir you put Viking in. The reason why I'm using so many files is that they 
  31. are also being modified by Viking at various times, and if I would put all 
  32. data in one file you would have problems modifying it when Quake2 is
  33. running.
  34.  
  35.  
  36. ------------------------------------------------------------------------------
  37. º2 : Requirements
  38. ------------------------------------------------------------------------------
  39. Viking is available for Win32 and Linux servers. You need Quake2 v3.14 on
  40. your system, and to run Viking CTF or DM with grapple/tech you also need 
  41. Zoid's Threewave CTF for Q2.
  42.  
  43. Viking is mainly meant to be a server-side mod, but it includes some optional
  44. features that require clients to have extra files.
  45.  
  46. If you run Viking DM/CTF with VWeap enabled, clients need to download the 
  47. weapon models from http://www.planetquake.com/viking/dl.shtml or
  48. http://www.telefragged.com/tsunami.
  49.  
  50. Note that the Viking code supports VWeap on all models (including any custom),
  51. but only male/female/cyborg weapon models are included in the client file
  52. (pak2.pak). The pak2.pak file is constantly updated to support more models,
  53. you'll find the latest version at http://www.telefragged.com/tsunami.
  54.  
  55. You can use the server variable "models" to specify which models should be
  56. allowed on the server. For example, setting models to "male,female,cyborg"
  57. will only allow the id default models on the server. Clients connecting using
  58. another model will be forced to use male/grunt.
  59. This is useful for VWep, since it will fix the problem with clients using 
  60. "odd" models showing up with white cubes sticking out of their a**.
  61.  
  62.  
  63. ------------------------------------------------------------------------------
  64. º3 : Installation
  65. ------------------------------------------------------------------------------
  66. The Viking mod supports both DM and CTF servers. It is recommended that you
  67. place Viking in the Quake2\ctf directory, otherwise you will not be able to
  68. run a Viking CTF server or a Viking DM server with grapple or tech.
  69.  
  70. So, before you install Viking, make a backup of your Quake2\ctf directory.
  71. THIS IS VERY IMPORTANT! Then unpack all Viking files into Quake2\ctf and you
  72. are ready to go : start the server with
  73. +set game ctf +exec vikingdm.cfg (for Viking DM)
  74. or
  75. +set game ctf +exec vikingctf.cfg (for Viking CTF)
  76.  
  77. If you want to uninstall Viking, just remove the Quake2\ctf directory 
  78. and rename Quake2\ctfold to Quake2\ctf again.
  79.  
  80.  
  81. ------------------------------------------------------------------------------
  82. º4 : Server variables
  83. ------------------------------------------------------------------------------
  84. There are very many new server variables. I will not list them all here, since
  85. all of them (except models) are reachable from the Admin Menu. Play around
  86. with the settings, and feel free to email me with any questions.
  87.  
  88.  
  89. ------------------------------------------------------------------------------
  90. º5 : User classes
  91. ------------------------------------------------------------------------------
  92. Viking gives the administrator a way to give clients extra privileges, by
  93. promoting them to Voiced users or Operators. Voiced users aren't able to use 
  94. commands that directly affect other players (such as 'cmd kick' or 'cmd ban'). 
  95. Furthermore, if a Voiced user wants to change gameplay in any way (using 'cmd 
  96. nextmap' for instance), a vote system will assure that the majority of the 
  97. privileged users (operators+voiced users) agree before the command is 
  98. executed.
  99. Operators have much more control. They can kick or ban players, promote 
  100. unprivileged clients to voiced users, and may use the same commands as voiced
  101. users without having to go through the voting procedure.
  102. The server administrator is still the guy in charge, though.
  103.  
  104. On dedicated servers, the administrator must type 'sv' in front of the Viking
  105. commands. Example:
  106. sv maplist
  107.  
  108. On non-dedicated servers, the administrator is also an operator.
  109.  
  110.  
  111. ------------------------------------------------------------------------------
  112. º6 : Available commands
  113. ------------------------------------------------------------------------------
  114. Most of these commands are only available to the administrator.
  115. Operators and Voiced users should use the menu system.
  116. You can reach the menus by using the "inven" command when you have joined a
  117. game. Inven is bound to [TAB] by Quake2 default.
  118.  
  119. These are the Viking commands.
  120.  
  121. [mask] is name@ip. For example, the mask for Thodd at ip number 123.45.67.8
  122. is Thodd@123.45.67.8. You can use wildcards (*) and joker signs (?) in masks.
  123.  
  124. Note: To use the admin commands on a dedicated server console, you must type 
  125.       'sv <command>'.
  126.  
  127. hud
  128.     Toggles the VikingHUD on/off.
  129.     Bind this command to a key (I use ctrl). 
  130.  
  131. maplist (administrator only)
  132.     Shows a list of the maps in the current cycle.
  133.  
  134. cyclelist (administrator only)
  135.     Shows a list of the map cycles the server runs.
  136.  
  137. ban [mask] (administrator only)
  138.     Bans [mask] from the server.
  139.  
  140. unban [mask] (administrator only)
  141.     Removes the ban on [mask].
  142.  
  143. banlist (administrator only)
  144.     shows a list of banned users.
  145.  
  146. addop [mask] (administrator only)
  147.     Adds [mask] to the user_o.txt file.
  148.  
  149. rmop [mask] (administrator only)
  150.     Removes [mask] from the user_o.txt file.
  151.  
  152. oplist (administrator only)
  153.     Shows the contents of user_o.txt.
  154.  
  155. addvoice [mask] (administrator only)
  156.     Adds [mask] to user_v.txt
  157.  
  158. rmvoice [mask] (administrator only)
  159.     Removes [mask] from user_v.txt
  160.  
  161. voicelist (administrator only)
  162.     Shows the contents of user_v.txt
  163.  
  164.  
  165. The command "players" is extended to show net name and IP if used by an
  166. operator. It is also available at the dedicated console.
  167.  
  168.  
  169. ------------------------------------------------------------------------------
  170. º7 : Server data files
  171. ------------------------------------------------------------------------------
  172. Viking stores data in a few files in the dir you installed Viking to.
  173. All files except for maps.txt and motd.txt consist of none or more lines of 
  174. text on the format user@ip (see description of [mask] above). All lines must 
  175. end with newline.
  176.  
  177. IP_allowed.txt
  178.     masks that are allowed on the server.
  179.     *@*.*.*.* lets anyone in.
  180.     A*@*.*.*.* will let people whose names begin with 'A' in.
  181.     *@123.45.67.? will let people whose ip is 123.45.67.0--9.
  182.     This is the only file you have to create manually.
  183.     It is read every time a client tries to connect.
  184.  
  185. IP_banned.txt
  186.     masks that are banned on the server.
  187.     *@*.*.*.* bans everyone.
  188.     A*@*.*.*.* bans all people whose names begin with an 'A'.
  189.     *@123.45.67.? bans people whose ip is 123.45.67.0--9.
  190.     Read every time a client respawns or joins a game.
  191.  
  192. user_o.txt
  193.     masks of users who are operators.
  194.     *@*.*.*.* makes all connecting clients operators.
  195.     A*@*.*.*.* makes all people whose names begin with an 'A' operators.
  196.     *@123.45.67.? makes people whose ip is 123.45.67.0--9 operators.
  197.     Read every time a client respawns or joins a game.
  198.  
  199. user_v.txt
  200.     masks of users who are voiced.
  201.     *@*.*.*.* makes all connecting clients voiced.
  202.     A*@*.*.*.* makes all people whose names begin with an 'A' voiced.
  203.     *@123.45.67.? makes people whose ip is 123.45.67.0--9 voiced.
  204.     Read every time a client respawns or joins a game.
  205.  
  206. dm_maps.txt/ctf_maps.txt
  207.     In this file, you can specify which maps should be used on the server.
  208.     Each entry in this file must look like
  209.     :Cycle Name
  210.     map1
  211.     map2
  212.     map3
  213.     [...]
  214.     This file is only read when you start the Viking server.
  215.  
  216. motd_dm_o.txt, motd_dm_v.txt, motd_dm.txt, motd_ctf_o.txt, motd_ctf_v.txt, 
  217. motd_ctf.txt
  218.     "Message of the day" files.    
  219.     These files are read every time the motd is shown to a client.
  220.  
  221. Eraser bot, ServObit and FragLog also generates/uses a few files. You will
  222. find these in the respective subdirs, and there are readme files for each
  223. mod in ctf\readmes\.
  224.  
  225. Do not edit any of these files manually (except for *_maps.txt, motd_*.txt and 
  226. IP_allowed.txt), since erratic entries seriously can screw up the server.
  227.  
  228.  
  229. ------------------------------------------------------------------------------
  230. º8 : MOTD files
  231. ------------------------------------------------------------------------------
  232.  Viking uses 3 MOTD files, one for each user class. These files can be plain
  233. text, but you can also use the Q2 fun characters in them. I have included
  234. sample motd files in the package.
  235.  
  236. motd_*_o : the motd operators see
  237. motd_*_v : the motd voiced users see
  238. motd_*   : the motd regular users see
  239.  
  240.  
  241. ------------------------------------------------------------------------------
  242. º9 : Map cycling
  243. ------------------------------------------------------------------------------
  244.  This mod supports multiple (unlimited) map cycles, with unlimited maps.
  245. Each cycle should be given a descriptive name.
  246. You define a map cycle in the file 'maps.txt' like this:
  247. :Cycle name
  248. map1[,map alias][,min players][,max players]
  249. map2[,map alias][,min players][,max players]
  250. map3[,map alias][,min players][,max players]
  251. [..]
  252. mapn[,map alias][,min players][,max players]
  253.  
  254. If you remove the 'maps.txt' file, Viking will use default map cycle.
  255. When the server starts, it will use the first map cycle in the file.
  256.  
  257. NOTE: With Viking CTF, you can play CTF on any id map, not only Q2CTF1..5.
  258.       You can even play on custom maps, but make sure the clients know where
  259.       to download them in that case.
  260.  
  261.  
  262. ------------------------------------------------------------------------------
  263. º10 : Fun names
  264. ------------------------------------------------------------------------------
  265. Viking includes a feature that lets clients use fun chars in their names.
  266.  
  267. For clients, it works like this:
  268.  
  269. Using Q2NM (download it from http://qnm.telefragged.com) you create the fun 
  270. name you wish to use on servers that support this standard. This name is saved 
  271. to a .cfg file, usually named funname.cfg. This file should be put in the 
  272. Quake2\baseq2 directory.
  273.  
  274. Then, you add '+exec funname.cfg' (without the ' signs) to the Quake2 start
  275. line. Thats it!
  276.  
  277. The Viking server only uses the fun name as an alias for the client. It does
  278. not use fun names to any of the data files (IP_banned.txt, user_v.txt, 
  279. user_o.txt) since it still uses each clients 'net name' (the one you write
  280. in multiplayer setup, or change with the 'name' command) internally for IP
  281. control etc.
  282.  
  283.  
  284. ------------------------------------------------------------------------------
  285. º11 : Credits
  286. ------------------------------------------------------------------------------
  287. Thanks to the following people :
  288.  
  289. * Hentai (hentai@intelegenesis.com) for the VWeap patch
  290. * David 'crt' Wright for most of the menu code and helping out with the
  291.   "EyeCam" mode.
  292. * Tony Browneller for supporting Viking with Q2NM and helping out with
  293.   converting fun chars to ascii in the dedicated console.
  294. * Stefan "Eavy" Schwarz for the CTF+ code
  295. * Darren "SGT-D" Winter for bugtesting, suggestions and the Viking front-end
  296.   (http://www.sod.net/vcp)
  297. * The unknown author of the Shock'em tutorial.
  298. * All of you who have helped me find and correct bugs, and who have given
  299.   suggestions for this mod.
  300.