Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Latest commit

 

History

History
255 lines (229 loc) · 8.5 KB

README.md

File metadata and controls

255 lines (229 loc) · 8.5 KB
Raw

ARCHIVED - ARCHIVED - ARCHIVED

This repo has been archived in favor of TMT2.

TMT - TournamentMatchTracker

TMT is a tool that tracks/watches/observes a Counter-Strike: Global Offensive match.

It is a full command line backend application with no front end. It is designed to be integrated in some other kind of management system (content management system,tournament system, other website front end, ...).

How does it work?

  • Start:
    • Open TCP socket (used for managing the TMT itself).
    • Open UDP socket (used for receiving log data from the gameservers).
  • Endless loop:
    • TCP part:
      • Waiting for incoming tcp connections and read incoming data.
      • Either drop the request if it is not valid (an error message will be returned) or perform it. One of the following:
        • Initialize a new match to watch.
          During the match initialization a (TCP) rcon connection will be setup. It will be used to tell the gameserver to send its log data (round scores and chat messages) via udp to the TMT instance.
        • Abort a match observation.
        • Status request.
    • UDP part:
      • Check incoming udp packets to know what happened on the server:
        • Round ends and current score.
        • Chat messages.
      • React to the log data:
        • Send rcon commands.
        • Post data to a webserver via HTTP.

FEATURES

  • Standalone PHP command line application (no webserver is required).
  • One TMT instance is able to watch unlimited gameservers.
  • Ingame commands via chat.
  • Complete server management - no player needs the rcon password.
  • Map election process: Teams ban the maps ingame or agree on one.
  • Warmup on the match map.
  • Knife for side: Let the winner decide where to start.
  • Live reporting: Send match data to a webserver.
  • Overtime support

REQUIREMENTS

  • PHP > 5.4.0
  • PHP-JSON
  • PHP-OPENSSL
  • write access to own folder (for logging to ./tmt.log)

START

Linux

Using the defaults:

./tmt.php

Full example with all parameters:

./tmt.php --udp-port 9999 --udp-ip 192.168.0.13 --udp-log-ip 109.110.111.112 --tcp-port 9999 --tcp-ip 192.168.0.13 --token somesecurity --say-prefix "[BOT] "

Windows

Using the defaults:

X:\path\to\php\php.exe -f tmt.php

Full example with all parameters:

X:\path\to\php\php.exe -f tmt.php -- --udp-port 9999 --udp-ip 192.168.0.13 --udp-log-ip 109.110.111.112 --tcp-port 9999 --tcp-ip 192.168.0.13 --token somesecurity --say-prefix "[BOT] "

Watch out for the additional -- which seperates php.exe's command line options from the TMT's command line options.

COMMAND LINE OPTIONS

  • --udp-port: Port (udp) that is used to receive logging data from gameserver.
  • --udp-ip: IP address for binding the udp socket. (May be a local IP behind router/firewall/NAT).
  • --udp-log-ip: IP address to that gameserver will send the logging data. (May be a public IP.)
  • --tcp-port: Port (tcp) that is used to receive init data for a match.
  • --tcp-ip: IP address for binding the tcp socket. (May be a local IP behind router/firewall/NAT).
  • --token: String that has to be the same as in the json init data to accept the job.
  • --say-prefix: String that is prefixed in front of every say message.

If a specific argument is not defined, it will default to:

  • --udp-port: 9999
  • --udp-ip: 0.0.0.0 (listen on all ips/devices)
  • --udp-log-ip: gethostbyname(gethostname()) (Not reliable!)
  • --tcp-port: 9999
  • --tcp-ip: 0.0.0.0 (listen on all ips/devices)
  • --token: "" (empty string)
  • --say-prefix: "[TMT] "

MATCH INIT

The following is an example how to init a match. It must be sent to the script using the tcp socket.

{
    "token": "somesecurity",
    "map_pool": [
            "de_dust2",
            "de_train",
            "de_overpass",
            "de_inferno",
            "de_cache",
            "de_mirage",
            "de_cbble"],
    "default_map": "de_dust2",
    "match_id": 1337,
    "team1": {
            "id": 13,
            "name": "Team NixMacher"},
    "team2": {
            "id": 37,
            "name": "Bobs Bau-Verein"},
    "ip": "10.22.33.44",
    "port": 27500,
    "rcon": "rcon_password",
    "pickmode": "bo1random",
    "url": "https://www.example.org/api/csgo.php?token=abcdefg",
    "match_end": "kick",
    "rcon_init": [
        "hostname \"MATCH: Team NixMacher vs. Bobs Bau-Verein\"",
        "sv_password strenggeheim"
    ],
    "rcon_config": [
        "mp_autokick 0",
        "mp_autoteambalance 0;mp_buytime 15"
    ],
    "rcon_end": [
        "hostname \"empty server\"",
        "sv_password nochgeheimer"
    ]
}

Notes:

  • token: (string) kind of password that has to match the command line parameter
  • match_id: (int) must be unique within the TMT instance, otherwise it will first abort the other match before initializing the new match
  • map_pool: array of strings
  • pickmode: (string) default_map, agree, bo1, bo1random or bo1randomagree (the last will offer both the !veto and the !map commands)
  • match_end: (string) kick (kick all players 20 seconds after match end), quit (server shutdown 20 seconds after match end) or none
  • rcon_init: array of strings, rcon commands will be executed once after the rcon connection is established, each entry must be shorter than 4000 chars
  • rcon_config: array of strings, rcon commands will be executed twice (before knife round and before match start), each entry must be shorter than 4000 chars
  • rcon_end: array of strings, rcon commands will be executed 20 seconds after match end (right before match_end action), each entry must be shorter than 4000 chars

REPORTS

The tool will report events to the url (if given in the init data):

  • elected map (won't be sent if pickmode is default_map)
$_POST['match_id'] = 1337;
$_POST['type'] = 'map';
$_POST['map'] = 'de_mirage';
  • match start (when the knife round winner has chosen a side)
$_POST['match_id'] = 1337;
$_POST['type'] = 'start';
  • livescore (after every round)
$_POST['match_id'] = 1337;
$_POST['type'] = 'livescore';
$_POST['team1id'] = 13;
$_POST['team1score'] = 16;
$_POST['team2id'] = 37;
$_POST['team2score'] = 12;
  • score after match end
$_POST['match_id'] = 1337;
$_POST['type'] = 'end';
$_POST['team1id'] = 13;
$_POST['team1score'] = 16;
$_POST['team2id'] = 37;
$_POST['team2score'] = 12;

MATCH ABORT

The following is an example how to abort a match. It must be sent to the script using the tcp socket.

{
    "token": "somesecurity",
    "match_id": 1337,
    "abort_match": true
}

Aborting the match means stopping the gameserver sending log data to the udp socket and deleting the internal match.

STATUS REQUEST

{
    "token": "somesecurity",
    "action": "status_request"
}

This immediately sends back a json containing some status information (over the same tcp connection). Example:

{
    "match_count": 1,
    "matches": [
        {
            "id": 1337,
            "status": "MATCH",
            "map": "de_dust2",
            "lastcontact_timestamp": 1495449716,
            "lastcontact_seconds": 31,
            "team1": {
                "id": 37,
                "name": "Cola",
                "score": 2},
            "team2": {
                "id": 13,
                "name": "Fanta",
                "score": 0}
        }
    ]
}

Notes:

  • status: (string) MAP_ELECTION, MAP_CHANGE, WARMUP, KNIFE, AFTER_KNIFE, MATCH, END or PAUSE
  • map: (string) the map on which the match will be played (empty string until map election process is over)
  • lastcontact_timestamp: (int) the point of time (unix timestamp) with the last successful contact to the gameserver (either udp log packet or rcon command)
  • lastcontact_seconds: (int) same as previous, but in seconds (time() - lastcontact_timestamp)

USER COMMANDS (INGAME)

While beeing ingame on a tracked server the following commands are available. Keep in mind that a few commands are just aliases and will do the same as other commands. Furthermore a command can be prefixed either by the ! or the . character.

  • During the map election if pickmode is agree:
    • !map, !vote, !pick
  • During the map election if pickmode is bo1 or bo1random:
    • !veto, !ban
  • During the map election if pickmode is bo1randomagree:
    • !map, !vote, !pick, !veto, !ban
  • During warmup:
    • !ready, !rdy, !unready, !unrdy
  • For the winning team after the knife round:
    • !stay, !switch, !swap, !ct, !t
  • During the match:
    • !pause
  • While the match is paused:
    • !ready, !rdy, !unready, !unrdy, !unpause