Package: tf2mon
tf2mon - Team Fortress 2 Console MonitorUsagetf2mon [--tf2-install-dir DIR] [--rewind | --no-rewind]
       [--follow | --no-follow] [--list-con-logfile]
       [--trunc-con-logfile] [--clean-con-logfile]
       [--exclude-file FILE] [--layout {CHAT,DFLT,FULL,TALL,MRGD,WIDE}]
       [--log-location {MOD,NAM,THM,THN,FILE,NUL}]
       [--sort-order {AGE,STEAMID,CONN,K,KD,USERNAME}] [--single-step]
       [--break LINENO] [--search PATTERN] [--inject-cmd LINENO:CMD]
       [--inject-file FILE] [--toggles] [--database FILE]
       [--hackers FILE] [--print-steamids STEAMID [STEAMID ...]]
       [--print-hackers] [-h] [-v] [-V] [--config FILE]
       [--print-config] [--print-url] [--completion [SHELL]]
       [con_logfile]Team Fortress II (TF2) Console Monitor,tf2mon, is an interactive
terminal application that displays scoreboards and player statistics of
an active game.tf2moncan also--rewindand--single-stepthrough previous games.tf2monrecognizes and tracks abusive players, such as racists andcathook-bots. It provides application and in-game key-bindings toCALLVOTE KICKcheaters/hackers, or mark as racist or suspect.tf2monreads TF2's console logfile (con_logfile), creates action
scripts in TF2'scfg/userdirectory, and binds keys for gamer to
press to take those actions, such as issueSAYandCALLVOTE KICKcommands.Other in-game key-bindings taunt gamer's last victim/killer with aCHATmessage customized with their name, k/d ratio, rotating spam,
weapon and duel-scores (TauntandThroe).By default,tf2monstarts readingcon_logfilefrom its end
(--no-rewind), and--follows its tail.Positional Argumentscon_logfile         TF2 console logfile; relative to `--tf2-install-dir`
                    (default: `console.log`).Options--tf2-install-dir DIR
                    TF2 installation directory (default: `~/tf2`).
--rewind            Start from head of logfile (default: `False`).
--no-rewind         Start from tail of logfile (default: `True`).
--follow            Follow end of logfile forever (default: `True`).
--no-follow         Exit at end of logfile (default: `False`).
--list-con-logfile  Show path to logfile and exit.
--trunc-con-logfile
                    Truncate logfile and exit.
--clean-con-logfile
                    Filter-out excluded lines from logfile to stdout and
                    exit.
--exclude-file FILE
                    Exclude lines that match patterns in `FILE` (default:
                    `~/dev/tf2mon/tf2mon/data/exclude.txt`).
--layout {CHAT,DFLT,FULL,TALL,MRGD,WIDE}
                    Choose display layout (fkey: `F9`) (default: `MRGD`).
--log-location {MOD,NAM,THM,THN,FILE,NUL}
                    Choose format of logger location field (fkey: `F8`)
                    (default: `NUL`).
--sort-order {AGE,STEAMID,CONN,K,KD,USERNAME}
                    Choose sort order (fkey: `F7`) (default: `KD`).Debugging options--single-step       Single-step at startup.
--break LINENO      Single-step at line `LINENO`.
--search PATTERN    Single-step when line matches `PATTERN`; add `/i` to
                    ignore case.
--inject-cmd LINENO:CMD
                    Inject `CMD` before line `LINENO`.
--inject-file FILE  Read list of inject commands from `FILE`.
--toggles           Allow toggles when `--rewind` (default: `False`).Database options--database FILE     Main database (default: `~/.cache/tf2mon/tf2mon.db`).
--hackers FILE      Hackers database (default:
                    `~/.cache/tf2mon/hackers.json`).
--print-steamids STEAMID [STEAMID ...]
                    Print `ISteamUser.GetPlayerSummaries` for `STEAMID`
                    and exit.
--print-hackers     Print hackers database and exit.Configuration fileThe configuration file (see--config FILEbelow) defines local
settings:[tf2mon]
  tf2_install_dir = "/path/to/your/tf2/installation"
  webapi_key = "your-steamworks-webapi-key"
  player_name = "Your Name"Function KeysThese function keys are available in-game and in the monitor:F1 Display Help.
        ctrl+F1 Display Message of the Day.
       shift+F1 Display file.
             F2 Enable/disable debug (use `ECHO` or `SAY`).
             F3 Enable/disable `Taunt` messages.
       shift+F3 Enable/disable `Throe` messages.
             F4 Include `Kill/Death ratio` in `User.moniker`.
       shift+F4 Display kills in journal window.
             F5 Cycle contents of User Panel.
       shift+F5 Display perks in journal window.
             F6 Join Other Team.
             F7 Cycle scoreboard Sort column.
             F8 Cycle logger `location` format.
        ctrl+F8 Reset logger `padding`.
       shift+F8 Cycle logger `level`.
             F9 Cycle grid layout.
        ctrl+F9 Refresh chat window(s).
       shift+F9 Clear chat window(s).
         KP_INS Show debugging.
         KP_DEL Start single-stepping.
              [ Kick last killer as `cheater`.
              ] Kick last killer as `racist`.
              \ Mark last killer as `suspect`.
        KP_HOME Pop last/latest kicks queue message.
   KP_LEFTARROW Clear kicks queue.
         KP_END Pop first/oldest kicks queue message.
        KP_PGUP Pop last/latest spams queue message.
  KP_RIGHTARROW Clear spams queue.
        KP_PGDN Pop first/oldest spams queue message.
           KP_5 Clear kicks and spams queues.
   KP_DOWNARROW Push `steamids` from game to monitor.In-Game Controls, NumpadWhile playing TF2, use theNumpadto kick cheaters, and generateTauntand death-Throespam.Messages are placed into queues, and may be popped off either end.Queues -->    Kicks     Admin     Spams
                  |         |         |
                  v         v         v
             +---------+---------+---------+
  last/      |         |         |         |
  newest --> |   pop   |         |   pop   |
             |         |         |         |
             +---------+---------+---------+
             |         |         |         |
             |  clear  |  clear  |  clear  |
             |         |  both   |         |
             +---------+---------+---------+
  first/     |         |         |         |
  oldest --> | popleft |  vet    | popleft |
             |         |         |         |
             +---------+---------+---------+To vet new players that have joined the game,tf2monneeds theirsteamids, and to get them, gamer must pressNUMPAD-DOWNARROW. Thestatuspanel will be highlighted when the monitor needs steamids.When detected,tf2monpushes hackers onto theKicksqueue, and
alerts the gamer, who may then pressHOME/ENDto issueCHATandCALLVOTE KICKcommands.When gamer kills an opponent,tf2monpushes aTauntonto theSpamsqueue; on death, aThroe. Enable/disable withF3. Send
withPGUP/PGDN.The monitor can only push actions onto the queues; gamer must pop
for action to be taken, or clear to discard.DuelsThe user-panel displays battles with opponents, grouped by weapon (and
its state when fired).┌─────────────────────────────────────────────────────────────────────┐
  │Duels:                                                               │
  │ 4 and  2 vs GLaDOS                                                  │
  │             K  2 soldier        quake_rl                            │
  │             K  1 pyro           flamethrower                        │
  │             K  1 pyro     +crit flamethrower         +Low Gravity   │
  │             D  2 heavy          minigun                             │
  │ 5 and  0 vs CreditToTeam                                            │
  │             K  2 soldier        quake_rl                            │
  │             K  2 pyro     +crit flamethrower                        │
  │             K  1 pyro           flamethrower                        │
  │ 3 and  1 vs Aperture Science Prototype XR7                          │
  │             K  1 soldier        world                               │
  │             K  1 soldier        quake_rl             +Invisibility  │
  │             K  1 pyro     +crit flamethrower                        │
  │             D  1 demo           player                              │
  └─────────────────────────────────────────────────────────────────────┘Where to Operatetf2monworks by reading thecon_logfileto whichTF2logs
messages during the game.tf2moncan either "tail -f" an active
game, or--rewindand replay saved logfiles. PressEnterin the
admin console to process the next line when in--single-stepmode.
Typequitor press^Dto exit.`One-machine, Two-monitors`
      Run `tf2mon` on a secondary monitor, while playing game on
      primary monitor.

  `Two-machines, SSH`
      ssh from another machine and run.

  `Two-machines, NFS`
      cross-mount TF2's `cfg` tree to another box and run from there.Terminal Sizetf2monrequires a large terminal. Maximize the window, and use keys
(maybeCtrl-MinusandShift-Ctrl-Plus) to resize. The wider the
terminal, the more player data will be displayed:36x146 minimum
  42x173 display personaname
  52x211 display realname
  62x272 display age/locationResizable WindowsDrag-and-dropan interior border to resize the windows on either side.Double-clickan interior border to enterResize Mode.scroll-wheelandarrowsmove the border.click,enterorescto exit.ScoreboardSingle-clickuser to highlight and follow.Double-clickuser to kick as cheater.Triple-clickuser to kick as racist.F7to change sort column.Log Filestf2monwrites plaintext messages tofileno(2), and
colorized messages tofileno(3), when open to a regular file.$ tf2mon 2>x 3>yGeneral options-h, --help          Show this help message and exit.
-v, --verbose       `-v` for detailed output and `-vv` for more detailed.
-V, --version       Print version number and exit.
--config FILE       Use config `FILE` (default: `~/.tf2mon.toml`).
--print-config      Print effective config and exit.
--print-url         Print project url and exit.
--completion [SHELL]
                    Print completion scripts for `SHELL` and exit
                    (default: `bash`).