williamsjokvist / cfn-tracker

Track the live ranked match data of any Street Fighter 6 player

CFN Tracker

Track any Street Fighter 6 or V CFN profile's live matches.
Check the website to get started.

Features

• Real-time match tracking

• Storing match logs and statistics

• Support for displaying live stats to OBS via Browser Source and Text Labels

• Support for both SF6 and SFV

• Ability to create own OBS Browser theme with CSS

  Streamer showcase

Contributing

Contributions are welcome, take a look at the issues or open one yourself!

Setting up development environment

1. Install dependencies

   • Wails
   • Task - optional, but recommended
   • Bun - mac/linux only, optional

2. Create a .env in the project's root based on example.env

3. Run task --list to view the list of commands

cfn-tracker's Issues

Implement force poll button

Create an interrupt handler which forces a poll when user has prompted it, maybe this should also have a cooldown

Improve landing page

Improve the style of https://cfn.williamsjokvist.se/ to make it look more modern

Improve UX when failing to start go-rod browser

Right now the program the panics and the user is left wondering what the hell happened. Maybe could keep the program open but display and error or something similar. Could also be useful to look into how we can get a hold of some logs.

Make it possible to remove, backup and restore save data

Make it possible to remove, backup and restore save data through the app GUI

Refactor SF6 authenticate function to not include a bunch of "dry" checks

Right now the sf6.Authenticate if filled with a bunch of if !dry checks that also include dependency on wails. Possible solution is to use a channel to send back update and let the caller decide what they want to do.

Set up release flow

Set up goreleaser so we don't have to manually make releases. The website should also be made to always point to the latest release's download link

Steam CAPTCHA

When the program has been re-executed many times from the same IP, Steam will prompt for a CAPTCHA on log in.

One way to solve this could be for the bot to relaunch itself in a non headless window - with image GET requests enabled - so the user can solve it

I'm not sure how much this will impact regular users since the Chromium instance will cache the log in for some time. It is probably mostly an issue in development when failing login attempts a bunch.

Fix authentication tests

Currently the Authentication tests are failing due to errors connecting to the browser.

One way to possibly solve this is to connect to the browser inTestMain instead of in each test

Code signing for Windows and Mac

Investigate how we can sign the Windows and Mac releases. If we do this, we can also use UPX to compress the executable without causing virus warnings.

https://wails.io/docs/guides/signing/

Restore session toggle present when no user selected

Steps to reproduce:

1. Track using a new user
2. Get some games in
3. Stop tracking -> no user selected and the restore session toggle visible

Revamp match log / statistics

Rethink match log to display overall session stats as well as matches for that session

Windows installer "Not Found"

https://github.com/williamsjokvist/cfn-tracker/releases/download/v4.0.0/CFN_Tracker_Windows.zip

Not Found

CFN Tracker stuck on loading

Never prompted to add any username, just stuck with a spinning circle forever.

Also track casual, battle hub, and custom room matches

Right now we are only able to track ranked matches. It would be nice if the Session contains all the matches regardless of type that was played

Restore last session option when no last session exists for that player

When selecting player chips the option to restore last session is available.
Trying to start tracking after selecting to restore session (when no session exists) causes the error message "CFN does not exist"

Expected behavior is to not allow option to restore session when one does not exist.

l think this is because players are saved in database even though no sessions were saved for them.

Convert all/relevant errors to tracking errors

Flow for error propagation to front end is completed but requires errors to have status codes attached to them.

Align SF5 tracker with SF6 makeovers

The SF5 part of the codebase needs to be aligned with the SF6 part. SF5 tracker still relies on TrackingState for updates, and isn't integrated with the storage layer yet.

It also needs to be live tested, it might not work anymore

Rounds win/loss weight

Would be cool to also display how strongly the player has been winning/losing their matches.
For example you could be winning by 2-0 which could be seen as strong win, and 2-1 as less strong.

Add bug report functionality

Now that we log to file we should add a report bug feature

Ideally this would be a form that sends an email to the maintainers of the repo

Create e2e tests

Maybe:

• Set up cypress for UI tests
• Set up testcontainers for mysql container instance

We would favor e2e tests over unit tests to make the codebase more maintainable

Self-updating client

Currently the client lets the user know that there is an update, and links to the download page. Instead the client could update itself sparing the user of having to do this, especially if there's an update that the user must download.

Implement db migration to prevent loss of data when updating client

Right now when we make changes to the database we need to delete all the data. This is annoying for users who, when we have made changes to storage code, we need to delete their DB when updating the client.

One option to address this is to use Journey for db migrations

Migrate to go 1.22

Take advantage of the net/http improvements to clean up the browser source code, and wherever else there can be improvements

Wrap SF6 auth function in a restore to prevent crash.

Right now sf6.Authenticate contains a bunch of "Must" function calls from go-rod. It would be annoying to add error checking for every single line. Could instead wrap the function in a restore and return an error that way.

Improve development on windows

Right now contributors on windows systems must manually change wails.json, tsconfig.json, and package.json and a few others. This is because Bun isn't available on windows. Switching between branches also require push and apply from stash all the time. Would be nice without have these extra steps.

Add support for tekken 8

User should be able to enter player name in addition to user code

It's a pain to have to lookup a player's user code every time you want to track even if it's your own. User codes are not as easily remember.

Should also present near matches.

Rethink error propogation to frontend

Right now we only provide the internal error message to the frontend. We should extend the error interface with an error code so the frontend can display the error in different languages

Error logging in Sentry

Implement backoff polling algorithm for more immediate response

Create some sort of backoff algorithm for the polling, so that match events are more immediate. We can also decrease the total number of polls this way by increasing the poll wait time after a new match has been recorded.

Have separate state machine for pre and post game select states

The state machine for the front-end is becoming quite unwieldy. It is recommended by xstate to use services to break up into smaller state machines that communicate with each other.

We can have a state machine for the game picking process and one for tracking/cfn picking process. They are logically separate and only connected by a single point.