Skip to content

Latest commit

 

History

History
117 lines (85 loc) · 5.51 KB

README.md

File metadata and controls

117 lines (85 loc) · 5.51 KB
Raw

TekkenLearningPlatform

Keeps track of your matches and provides statistics to help you improve as a player

Currently not functional! As of the newest update Ver. 5.00 the memory addresses are no longer correct and have to be updated. I am open to pull requests but I will not be fixing this myself anytime soon.

Last commit Issues License

View Demo · Report Bug


Table of Contents

About the Project

TekkenLearningPlatform keeps track of your matches and provides statistics to help you improve as a player. Optionally, it can also record your matches and automatically upload them to YouTube.

Features

  • Detects when you enter and exit matches
    • Automatically start recording to video when you enter a match
    • Automatically pause recording when you exit a match
    • Match results are saved
  • A web application that shows you key performance metrics for your characters
    • Statistics for certain matchups and stages
    • A list of your most played opponents (rivals) and how you perform against them
    • A match history allowing you to check details for every single match you played and watch your recording
  • Automatically uploads your recordings to your YouTube channel
  • Individual featues can be turned on/off

Planned Features

  • Queue up video uploads and wait until the game is closed to do so
  • Improve YouTube video metadata for uploaded recordings
  • Handle cleanup when the recorder process is exited manually
  • Improve learning capabilities
    • Improve display of input notations in the recording
    • Add frame data to the recording
    • Add missed punishment opportunities to the recording
    • Add additional statistics to matches
      • Moves you get hit most often by
      • Moves that you failed to punish most often
      • Your most used moves and whether they hit or whiffed or were punished
  • Add pagination to match history (currently limited the latest 10 games)

Known Bugs and Limitations

  • If you close the recorder process, it will not stop any active recordings or upload them
  • Matches ending prematurely e.g. due to disconnects are not detected properly
  • Videos are uploaded to YouTube during gameplay which may result in a bad connection

Screenshots

Dashboard

Character Statistics

Match History

Match Details

Rivals

Great, how do I use it?

TL;DR: Download latest tlp_win64.zip, unpack it, start up Tekken 7, then doubleclick start_all.bat.

Please refer to the installation instructions for advanced use cases.

Development

The project is split into two modules:

  • tlp-recorder (Node.js/TypeScript): reads Tekken's process memory, keeps track of matches played and optionally communicates with OBS Studio to automatically create video recordings.
  • tlp-webapp (Next.js/React/TypeScript): Starts a web application allowing you to view your statistics.

Prerequisites

  • Node.js v16.x.x (current LTS version)
  • Yarn (npm install -g yarn)
  • To record videos, you need OBS Studio, using either
    • OBS Studio 27.2.0 or above with the obs-websocket plugin installed
    • OBS Studio 28.0.0 or above which includes this plugin by default

Setup

Please refer to Development environment setup

License

Source code is distributed under the GNU GPLv3 License. See LICENSE.txt for more information.

Contributing

Contributions are very welcome and much needed! As it is, the project is very barebones but functional.

If you'd like to collaborate, you can find me (Sταrs) on the Modding Zaibatsu Discord.

Acknowledgements

Huge thanks to Kulagin for teaching me how to use CheatEngine and providing guidance.