Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 2.75 KB

README.md

File metadata and controls

46 lines (29 loc) · 2.75 KB
Raw

Steam API Parser for TF2 Statistics

This project uses the Steam Web API to fetch your TF2 player statistics, like the ones you are already able to view on Steam, however, it also includes some hidden statistics that you don't have easy access to, such as your playtime for each class in Mann vs. Machine (and many others like total damage dealt for each class!) or your total playtime on a number of official maps such as plr_hightower, pl_upward, etc.

Be aware that achievement stats stop counting once you have met the requirements for obtaining the achievement the stat pertains to.

Sample output

Usage

Requirements:

  • A SteamID64 which looks like this: 76561198076611413
    • You can find yours using sites like SteamID I/O
    • The Steam profile needs to have its "Game details" privacy setting set to public for the API to work!
  • A Steam API key for your account which you can find (or generate if you do not have one) on this Steam page
    • DO NOT SHARE your API key with anybody!

Once you have a Steam ID and an API key, you may either run the program via the command line/terminal and use your Steam ID and API key as program arguments (i.e. $ tf-steam-api-parser steamid64 apikey) or you can just open it without specifying any arguments and it should manually ask you for your Steam ID and API key.

When it is done fetching the data and parsing it (it should be near instant), the output will be a Markdown file called stats.md which contains all TF2 statistics for the Steam account.

Binaries (Windows, Linux)

You can find precompiled binaries by going to the Actions tab on GitHub, selecting the latest successful run for your platform and downloading the artifact.

Build (Linux)

Requirements:

  • CMake (pacman -S cmake)
  • Conan (yay -S conan)
  • Clang (or GCC, but untested) (pacman -S clang)

Clone the repository:

git clone https://github.com/Hat-Kid/tf-steam-api-parser.git

Set up Conan if you haven't already:

  • Create a new default profile: conan profile new default --detect
    • (If using GCC, additionally set compiler.libcxx to the C++11 standard with the following command: conan profile update settings.compiler.libcxx=libstc++11 default)
  • Open a terminal in the repository root and install the dependencies: conan install . -s build_type=Release --install-folder=build
    • If you get an error about missing packages, you may have to manually build these dependencies for your particular platform by adding --build missing to the previous command
  • Set up CMake: cmake -B build -DCMAKE_BUILD_TYPE=Release
  • Build: cmake --build build --config Release