View stats of players in the current game of Company of Heroes 3.

1. Make sure you have used the Coh3 Stats Desktop App once and it displayed stats of players in your game
2. Start OBS
3. In OBS Sources section click on "Add Source"
4. Select Browser
   
5. Create a new Browser Source with any name you want
   
6. In the browser properties select local file
   
7. In the Coh3 Stats Desktop App go into settings
   
8. Copy the path to the streamerOverlay.html
   
9. In the OBS properties window click on browse to set the path to the streamerOverlay.html
   
10. An explorer window opens. Paste the copied path into the path field and hit enter
    
11. Select the streamerOverlay.html file and click open
    
12. Set the resolution to the same resolution Coh3 is running at. E.G 1920 Width and 1080 Height
    
13. Click Ok to finish creating the source
    
14. Scale the source to match the Coh3 source size

Install rust on your system using rustup https://www.rust-lang.org/tools/install

Install all dependecies with:

yarn install

To start the development build with hot reload run:

yarn tauri dev

The first execution takes a bit longer as the rust libraries have to be compiled once. Any future restarts will be much faster!

To build the app and an installer run:

yarn tauri build

The build output can be found in src-tauri/target/release. The installer can be found in src-tauri/target/release/bundle/msi.

The frontend is run on the OS native web renderer. This frontend is build with Vite + React + Typescript. The frontend related files are at the root level of the project with the React components in the src folder.

The backend wrapping the frontend code is created with Rust + Tauri. The code can be found in the src-tauri folder.

The main configuration file of the app is in src-tauri/tauri.conf.json.