home *** CD-ROM | disk | FTP | other *** search
/ Quake 'em / QUAKEEM.BIN / quake / programs / tf1_1src / readme.txt < prev    next >
Encoding:
Text File  |  1996-08-30  |  21.2 KB  |  489 lines

  1. *==============================================================*
  2. * TeamFortress v1.1                                 readme.txt *
  3. *==============================================================*
  4. Introduction
  5. ------------
  6.  
  7. TeamFortress is a new QuakeC patch which radically changes
  8. team games. It provides far more incentive for teams to 
  9. actually work as a team. Each member of the team has unique
  10. weapons, items, and abilities.
  11.  
  12. It is most fun to play on a map with two, or more, clearly defined
  13. team fortresses, or bases. We're a little limited until we 
  14. write a good map for it, but until then, try some of quake's
  15. levels. Define the team areas, and a goal or two. 
  16. For example, we sometimes play on e1m1. Its not a big map, so 
  17. we play with two teams of 4. One team's base is the room containing
  18. the end of level slipgate. The other team starts at the bridge
  19. outside, and has to finish the level. The first team has to
  20. prevent the other team from finishing the level.
  21.  
  22. Once you have some clear goals like this, and start using the 
  23. individual class's abilities to complement each other, it's a hell
  24. of a lot of fun! :)
  25.  
  26. At the moment, we've got one FortressMap almost finished. As we, or 
  27. you :), make more maps for this patch, we'll put them up on the 
  28. WWW page (see Availability).
  29. If you're interested in making maps to use the extra features
  30. of this patch, see the TeamFortress Map Details below.
  31.  
  32. Oh, and one more thing, I know there are some things in this
  33. patch, such as pipe-bombs, that are in other patches, but they're 
  34. here because they're good to have. I'd far rather people complain 
  35. about our lack of originality than say "Why the hell didn't they 
  36. put in pipebombs?" :)
  37.  
  38. What do you need to know?
  39. -----------------------
  40. Really, if you want to get into TeamFortress as soon as possible, 
  41. all you need to know is the command "helpme". Type this in at the
  42. console and you'll be shown the help index.
  43. You should be able to figure it out from there :)
  44.  
  45. _NOTE_: The aliases created for you, such as helpme, do _not_
  46.         work in a single-player game if you type them into the
  47.         console. Instead, you _must_ bind a key to them, get out
  48.         of the console, and press the key.
  49.         e.g. In the console, type "bind h helpme" and then
  50.              get out of the console and press your h key.
  51.         If you're interested in why you have to do this, see
  52.         the Impulse and Alias summaries below.
  53.         Although this is a pain, it's worth it. Trust me! ;)
  54.  
  55. Player Classes
  56. --------------
  57. TeamFortress uses multiple player classes. Whenever a new map is loaded,
  58. all players start as an Undefined class. This class has 1 health, an axe,
  59. and cannot pick up anything. Once a player class is chosen, you cannot
  60. change class for the rest of that level. To choose a class, just use the
  61. appropriate impulse. (See Impulse Summary)
  62. The classes implemented so far are as follows:
  63.     SCOUT:        Fastest moving class. Can only wear a small amount of the 
  64.                 lowest absorption armor. Limited to the 2 Shotguns and Nailgun.
  65.                 Low ammo levels.
  66.                 Carries a Motion Detector, 2 grenades, 3 concussion grenades.
  67.  
  68.     SNIPER:        Medium speed. Wears only small amount of armor, upto medium
  69.                 absorption level. Limited to Nailgun and Sniper's rifle. Medium
  70.                 ammo levels.
  71.                 Carries 2 grenades.
  72.  
  73.     SOLDIER:    Slow moving class. Wears large amount of armor, at all 
  74.                 absorption levels. All normal weapons except Grenade Launcher.
  75.                 High ammo levels.
  76.                 Carries 4 grenades, 4 nail grenades.
  77.  
  78.     DEMOLITION MAN: Medium speed. Wears medium amount of armor, upto medium
  79.                 absorption level. Uses the ShotGun and Grenade/Pipebomb Launcher
  80.                 Carries 1 DetPack, 6 grenades, 4 Mirv Grenades.
  81.  
  82.     COMBAT MEDIC: Medium speed. Wears medium amount of armor, upto medium
  83.                 absorption level. Uses both Shotguns and the Super Nailgun.
  84.                 Carries Medikit, 3 grenades, 2 concussion grenades.
  85.                 Regenerates slowly.
  86.  
  87.     HEAVY WEAPONS GUY: The slowest moving class of all. Lotsa armor, high
  88.                 absorption levels. Uses both Shotguns, the Nailgun, and
  89.                 the Assault Cannon (yeah!)
  90.                 Carries 4 grenades and 1 Mirv Grenade.
  91.  
  92. New Weapons
  93. -----------
  94. Sniper Rifle:
  95.     This weapon is used instead of the shotgun by the SNIPER playerclass. It
  96.     uses shotgun shells for ammo, and operates in two modes:
  97.         - Single Shot. With a reload time of 3 seconds, this mode is what
  98.           sniping is all about. One shot from this will kill most players
  99.           except for a heavily armored SOLDIER or DEMOLITION MAN.
  100.         - Auto Shot. Although this fire mode does a lot less damage than
  101.           single shot and uses a lot of ammo, its great for picking off
  102.           a wounded target, or a fast moving SCOUT.
  103.     The other tricky bit about the sniper rifle is that it is a rifle. You
  104.     can't just snap shot from the hip with it. If you're moving too fast,
  105.     the rifle simply won't fire. Besides, you're a sniper, you're not
  106.     supposed to be strafe-fighting with soldiers! :)
  107.  
  108. Assault Cannon:
  109.     Big! Fires lotsa bullets! Really fast!
  110.     What more do you want?
  111.     It's used by the Heavy Weapons Guy. It taks 10 cells just to power up
  112.     each time you pull the trigger, and then starts to eat up your shotgun
  113.     ammo like you wouldn't believe!
  114.     It also tends to eat up enemies too, so it isn't all bad :)
  115.     As you fire the Assault Cannon, it gets hotter and harder to control. 
  116.     After firing, it has to cool. This can take a while, and is dependant 
  117.     on how long you fired it for, natch :)
  118.     Luckily, cooling require no effort on your part, so you can change
  119.     weapons while you wait.
  120.     Oh, you can't move while firing either, and you can't fire when
  121.     you're not on the ground.
  122.  
  123. Grenades
  124. --------
  125. Several new types of grenades now exist, and all classes have access to at
  126. least one of them. They are not to be confused with the grenades used by
  127. the grenade launcher.
  128. Use of these grenades is exactly as one would expect. Pull the pin, throw
  129. it, and wait. After 3 seconds it goes off. Just make sure you throw it
  130. _before_ the 3 seconds are up :)
  131. The grenade types are as follows:
  132.     Normal        :    Normal grenades simply explode. They are twice as powerful
  133.                     as those shot from the grenade launcher.
  134.  
  135.     Concussion    :    Concussion grenades don't actually hurt anyone, they just
  136.                     blow everyone away from the grenade explosion at a high
  137.                     speed, and then make them woozy. They're the SCOUT's best 
  138.                     way of escaping from a roomful of enemies. The ensuing confusion 
  139.                     usually gives him enough time to run.
  140.  
  141.     Nail        :    Nail grenades are good in large rooms. Instead of detonating,
  142.                     they raise up into the air and hover. They then begin to 
  143.                     rotate while firing nails. After doing this for a few seconds
  144.                     they explode like a normal grenade.
  145.  
  146.     Mirv        :    Mirv grenades are room-clearers. When one explodes,
  147.                     it divides into approximately 15 individual grenades which
  148.                     then explode.
  149.  
  150. New Items
  151. ---------
  152. Motion Detector:
  153.     This item is the SCOUT's best friend. The SCOUT can specify an amount of
  154.     cells spent on a scan. The detector displays a list of all enemies/friends
  155.     within a distance around the SCOUT, and their direction in relation to the 
  156.     SCOUT. The more energy spent, the larger the detection distance.
  157.     Bear in mind though that the motion detector only detects motion (natch! :)
  158.     So it won't pick up stationary or very slow moving players.
  159.     You can toggle detection of friends and enemies using the aliases "scane" and "scanf"
  160.     or impulse 1 and 2 after the Pre-Impulse. For more information on 
  161.     Pre-Impulses, see the Impulse Summary.
  162.  
  163. Medikit:
  164.     The COMBAT MEDIC has a medikit which allows him to heal any other member
  165.     of his/her team by hitting them with his axe. Each hit will heal them
  166.     10 points and reduce the 'ammo' for the medikit by 10. You can see how
  167.     much 'ammo' for the medikit you have by looking at your inventory. If
  168.     the COMBAT MEDIC walks over a health box while at maximum health, the 
  169.     health box will be used to replenish the medikit 'ammo'.
  170.  
  171. Detpack:
  172.     The DEMOLITION MAN has a Detpack. This is a large-scale explosive device.
  173.     When the DEMOLITION MAN places it he is unable to move for 4 seconds
  174.     while he primes it.
  175.     The timer on the Detpack is set by the DEMOLITION MAN. e.g. After the 
  176.     Pre-Impulse, an Impulse of 10 sets the timer for 10 seconds. For more 
  177.     information on Pre-Impulses, see the Impulse Summary.
  178.     Oh yeah, Scouts can disarm them by running over them :)
  179.  
  180. New Rules
  181. ---------
  182. Reloading:
  183.     All basic weapons except the Nailgun and Super Nailgun have clips. When all
  184.     the ammo in a clip is spent, the weapon is reloaded. This can take anywhere
  185.     from 1 second for the Shotgun to 5 seconds for the Rocket Launcher. Ammo
  186.     amounts in the clips varies between weapons.
  187.     While reloading, you cannot change weapons.
  188.  
  189. ToggleAble Game Settings
  190. ------------------------
  191. There are now a few toggleable game settings which can be changed while
  192. playing. Each has an alias which toggles it.
  193. The options at the moment are:
  194.     Multiskin/Classkin
  195.         This option switches between Multiskin, where each player can use the 
  196.         skin commands to cycle through all the available skins and choose one
  197.         they like, and Classkin, where each player has his/her skin chosen
  198.         for them based on their class.
  199.     Class Persistence On/Off
  200.         This option allows you to turn on Class persistence between levels.
  201.         E.g. If it's on, when you go to a new level each player will stay
  202.         the same class they were in the last level.
  203.     Cheat Checking On/Off
  204.         This option toggles whether you want speed checking of players in
  205.         an attempt to catch people tinkering with their maxspeed. It's not
  206.         an elegant way of checking, and is by no mean foolproof, so you
  207.         may wish to turn it off. If you're playing with friends, turn it off
  208.         and save some of the server's computing time. If you're playing on 
  209.         the net, you might want to leave it on. It's better than nothing :)
  210.     FortressMap On/Off
  211.         This option turns on the use of effects which only work on maps
  212.         built specifically for TeamFortress. I'd advise against turning 
  213.         it on in maps that aren't built for TeamFortress. 
  214.         If you play on a TeamFortress Map, TeamFortress will detect this,
  215.         and set this setting On, but you're welcome to turn it off if
  216.         you want to deathmatch. 
  217.         See TeamFortressMap Details below for more info.
  218.  
  219. Alias Summary
  220. --------------
  221. Aliases are fine and dandy, but there's just one small problem with them :)
  222. If you're playing a single-player game, aliases that use a Pre-Impulse, such
  223. as all the Help, Scanner, Detpack, and Setskin aliases, don't work if you
  224. type them in at the console.
  225. If you're playing a single-player game, you'll have to bind them to a key,
  226. get out of the console, and press the key. It's a bummer, but hey!, this 
  227. patch is for team games :)
  228. And Pre-Impulses are too good to remove because of it.
  229. The aliases that are automatically created for you by TeamFortress are:
  230.  
  231. Help Related
  232.     helpme            :    Display Help Index
  233.     generalhelp        :    Display General command help
  234.     classhelp        :    Display Class command help
  235.     weaponhelp        :    Display Weapon command help
  236.     itemhelp        :    Display Item command help
  237.     skinhelp        :    Display Skin command help
  238.     preimphelp        :    Display Pre-Impulse help 
  239.     showpreimp        :    Display a list of the Pre-Impulses used
  240.  
  241. General
  242.     inv                :    Display your inventory
  243.  
  244. Class Changing
  245.     scout            :    Change class to Scout
  246.     sniper            :    Change class to Sniper
  247.     soldier            :    Change class to Soldier
  248.     demoman            :    Change class to Demolitions Man
  249.     medic            :    Change class to Combat Medic
  250.     hwguy            :    Chnage class to Heavy Weapons Guy
  251.  
  252. Grenades
  253.     primeone        :    Prime a grenade of Type 1
  254.     primetwo        :    Prime a grenade of Type 2
  255.     throwgren        :    Throw whatever grenade you've primed
  256.  
  257. Pipebombs
  258.     detpipe            :    Detonate all your pipebombs
  259.  
  260. Scanner
  261.     scane            :    Toggle detection of enemies with the Scanner
  262.     scanf            :    Toggle detection of friendlies with the Scanner
  263.  
  264. Sample aliases for the Scanner
  265.     scan10            :    Scan using 10 cells
  266.     scan50            :    Scan using 50 cells
  267.     scan250            :    Scan using 250 cells
  268.  
  269. Sample aliases for the Detpack
  270.     det5            :    Set your detpack for 5 seconds
  271.     det20            :    Set your detpack for 20 seconds
  272.     det250            :    Set your detpack for 250 seconds
  273.  
  274. Toggleable Game Settings
  275.     t_skin            :    Toggle Multiskin/Classkin
  276.     t_classpersist    :    Toggle Class Persistence
  277.     t_cheatcheck    :    Toggle Cheat Checking
  278.     t_fortressmap    :    Toggle FortressMap
  279.  
  280. Skin Selection
  281.     nextskin        :    Change skin to the next skin in the player.mdl 
  282.     prevskin        :    Change skin to the previous skin in the player.mdl 
  283.  
  284. Sample aliases for Set Skin
  285.     skin10            :    Change skin to number 10 in the player.mdl
  286.     skin20            :    Change skin to number 20 in the player.mdl
  287.  
  288. The sample aliases are examples of how the Pre-Impulses commands are used.
  289. For more information on Pre-Impulses and how to create your own aliases for
  290. Scanner/Detpack/Setskin etc, see the Impulse Summary.
  291.  
  292. Impulse Summary
  293. ---------------
  294. In version 1.0 everything relied on Impulses. Now, it's all bound to aliases.
  295. This means you don't have to know the impulses unless you want to merge this
  296. with another patch, in which case you can look at the code, or type "showimp"
  297. in the console.
  298. The only thing I should mention is Pre-Impulses. A Pre-Impulse is an impulse
  299. which must be used before another impulse. The second impulse can then be
  300. interpreted in a different way.
  301. For example:
  302.     The SCOUT's Motion Detector has a Pre-Impulse of 249. You specify the 
  303.     amount of energy you want to spend on the scan with an impulse after it.
  304.     So if you wanted to use 50 energy to scan, you would do Impulse 249
  305.     followed by Impulse 50. The recommended way to do this is to bind
  306.     a key to an alias. In the console, you could do this:
  307.         alias scan_50 "impulse 249; wait; impulse 50"
  308.         bind S scan_50
  309.     This would make 'S' do a scan using 50 energy.
  310. There are already aliases created for all Pre-Impulse things, but you might 
  311. to make your own, for different time/energy usages.
  312. You will probably want to make an alias to set your favourite skin when 
  313. playing Multiskin, so you don't have to use nextskin 14 times if you
  314. like skin 15. Create an alias which does the Multiskin Pre-Impulse(202), and 
  315. then does the Impulse matching the skin you want, e.g. 15.
  316.  
  317. Team Details
  318. -----------------------
  319. We now handle a basic Team structure. Apart from standard Teamplay,
  320. you can use FortressTeams. In FortressTeams we allow upto 4 different
  321. teams on the one map.
  322. Players can join a team by using the aliases imin1,imin2,imin3, and imin4.
  323. The first player to join a particular team becomes the Team Leader, and
  324. the color of his/her pants becomes the Team Color. Any players who
  325. join that Team from then on will have their colors automatically changed
  326. to the Team Colors.
  327. Once players join a team they cannot change to another team.
  328. Any player who attempts to change their _pants_ color away from the
  329. Team Color will be penalised. Shirt colors can be changed freely.
  330. FortressTeams are a must on any Map that was written for TeamFortress,
  331. since the spawnpoints on a TeamFortress Map are allocated to particular
  332. teams. See the TeamFortressMap Details for more info.
  333. By next release we hope to have a full Team structure implemented.
  334.  
  335. TeamFortressMap Details
  336. -----------------------
  337. As of v1.1 we've got support built in for maps designed specifically
  338. for this patch. This allows us to do fancy things, such as:
  339.     - Team Spawnpoints. If you belong to a team, you'll spawn at
  340.       a spawnpoint owned by your team.
  341.     - Armor types. Different types of armor which protect against
  342.       specific weapons. See the New Items for more info.
  343.  
  344. These only come into effect if the Toggleable game setting FortressMap is On.
  345. If you want to create your own Maps for TeamFortress, the details you
  346. need to know are in a separate file, included in this .zip, called tfortmap.txt
  347.  
  348. Multiskin Details
  349. -----------------
  350. We now have support for skins in TeamFortress. There are two modes:
  351. Multiskin and Classkin, which is the default. With Classkin, your 
  352. skin is set to a skin based on your Class, and you cannot change it.
  353. Multiskin works the same way as the Original Multiskin by Dennis
  354. Noordsij. For now, all skins we use are skins which come with Multiskin,
  355. but we've got a couple of people drawing skins right now, and when
  356. they're done, we'll give them to Dennis to include in Multiskin.
  357. If you download a newer version of Multiskin that has more skins
  358. in it, you will have to edit defs.qc. Right near the end of the
  359. file is line like this:
  360.     float MS_MAX_SKIN    = 32;
  361. Change the 32 to the number of skins in the new player.mdl.
  362.  
  363. Servers with this Code
  364. ----------------------
  365. If you're interested in using some/all of this code for a Net server, 
  366. then all I ask is one thing: Mail me (address below) and tell me. 
  367. I'd like to know if anyone uses it as a Net server, simply because I'd like 
  368. to play a server on the net using this code. 
  369. Since I don't have a server...;)
  370. The biggest advantage of notifying me that you're running a server
  371. with this code is that I'll mail you new versions whenever they come out.
  372.  
  373. Also you may wish the edit the defs.qc file and change the value of
  374. the last line, which looks like this:
  375.     float IS_NET_SERVER    = 0;
  376. Change the 0 to a 1, and recompile the code. Now, TeamFortress will
  377. only use graphics/sounds that come with quake, so people connecting to
  378. your server won't need any extra files.
  379. Of course, it won't sound/look half as good... :)
  380.  
  381. Copyright and Distribution
  382. --------------------------------------
  383. Authors may use this code for the basis of other freeware quakec
  384. code, but not for any for-profit code.
  385.  
  386. You may distribute this patch in any electronic format as long as this 
  387. textfile remains unmodified and all of the files in the archive are
  388. present, and as long as no charge is made for it.
  389.  
  390. Quake Servers are free to run this patch, but it'd be nice in
  391. you mailed us and mentioned that you are.
  392.  
  393. Availability
  394. ------------
  395. The latest version of this patch can always be found at the 
  396. TeamFortress WWW page - http://minyos.its.rmit.edu.au/~cookj
  397.  
  398. The latest version should also be on the following locations:
  399. ftp.cdrom.com/pub/quake/    <- check incoming, newstuff or quakec/multiplayer
  400. The Quake Stomping Grounds - http://www.stomped.com/files.shtml
  401.  
  402. Other Stuff
  403. -----------
  404. TeamFortress was written by Robin Walker and John Cook. Various other people
  405. contributed ideas to it. I can't hope to list them all, but here's some of them:
  406.     Ian Caughley, Peter Wilson, Jason Grant.
  407.  
  408. Some of the code for TeamFortress was influenced by other people's.
  409. They are as follows:
  410.     Mirv Grenade code was influenced by Firewall code from Steve Bond (wedge@nuc.net)
  411.     Pipebomb code was influenced by code from AsmodeusB (tazq@sos.on.ca)
  412.  
  413. Although we've never seen their code, these people are credited here
  414. because they've got great ideas:
  415.     Multiskin, from the first person to work it out, Dennis Noordsij (lnoordsi@inter.NL.net)
  416.  
  417. Also, thanks must go to the following people for their comments and suggestions:
  418.     John Wolsch (john_w@bga.com)
  419.     Thomas LULLIER (106110.1406@compuserve.com)
  420.     Bas Olthoff (reboot@dsl.nl)
  421.     Phil Sykes (phil@centrenet.co.uk)
  422.     Serendip (an705819@anon.penet.fi)
  423. We wouldn't have got past 1.0 if it wasn't for these guys/gals.
  424.  
  425. And finally, thanks must go to Mike Kaminski (LKKAM@msn.com), for pointing
  426. out the stupidest mistake I've made for a while :)
  427.  
  428. What are we working on now?
  429. More classes :) Technician, Observer/Referee, Engineer, Barbarian
  430. More items - Personal Teleporter devices, Deployable autocannons(like Aliens :)
  431.            - JumpJets, Personal Shields Generators, Rebounding Shield
  432.            - Armor protecting against specific weapons(Got this done, just a 
  433.                    little bit more work to do)
  434. More weapons - BioDiseases
  435. More grenades - Shock gren.(get out of the water!), Teleport Grenades
  436. Mdls for all weapons and grenades, and for reloading.
  437. And some maps built specifically for this code. (We're _that_ close :)
  438.  
  439. Yeah, I know this list looks a lot like what we said we were working
  440. on after v1.0, but we had a lot of requests for some things we hadn't
  441. started on, such as multiskin, so we side-tracked and did them.
  442. If all goes as planned, the next version should have a completely 
  443. rewritten teamplay options, multiple fortress maps, and 3-4 new
  444. player classes.
  445.  
  446. I'm happy to help with any questions about the source you have.
  447. One thing that we took pains to do was to make almost _everything_ #defined. 
  448. You can 'tweak' 90% the game details just by editing the defs.qc
  449.  
  450. Robin. (Bro in Quake)
  451. walker@netspace.net.au
  452.  
  453. =======
  454. Version info for those that interested:
  455.  
  456. -----------
  457. Version 1.1
  458. -----------
  459. Features added:
  460.     - Help revamped.
  461.     - Aliases for Help, Detpacks, and Scanners added.
  462.     - Multiple Player skin support added.
  463.     - Added World Toggleables handling.
  464.         - Classkin and Multiskin Toggle added.
  465.         - Class persistence between levels Toggle added.
  466.         - Cheatchecking Toggle added.
  467.                 - TeamFortressMap Toggle added.
  468.     - Detpack CountDown added.
  469.     - Scanner now gives directions of blips
  470.     - NetServer setting which uses no non-standard quake files
  471.     - TeamFortress Map Support (Yeah!!)
  472.  
  473. Classes: Scout, Sniper, Soldier, Demolitions Man, Combat Medic,
  474.          Heavy Weapons Guy.
  475.  
  476. Changes:
  477.     - Undefined players are now invincible, but can't move.
  478.  
  479. Bugs Removed:
  480.     - Detpack was spawning two objects.
  481.     - Gibbed while Reloading bug fixed.
  482.     - Dying while concussed bug fixed.
  483.  
  484. -----------
  485. Version 1.0
  486. -----------
  487. Initial Release
  488. Classes: Scout, Sniper, Soldier, Demolitions Man, Combat Medic
  489.