MQWCL Teamplay Help
===================

Report codes:
-------------
%h      - health
%R      - armor type & value
%A      - armor type (r, y, g)
%a      - armor value

%w      - current weapon with ammo
%b      - best weapon with ammo

%p      - powerups you have
%P      - powerup that last ended (your)
%q      - powerups of last seen enemy

%l      - your location
%d      - location you died at
%r      - last reported location

%e      - number of enemies in vicinity
%o      - number of teammates in vicinity

%S      - your skin
%C      - your color (bottom)

%t      - name and location of target pointed
%x      - name of target pointed
%y      - location of target pointed

%i      - name and location of item last picked up
%X      - name of item last picked up
%Y      - location of item last picked up

%j      - last target pointed
%k      - last item picked up or pointed
%m      - last item picked up or nearest

%u      - what you need

%L      - %l, but remembers situation 5 sec after death
%O      - %o, but remembers situation 5 sec after death
%E      - %e, but remembers situation 5 sec after death

%n      - send this message only to teammates in your vicinity
%N      - send this message to all but yourself

%sy     - your current status (LED)
          this monitors you health, armor and best weapon and reports led:
            green  - if all of this is OK,
            yellow - if there is one thing low (armor or health or weapon),
            red    - if there are two things low (or more),
          This is useful for need reports, example:
            say_team "-$\%sy me: need %u"

%sp     - type of object pointed (LED), reports:
            green  - if teammate,
            red    - if enemy,
            yellow - if powerup,
            blue   - if other object (weapon, armor, ammo etc),
          This is useful for point message, like:
            say_team "-$\%sp me: %t"
          Note, that eyes are treated as enemy.

%se     - teammates/enemies status in vicinity (LED), reports:
            green  - if there are no ememies in vicinity,
            yellow - if %e <= %o (number of enemies is less or equal than
                     number of teammates),
            red    - if %e > %o (number of enemies is greater than
                     number of teammates),

Message hiding
--------------
There are some codes, that would allow you to cheat, like %e, %t etc. They
are hidden hidden to you, but not to your teammates. But you can see, how
they work if you are alone on server, or server is running Kombat Teams
(or compatible) mod and is in standby mode (prematch).

Some variables
--------------

loc_dir - directory for location files (*.loc).
tp_expand_codes - enables reporting system.
tp_weapon_order - weapon order from best to worst, default = "78564321".

Object names
------------
You can change all strings that mqwcl uses for object naming. Look for
variables beginning with "tp_name_", ie. "tp_name_shells" sets the name
for "shells". Some, that require more attention:

  tp_name_someplace - used if the location cannot be determined, if you
                      often see that in your reports, check if you have
                      .loc file in correct place.

  tp_name_at - by default it is " at ", and is used in %i, %t etc. Note
               the enclosing spaces, removing them is not a good idea cause
               some reports may start looking strange, like:
                 took raatra
               but you can freely change it, for example to " @ " if it's
               preferred.

  tp_name_plus - by default "/", is used to join enumerated things, like
                 things you need in %u, powerups you have in %p etc.
                 So by default you say (example):
                    team quad/pent
                 but you can change it to
                    team quad+pent
                    team quad pent
                    team quad and pent
                 or whatever you like by changing this variable.

  tp_name_status_* - these are LEDS for %sy, %se and %sp. You can change
                     that if you don't use compatible gfx.wad.

Took reporting
--------------
You can specify what should be remebered as a last-took object. This is
often very important, because mqwcl only remember last item you took, so
you should rather disable reporting of less important items. Example: if
you enable reporting of picking up rocket launcher (good idea) and nail
ammos (bad idea), then you'll often get bad report when taking rl at
dm3, because it is close to nail pack and usually you pick up both of them.
And only last one is reported.

Variables for that are beginning with "tp_took_". Values other than zero
enable reporting of this object. Default values are good for most cases.

Pointing
--------
As with took reporting, it is preferred to disable pointing of less
important items. All variables for that are beginning with "tp_point_".
Note, that weapons are only reported in deathmatch 1, and deathmatch 4
disables reporting of ammo packs.

Need reporting
--------------
You can specify when mqwcl should report, that you need health, armor etc.
Use variables beginning with "tp_need_". Note, that there are separate
values for different armor types, so you can specify (for example) that
low level for red armor is 80, and for yellow is 50. And you can specify
low level for green armor to 100, so mqwcl will always report armor as
needed, if you have a green one.

One variable requires more attention - "tp_need_required". Fill it in with
weapon numbers, that you always want, even if you have another weapon
considered as good. Typical example for that is RL and LG. LG is usually
considered a good weapon, so if you have it, you no longer report
"need weapon". But you probably want to report, that you still need RL.
So add 7 (RL number is 7) to tp_name_required. If you need to place more
weapons here, combine them together, like "67" = GL and RL.

Please note, that "tp_need_weapon" uses "tp_weapon_order" to determine if
your weapon is good. For example, we have default values:
    tp_weapon_order "78564321"
    tp_need_weapon  "5"
Low level is set to 5 (SNG), so weapons before that (7 = RL and 8 = LG)
are considered as GOOD, and the rest (5, 6, 4, 3, 2, 1) are low.

Styles
------
You can apply some styles to you reports, to quickly change their look,
and to make them more readable. This is extremely useful, example: your
health can be reported in another way, if it is low.

Variables for that are:
  tp_style_location         - style for location names
  tp_style_health           - style for health (%h)
  tp_style_health_low       - style for health if it is low
  tp_style_armor            - style for armor (%a, %R)
  tp_style_armor_low        - style for armor if low
  tp_style_weapon           - style for weapon (%w, %b)
  tp_style_weapon_low       - style for weapon if low (or ammo for that
                              weapon is low)
  tp_style_powerups         - style for own powerups (%p), is you have some
  tp_style_need             - style for need report if you need sth
  tp_style_obj_enemy        - style for object pointed when it is enemy
                              or eyes
  tp_style_obj_teammate     - style for object pointed when it is teammate
  tp_style_obj_powerup      - style for object pointed/pickud up when
                              it is powerup
  tp_style_obj_item         - style for object pointed/picked up when
                              it is item

Styles are made of character groups, in which one character adds one
feature to this style. You can use following characters:

'0' - replace all numbers with yellow ones,
'1' - make text white (adds {}),
'2' - add space at left,
'3' - add space at right,
'4' - enclose with [ ],
'5' - enclose with $[ $] (glowing [ ]),
'6' - enclose with ( ),
'7' - enclose with $( $),
'8' - enclose with < >,
'9' - enclose with $< $>
'a' - make all letters BIG
'b' - enclose with * *
'c' - enclose with - -
'd' - enclose with = =
'e' - enclose with + +
'f' - enclose with $. $.
'g' - enclose with $, $,

Example: if you want your health to be white, if it is low, and additionally
enclose with glowing square brackets, set:

    tp_style_weapon_low "15"
or
    tp_style_weapon_low "51"

Or if you want your armor to be always yellow, but with funny brackets if
it is low, set:

    tp_style_armor      "0"
    tp_style_armor_low  "07"

Spaces ('2' and '3') are often useful for reporting of powerups. For example,
many ppl use sth like that to report current status:

    say_team "-$\me: %p %A%a/%h$.%b @ %l"

It looks fine if you have some powerups. If not, you get two spaces between
your nickname and armor value. You can get rid of this with changing it to:

    say_team "-$\me:%p %A%a/%h$.%b @ %l"

and setting

    tp_style_powerups "2"

and mqwcl will add space before powerups if there are any.

Referring to this example, it is recommended to replace "%A%a" with %R, so
armor style will be also applied to armor type. So it should look like that:

    say_team "-$\me:%p %R/%h$.%b @ %l"

You can add a LED at the beginning and you have one report ready to use.

Qizmo notes
-----------
If you connect through qizmo with mqwcl, you need to know that:
- you have to set "powerup blend" in qizmo "fps settings" to ON, or mqwcl
  will not report your own powerups (%p). That's because this option, if set
  to OFF, hides information about your own powerups from the client,
- you can use qizmo reporting system instead if you prefer - disable mqwcl
  reporting with 'tp_expand_codes 0'
- only few client/proxies support white chat text, currently known to me are
  nfproxy (which started this idea), mqwcl and I believe zquake. In particular
  Qizmo+Qwcl2.3x combination does not support that and qwcl 2.3x users will
  see white text as red with braces, like this:  red{white}red. Some people
  may find it annoying I guess..
