Features • Download • Usage • Building • Contributing • Credits • License
- Simple to use
- Shows the stats of other players in your game almost instantly
- Avoid nicked and sweaty players
- Shows stats for BedWars and Mini Walls
- Highly customizable
- Custom screen size, opacity, background color, scale, font, etc.
- Built in fake full-screen support
- Configurable game-mode to display
- Supports most clients
- Very low CPU and memory usage
- Written in native C++
- Open source
You can download the latest release of this Stats Overlay for Windows. Other platforms are currently not supported yet.
To run this program, you will need to first download the latest release.
Then, extract the zip folder and run Overlay.exe. This will create a file called config.json inside the assets folder. Close the overlay (x button) and open the JSON config file using any text editor (ex. Notepad). Modify the config.json file accordingly by filling in the values (api key, log file path, etc.), save it and reopen Overlay.exe. The modifications you have made should take effect immediately.
If you'd like to build this project from source, you can follow the process shown below.
- Install MinGW and git.
- Add the MinGW
bindirectory to your system environment variables. - Get the following libraries: SDL, SDL_ttf, SDL_image, JSON, cpr, spdlog, fmt.
- Clone this GitHub repository.
> git clone https://github.com/sbplat/Stats-Overlay.git
- Navigate to the cloned repository, open the
resfolder and runcompile.batto compile the resource script. - Compile this project with
mingw32-make.
> mingw32-make [debug/release]
- If the build succeeds, there should be an executable called
Overlay.exewhich is the compiled Stats Overlay!
All feedback, issues and PRs are welcome!
This project uses the following open source libraries:
This project is licensed under the MIT license.