Metadata-Version: 2.1
Name: tf2mon
Version: 1.0.17
Summary: Team Fortress 2 Console Monitor
License: MIT
Keywords: tf2,team-fortress-2,steam,valve,bots,cathook
Author-email: Russel Lane <russel@rlane.com>
Requires-Python: >=3.8
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Games/Entertainment :: First Person Shooters
Project-URL: Homepage, https://github.com/russellane/tf2mon
Description-Content-Type: text/markdown
Description: ### tf2mon - Team Fortress 2 Console Monitor
        
        #### Usage
            tf2mon [--rewind | --no-rewind] [--follow | --no-follow]
                   [--tf2-install-dir DIR] [--list-con-logfile]
                   [--trunc-con-logfile] [--clean-con-logfile] [--single-step]
                   [--break LINENO] [--search PATTERN] [--inject-cmd LINENO:CMD]
                   [--inject-file FILE] [--players FILE] [--hackers-base FILE]
                   [--hackers-local FILE] [--print-steamid STEAMID] [-h] [-v] [-V]
                   [--config FILE] [--print-config] [--print-url]
                   [con_logfile]
            
        Team Fortress II (`TF2`) Console Monitor (`tf2mon`) is an interactive
        terminal application that displays real-time game state and player
        statistics of an actively running TF2 game.
        
        `tf2mon` recognizes and tracks `cathook-bots`, and provides both
        application and in-game key-bindings to quickly `CALLVOTE KICK`
        hackers, mark players as racist, suspect, etc.
        
        `tf2mon` reads TF2's console logfile (`con_logfile`), creates action
        scripts in TF2's `cfg` directory, and binds keys for the gamer to press
        in-game to take those actions; such as issue `SAY` and `CALLVOTE KICK`
        commands.
        
        Other in-game key-bindings format `CHAT` messages that include the
        name, K/D Ratio and duel-score with the player's last victim or killer.
        
        By default, `tf2mon` starts reading the console logfile from its end
        (`--no-rewind`), and continues to `--follow` it until interrupted.
        
        #### Positional Arguments
            con_logfile         Tf2 console logfile (default: `console.log`).
        
        #### Options
            --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`).
            --tf2-install-dir DIR
                                Tf2 installation directory (default: `~/tf2`).
            --list-con-logfile  Show tf2 console logfile path and exit.
            --trunc-con-logfile
                                Truncate tf2 console logfile and exit.
            --clean-con-logfile
                                Filter-out excluded lines from tf2 console logfile to
                                stdout and exit.
        
        #### Debugging options
            --single-step       Begin single-stepping at startup.
            --break LINENO      Single-step when logfile reaches `LINENO`.
            --search PATTERN    Single-step logfile line matches `PATTERN`; add `/i`
                                to ignore case.
            --inject-cmd LINENO:CMD
                                Inject `CMD` into logfile before `LINENO`.
            --inject-file FILE  Read list of inject commands from `FILE`.
        
        #### Database options
            --players FILE      Cache `steam` user data (default:
                                `~/.cache/tf2mon/steamplayers.db`).
            --hackers-base FILE
                                Upstream hackers database (default:
                                `~/.cache/tf2mon/playerlist.milenko-list.json`).
            --hackers-local FILE
                                Local hackers database (default:
                                `~/.cache/tf2mon/playerlist.tf2mon-list.json`).
            --print-steamid STEAMID
                                Print `ISteamUser.GetPlayerSummaries` for `STEAMID`
                                and exit.
        
        #### Configuration file
          The configuration file (see `--config FILE` below) defines local
          settings:
          
              [`tf2mon`]
          
              tf2_install_dir = "/path/to/your/tf2/installation"
              webapi_key = "your-steamworks-webapi-key"
              player_name = "Your Name"
        
        #### In-Game Controls, Numpad
          While playing TF2, gamer uses the `numpad` to perform actions, such as
          kicking a cheater, or taunting the last victim with a `chat` message
          customized with his name, k/d ratio and the duel-score with him.
          
          Messages are placed into queues, and may be popped off either end.
          
              Queues -->    Kicks     Admin     Spams
                              |         |         |
                              v         v         v
                         +-----------------------------+
              last/      |         |         |         |
              newest --> |   pop   |  pull   |   pop   |
                         |         |         |         |
                         |---------+---------+---------|
                         |         |         |         |
                         |  clear  |  clear  |  clear  |
                         |         |  both   |         |
                         |---------+---------+---------|
              first/     |         |         |         |
              oldest --> | popleft |  push   | popleft |
                         |         |         |         |
                         +-----------------------------+
          
          To vet any new players that have joined the game, gamer must press
          `NUMPAD-DOWNARROW` in-game. The monitor indicates when new players have
          arrived and that key should be pressed; or press it each time you die.
          
          When detected, `tf2mon` pushes hackers onto the `Kicks` queue, and
          alerts the gamer, who may then press `NUMPAD-HOME` to issue `CHAT` and
          `CALLVOTE KICK` commands.
          
          When gamer kills an opponent, `tf2mon` pushes a `taunt` onto the
          `Spams` queue; on death, a `gurgle`. Enable/disable with `F3`.
          
          The monitor can only push actions onto the queues; the gamer must pop
          them for the action to be taken, or clear the queue to discard.
        
        #### Function Keys
          These function keys are available in-game and in the monitor:
          
              F1=HELP                 Display help.
              F2=TOGGLE-DEBUG         Control `say` vs `echo`.
              F3=TOGGLE-TAUNT         Enable taunts and gurgles.
              F4=TOGGLE-KD            Include kd-ratio in messages.
              F5=TOGGLE-USER-PANEL    Control contents of the user panel;
                                      USER=show duels, weapons, captures, etc.
                                      SPAMS=show SPAMS queue.
              F6=SWITCH-MY-TEAM       Join other team.
              F7=TOGGLE-SORT          Change scoreboard sort column.
              F8=TOGGLE-LOG-LOCATION  Various logger formats.
              KP_DEL=SINGLE-STEP      Start single-stepping.
              [=KICK-LAST-CHEATER     Kick last killer as cheater.
              ]=KICK-LAST-RACIST      Kick last killer as racist.
              \=KICK-LAST-SUSPECT    Mark last killer as suspect.
        
        #### Where to Operate
          `tf2mon` works by reading the console logfile to which `TF2` logs
          messages during the game. `tf2mon` can either `tail -f` an active
          game, or `--rewind` and replay saved logfiles.
          
              `Duel monitors`
                  Run `tf2mon` on a secondary monitor, while playing the game on
                  the primary monitor. Best performance, but a pain to `Alt-Tab`
                  between monitor and game.
          
              `Duel machines, ssh`
                  ssh from another machine and run.
          
              `Duel machines, nfs`
                  cross-mount TF2's directory to another box and run from there.
        
        #### Terminal Size
          `tf2mon` requires a large terminal. Maximize the window, and use keys
          (maybe `Ctrl-Minus` and `Shift-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/location
        
        #### Resizable Windows
          `Drag-and-drop` an interior border to resize the windows on either side.
          
          `Double-click` an interior border to enter `Resize Mode`.
              `scroll-wheel` and `arrows` move the border.
              `click`, `enter` or `esc` to exit.
        
        #### Scoreboard
          `Single-click` user to highlight and follow.
          `Double-click` user to kick as cheater.
          `Triple-click` user to kick as racist.
        
        #### General 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.

