home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 13 / AACD13.ISO / AACD / Games / SUSHI / docs / sushi.txt < prev    next >
Text File  |  1999-12-09  |  20KB  |  493 lines
  1. SUSHI v1.0beta2 - Quake Competition servermod by 'surgeon'      
  2. Date  : 09/12 1999     
  3. Author: v2615l@groenjord.dk     
  4.         http://members.xoom.com/surgeonsq1/index.htm     
  5. =============================================================================   
  6.    
  7. Main bandwidth saving features:     
  8. (Network traffic is reduced by 50%, compared to standard quake!!)  
  9. - wastly reduced amount of tempentities     
  10. - reduced gibs     
  11.   (network traffic can be further reduced by enabeleing antilag)   
  12.   
  13. Main FPS boosting features:     
  14. (Framerate is 10-50% higher than standard quake during combat) 
  15. - All quakeC based dynamic lightning is disabled     
  16. - Dead bodies and gibs are removed at respawn     
  17. - Explosion effect exchanged for teleporter effect     
  18. - Torches/fire disabled     
  19.   (framerate can be further improved by disabeling hitflash)  
  20.    
  21. Some special features:     
  22. - Voting system for democratic server administration by the players 
  23. - 3 servemodes: FFA, Match & Rocketarena - players decide what game to play 
  24. - Every player can be voted admin and directly toggle all server vars 
  25. - Remote Admins can toggle sys_ticrate (# of updates sent over net) 
  26. - Players can decide to remove admins (by voting) 
  27. - Map selection: Support for all ID maps + ztndm1-6 
  28. - Prematch practice mode 
  29. - Deathmatch 3 (weapons stay, fast ammo respawn) supported 
  30. - Match countdown and simultaneous starts 
  31. - Possibility to autokick players trying to join during a match 
  32. - Ghosted frags (every player get's a ghostcode at matchstart enabeling them
  33.   to restore personal frags, should they loose their connection
  34.   or disconnect by accident) 
  35. - ON/OFF toggle for powerups, traps and comments 
  36. - Toggle for quad/pent light effect (default off)     
  37. - Toggle for weapon kick (individual)   
  38. - Observer cameras     
  39. - Random respawns     
  40. - Forced respawn after 5 seconds     
  41. - Antilag effects filter     
  42. - Fairpacks toggle (bypasses boomstick scripting)   
  43. - Random map rotation in anarchy (ffa) modes 
  44. - High performance RocketArena mode built in   
  45.   rotatation on 9 extremely fast maps:     
  46.          - Rage Arena  (from original fasrv12)     
  47.          - ArenaX      (from original fasrv12)     
  48.          - Inventory   (by 'Ohnosofa')  
  49.          - DocRA1-5    (maps by 'surgeon')     
  50.          - Sushi Arena (by 'surgeon) 
  51.  
  52.   (note that sky-textures on RageArena, ArenaX and Inventory has been edited  
  53.   in order to bypass skybug on Amiga)  
  54.   
  55. - Optional Cells restriction for RocketArena (keeps cells count to max 30)  
  56. - Option to skip 1 map ahead in arenamode     
  57. =============================================================================   
  58.    
  59.      
  60. SUSHI Combat Server installation:     
  61.    
  62. extract the archive to your quake-dir.     
  63. contents should be:   
  64.    
  65.  SUSHI/     
  66.         PAK0.PAK     (maps & sounds for rocketarena subgame)
  67.         progs.dat
  68.         PAK1.PAK     (not in main archive) 
  69.         autoexec.cfg (server settings)   
  70.         anarchy.cfg  (server settings)   
  71.         arena.cfg    (server settings)   
  72.         match.cfg    (server settings)   
  73.         docs/   
  74.              SUSHI.txt  (this file)   
  75.              arena.htm  (documentation for RocketArena)   
  76.         progs/  
  77.               missile.mdl (optional - delete if unwanted)  
  78.               bolt2.mdl   (optional - delete if unwanted)  
  79.               player.mdl  (for better team recognition)  
  80.    
  81. PAK0.PAK & progs.dat contains the vital stuff - don't mess with it :)   
  82.   
  83. PAK1.PAK is optional - it contains a the ztndm(x) maps  - if you already  
  84. have the ztndm(x) maps in your ID1 dir, there's no need for this.     
  85.    
  86. autoexec.cfg: is loaded when the server is started the first time   
  87.  it contains the "global" settings such as "noexit" and "hostname"   
  88.   
  89. anarchy.cfg: is loaded whenever a level is started in anarchy(ffa) mode   
  90.  it contains the timelimit, the eventual fraglimit for this mode.   
  91.     
  92. arena.cfg: is loaded whenever the server starts a level in arenamode   
  93.  it cotains the fraglimit (range 7-15 is suitable) and an eventual timelimit.  
  94.    
  95. match.cfg: is loaded whenever the server starts a level in one of the  
  96.  matchmodes. Again, it contains the eventual fraglimit and a timelimit.   
  97.    
  98.  the timelimit set in this cfg is ignored IF a match is started.   
  99.   
  100. Please note, that the "samelevel" console variable is toggled internally.  
  101. It's used for holding information about serversettings across levels.  
  102.   
  103.   
  104. !IMPORTANT!   
  105. The Maps ztndm1-6 are needed for anarchy. They should reside in ID1/maps or 
  106. in your SUSHI direcrory as PAK1.PAK 
  107. Availability: http://www.planetquake.com/ztn/ 
  108.               http://members.xoom.com/surgeonsq1/  
  109.   
  110. Launching the server:   
  111.    
  112. Start quake with the parameters:     
  113.   
  114. -listen -game SUSHI     
  115. to set up a listen server     
  116.   
  117. or     
  118.    
  119. -dedicated -game SUSHI     
  120. to set up a dedicated server     
  121.      
  122.    
  123. Command aliases and 'online-help' is sent to clients when they connect   
  124. to the server.     
  125.   
  126. =============================================================================     
  127.    
  128. Client commands:     
  129.    
  130.    
  131. General:   
  132. -----------------------------------------------------------------------------   
  133. "i-server" to display online-help commandlist   
  134. "i-mode", to get info on current servermode   
  135. "i-cam", for camera controls list   
  136. "i-match", to cycle through info on match control   
  137. "i-vote", to cycle through info on votingsessions   
  138. "i-arena", for arena impulse reference   
  139. "i-admin", to cycle through admin cmds   
  140. -----------------------------------------------------------------------------   
  141. "wkick", to toggle weapon kick ON/OFF (individual setting)   
  142. "hitflash" to toggle flashs ON/OFF (individual setting)   
  143. (will improve framerate in critical situations, such as performing lavajumps)  
  144. "observe", to enter observer mode   
  145. "vote", in order to initiate a voting session   
  146.   
  147. Voting:   
  148. -----------------------------------------------------------------------------   
  149. type "vote" to start a 1 minute session.   
  150. Then subject must be set:   
  151. it can be a map, a random levelchange, a toggle or a servermode.   
  152. Then other players type "yes", to vote for suggested subject   
  153. Maps   
  154. -----------------------------------------------------------------------------   
  155. "random",to suggest random map/vote for random map.   
  156. to suggest a particular map type the mapname.   
  157. (Supports dm1-6,start,end,e1m1-e4m8,ztndm1-6)   
  158. In arenamode, "skip" will skip 1 map ahead in the rotation. 
  159.    
  160. Toggles   
  161. -----------------------------------------------------------------------------   
  162. to toggle powerups, type "powerups".   
  163. to turn off lavaballs & shooters, type "notraps".   
  164. to toggle deathcomments, type "deathcomments".   
  165. to togle powerup effects, type "pfx".   
  166. to toggle effects filter, type "antilag".   
  167. to toggle fairpacks, type "fairpacks"  
  168.    
  169. Only in matchmode:   
  170. to toggle dm mode3, type "mode3"   
  171.  
  172. Only in arenamode: 
  173. "cells", will restrict cell ammo count to max 30 
  174.    
  175. Server Modes   
  176. -----------------------------------------------------------------------------   
  177. type "ffa1" or "ffa3" to set anarchy modes   
  178. -server will then restart   
  179. type "arena" to put server in RocketArena mode   
  180. -server will then restart   
  181. type "match" for individual match mode or   
  182. type "tmatch1" or "tmatch2" to set teamplay match mode 1 or 2   
  183. -SERVER WILL RESTART IN TRAINING MODE!   
  184.    
  185. Other   
  186. -----------------------------------------------------------------------------   
  187. type "noadmin" to suggest removal of admin(S)   
  188.    
  189. =============================================================================   
  190.   
  191. Admin Commands   
  192.   
  193. General  
  194. -----------------------------------------------------------------------------   
  195. IN OBSERVEMODE, type "reqadmin" to suggest yourself as admin  
  196. (requires players accept)  
  197. Alternatively, type "reqadmin" as subject in a votingsession.   
  198. (also requires players accept)   
  199.    
  200. Once you are admin, you may give up admin status by typing "noadmin".   
  201.    
  202. When you have recieved admin-status you can directly issue commands:   
  203.    
  204. Toggles:   
  205. -----------------------------------------------------------------------------   
  206. "deathcomments" - toggle "player rides x's rocket" ON/OFF   
  207. "powerups"  - disable or enable Quad/666/Ring   
  208. "notraps"   - disable lavaballs & spikeshooters   
  209. "pfx"       - toggle the light associated with powerups   
  210. "mode3"     - toggle weapons stay and fast ammo respawn   
  211. "antilag"   - toggle effects filter   
  212. "fairpacks" - toggles fairpacks on/off   
  213. "cells"     - cells restriction on/off (only arena-mode) 
  214.  
  215. sys_ticrate:   
  216. "lticrate" to set 10 updates/sec   
  217. "nticrate" to set 20 updates/sec   
  218. "hticrate" to set 50 updates/sec   
  219.    
  220. Match control:   
  221. -----------------------------------------------------------------------------   
  222. "beginmatch" to start 60 sec countdown immediately   
  223. "endmatch" to end ongoing match immediately   
  224. "lockmatch" to open/close the server for joining   
  225. "allowjoin" to allow/forbid obsevers to join ongoing match   
  226.    
  227. Map selection/mode selection:   
  228. -----------------------------------------------------------------------------   
  229. type mapname (e.g. "dm2", "e1m2") to set map, followed by   
  230. "execute" to change level   
  231. type modename (e.g "ffa1", "tmatch2", "arena"), followed by   
  232. "execute" to restart server in new mode   
  233.   
  234. =============================================================================   
  235.    
  236. Observer Commands:   
  237. -----------------------------------------------------------------------------   
  238.    
  239. Camera Control   
  240. -----------------------------------------------------------------------------   
  241. "auto", for auto selection   
  242. "player1"-"player16" selects player   
  243. "follow", for force-follow   
  244. "normal", to end force-follow   
  245. "hand", for force-hand   
  246. "nclip", for noclip   
  247. "messages", to toggle messages   
  248. "lock", to lock on target   
  249. "next", for next target   
  250.    
  251. Other   
  252. -----------------------------------------------------------------------------   
  253. "join", to exit observer mode   
  254. "reqadmin" to suggest yourself as admin   
  255.  
  256. During matches, provided that observers are allowed to join: 
  257. "restore" - send your ghostcode to restore your frags 
  258. "red" - sign up as red challenger/teamplayer & join match 
  259. "blue" - sign up as blue challenger/teamplayer & join match 
  260. =============================================================================   
  261.   
  262.    
  263. Match Commands:   
  264. -----------------------------------------------------------------------------   
  265. THESE COMMANDS ARE ONLY AVAILABLE IN MATCHMODE   
  266.  - "MODE3" REQUIRES VOTE!   
  267. -----------------------------------------------------------------------------   
  268. To toggle deathmatch 3 rules on/off, type "mode3"   
  269. (mode3 is weapons stay & 15 sec ammo respawn, compared to normal 30 sec   
  270. -----------------------------------------------------------------------------   
  271. "red" - sign up as red challenger/teamplayer 
  272. "blue" - sign up as blue challenger/teamplayer 
  273. "ready" to commit to match   
  274. "notready" to uncommit   
  275.  when all players have committed, match will start in T-60 seconds   
  276. "reporting" - toggles printing of score difference at bottom of your screen. 
  277. "teamscores" dumps current teamfrags (your team and enemy) to your console. 
  278. "ghost" - view your ghostcode (it will be printed on your screen at 
  279.  matchstart, if you forget to view it before) 
  280.  at any time before or during match, "ghost" will print your ghostcode. 
  281. "restore" - server will give you 60 seconds to send your ghostcode. 
  282.  Example: Ghostcode '2 8 1' must be sent as 'impulse 2', 'impulse 8', 
  283.  'impulse 1' or via the aliases: d2, d8, d1. 
  284.  You must send the digits one at a time pressign enter between each. 
  285.  The purpose is to restore your personal frags, although the match result 
  286.  will becalculated based on your color (blue or red). 
  287.  The reason for colorbased frag-ghosting is, that it makes it possible to 
  288.  make substitutions in team matches whitout the team loosing any frags. 
  289. -----------------------------------------------------------------------------   
  290. TO ABORT MATCH: vote for a mode/map-change, 
  291.                 or ask admin to issue command "endmatch"   
  292.    
  293. =============================================================================   
  294.    
  295. RocketArena Commands:   
  296. -----------------------------------------------------------------------------   
  297. "impulse 68" - see stats for current level   
  298. "impulse 69" - see how many are ahead of you   
  299. "impulse 70" - step out of line/back to line   
  300. "impulse 71" - set status bar text for 320x200    
  301. "impulse 72" - set status bar text for 320x240 or higher   
  302.   
  303. "cells" - toggles cells restriction on/off (requires votingsession)  
  304. "skip"  - skips 1 map ahead in the rotation (requires votingsession) 
  305. =============================================================================    
  306.    
  307. Some notes:     
  308. ------------     
  309. After a votingsession is initiated, subject must be set.     
  310. It can be a mapname (dmX, eXmY, ztndmX, random)     
  311. a toggle (pfx, powerups, traps, deathcomments, mode3, antilag)     
  312. or a matchmode: arena, match, tmatch1, tmatch2, ffa1 or ffa3    
  313. If more than 50% votes "yes" within 1 minute,   
  314. the suggested  change will take effect.   
  315.    
  316. If less than 50% votes yes within 1 minute, the voting session     
  317. will be canceled.     
  318.    
  319. Subject can not be changed during a session.     
  320.    
  321. In the traditional competition modes (team1/2 & individual), 
  322. type "ready" to commit to the match and "notready" to uncommit. 
  323. When all players are ready, a timer will count down from 60  and spawn all 
  324. players simultaneously. 
  325.  
  326. Team matches end after 20 minutes. Individual after 10 mins.  
  327. During matches, normal fraglimit and timelimit is ignored!  
  328. If a player connects during a match, he will be put in  
  329. observermode, and will not be able to join, unless administrator  
  330. toggles the "allowjoin" variable.  
  331.    
  332. If you connect to a server running SUSHI with the name     
  333. camclient, you will be put in observermode by default.   
  334. The Prematch training mode is great for practicing lavajumps and rocketjumps   
  335.    
  336.   
  337. Notes on anitlag toggle:   
  338. ------------------------   
  339. Antilag filters out some effects.   
  340. When antilag is enabled, nail and shaft filters are activated.   
  341. Furthermore gunshots, that doesn't hit anything that takes damage,  
  342. are not displayed, and bubblespawning is disabled.  
  343. Blood is replaced with a tempentity, in order to reduce priority and amount.  
  344. Additionally, weaponkick & hitflash is disabled for all players.   
  345.   
  346. This should free a little more bandwidth than the standard 50% of SUSHI,   
  347. compared to standard quake.  
  348. It will also reduce CPU workload for server & clients.  
  349.    
  350. Have fun!     
  351. -surgeon     
  352.    
  353. =============================================================================   
  354.    
  355. Credits:     
  356.    
  357. Main coding, ideas, optimizations, arena maps docra1-5 & sushi arena:     
  358. - 'surgeon'     
  359.   
  360. Testing: 'surgeon' & 'siir'     
  361.   
  362. QuakeC & map resources, implemented and customized for SUSHI by 'surgeon':     
  363. - David 'crt' Wright (Rocketarena code & sounds V1.2)     
  364. (http://www.planetquake.com/servers/arena/fasrv12.zip)     
  365. - 'Kashua' (kascam V1.8)     
  366. - 'Dr.Banzai' (Voting server patch)     
  367. - 'Nacho' (arena map: rarena3)     
  368. - Brian 'plucky' Ploeckelman (arena map: arenax)     
  369. - 'Ohnosofa' (arena map: inventory)   
  370. - 'ztn' (maps ztndm1-6) 
  371.   
  372. Bugreprots to: v2615@groenjord.dk     
  373.    
  374. =============================================================================     
  375.    
  376. Short history:     
  377.  
  378. 09/12 - 99: Version 1.0beta2
  379. - Added fragstats (*) in console upon match exit
  380. - Added client auto-screenshot of match result
  381. - Fixed minor problems with "report" and joining match from observermode
  382. - Changed 'restoreghost' cmd to 'restore'
  383.  
  384. (*)Fragstats:
  385. name|EnemyKills|FriendKills-KilledByEnemy|KilledByFriend|Suicides|KilledByEnvironment
  386.  
  387.   
  388. 24/10 - 99: Version 1.0beta 
  389. - Namechange to "SUSHI Combat Server" (was formerly "TheMod") 
  390. - New arenamap : "sushi arena" 
  391. - RocketArena mode now rotates on 9 maps 
  392. - Players are disarmed when servermode is changed 
  393. - Map voting blocked in rocketarena mode - now requires modechange 
  394.   (avoids incompatibility) 
  395. - Added "skip" command to arenamode 
  396.   (if players don't like map and wants to go ahead) 
  397. - Countdown timer for matchmodes changed to 60 seconds. 
  398. - Server made more foolproof in general - it's now virtually impossible 
  399.   to mess up matchmodes. 
  400. - Players admins are always in observermode - to join game, they have to 
  401.   give up admin status. 
  402. - Checks for committed players at matchstart 
  403.   (players who haven't selected color/team will be observers) 
  404. - In 1on1 mode, excessive players will be thrown in observermode when 
  405.   countdown starts 
  406. - Teamfrags are preserved if a player disconnects/becomes observer/joins 
  407.   from observermode 
  408. - New commands for Matchmodes (*) 
  409. - Ghostcodes(**) - can restore personal frags if connection is lost 
  410.   (Matchmodes Only!) 
  411.  
  412. (*) "blue"/"red" assigns you to a team 
  413. (*) "reporting"(ON/OFF)- prints leading team & by how many frags at bottom 
  414.     of your screen. 
  415. (*) "teamscores" - dumps team frags (your team & enemy) + leading team and 
  416.     by how many frags. 
  417. (**) if you forget to make a ghost before countdown, codes are sent to you 
  418.     when countdown starts. 
  419.  
  420.  
  421. 06/10 - 99: Version 0.99 
  422. - Included an extra RocketArena map + patched the sky textures to avoid 
  423.   skybug on amiga. 
  424. - Cleaned up CheckPowerups function to ignore kascam and to perform better.  
  425.   when pfx is on - reduces network traffic & server CPU load 
  426. - antilag toggle now shuts off bubble spawning 
  427. - Fixed discharge messages (knows lava & slime from water)  
  428. - Fairpacks option (always drops best weapon)  
  429. - Cells restrict option for rocketarena (keeps cells count to 30)  
  430. - Kill command re-enabled for matchmodes  
  431. - "unconnected" players are autokicked after 15 seconds  
  432. - internal check for invalid deathmatch/samelevel settings  
  433. - new playerskin for easier team recognition  
  434. - player, missile & bolt2 mdl placed in progs dir outside PAK  
  435. - better apperance for online-help  
  436. - RockerArena maps edited to bypass skybug on Amiga  
  437. - New Arena map added (inventory by 'ohnosofa')  
  438.  
  439.   
  440. 22/6 - 99: Version 0.98   
  441. - Direct admin features added for players (previously only observers)   
  442. - Admin status is retained until admin types "noadmin",   
  443.   or players vote to remove admin   
  444. - Anti-lag toggle (effects filter)   
  445. - Random map rotation for ffa modes made independent of "samelevel" cvar  
  446. - Status of antilag, deathcomments and powerups toggle is retained  
  447.   across levels.  
  448. - Weaponkick switchable for every player   
  449. - Hitflash switchable for every player  
  450. - PFX toggle modified to turn off light at once   
  451. - During match, observers are unlocked if one player disconnects   
  452.   This makes it possible to replace the player   
  453. - The "i-mode" command now lists status of toggles    
  454. - Fixed some problems with "allowjoin" command.   
  455. - Directed the "camera running" message to observer only   
  456. - Fixed bug with healthpack not respawning in ffa3 mode   
  457. - Fixed bug that could cause server-crash in ffa-modes  
  458.  
  459.   
  460. 10/6 - 99: Version 0.95     
  461. - Seperate cfg files for matchmodes, ffamodes & arenamode   
  462. - Direct admin features for observers   
  463. - Onlinehelp revised   
  464. - Aliases are now only sent when players connect   
  465. - Mode3 in match modes is now a toggle and does not require restart   
  466. - Matches now exit with a level-restart    
  467. - Various small fixes   
  468. - Full documentation written   
  469. - Included short documentation for RocketArena (arena.htm)   
  470. - Restructured the pakfiles   
  471.  
  472.    
  473. 25/5 - 99: Version 0.9      
  474. - RocketArena mode works correctly! (bugfix)     
  475. - Corpses left at disconnect removed (bugfix)     
  476. - added online help for arenamode     
  477.  
  478.    
  479. 12/5 - 99: Initial beta release     
  480.    
  481.      
  482.    
  483.      
  484.    
  485.    
  486.    
  487.    
  488.    
  489.    
  490.    
  491.    
  492.    
  493.