Circleguard is a player made and maintained cheat detection tool for osu!. We support investigating for Replay Stealing, Remodding, Relax, and Aim Correction, but Circleguard can also be used as an all-purpose replay viewer.
Circleguard is the frontend gui, which runs circlecore behind the scenes. If you're looking to integrate circlecore into your own project, you can find more about it at its repository.
If you would like to contribute to circleguard, see Contributing below.
Circleguard is developed and maintained by:
With contributions from:
- Watch The Circles
The latest version of circleguard can be found here: https://github.com/circleguard/circleguard/releases/latest. Download the appropriate binary for your OS - circleguard_win_x64.zip or circleguard_win_x86.zip for Windows, and circleguard_osx.app.zip for Mac OS. Circleguard was previously bundled as an exe for Windows but opened unbearably slowly, so we distribute it as a zip and you can run Circleguard.lnk (found inside the zip) in place of an exe. If you are on another OS such as Linux, you will have to build the app yourself. See Building From Source.
If you don't trust the downloaded binary, you are more than welcome to build from source yourself. You can validate that the code never sends your api key anywhere by looking at the code in the circleguard and circlecore repositories.
There is a short introduction to the program when you first open it. Everything should be relatively self-explanatory, and if you have any questions, feel free to ask on our discord.
The gui is bundled into a single program using pyinstaller. You will need to download the source code of this repository and read the pyinstaller documentation for your specific platform - the OS may not be supported, or you may need to install some package for it to work. Run pyinstaller on main.py with the --one-file option to generate an executable. You may find that further tweaking is required depending on your platform - I'm afraid that our journey together ends there, and you must forge ahead on your own. We will do our best to assist you if you ask us in our discord.
If you are building for windows or mac, we provide premade specfiles for easy building. You can run pyinstaller path-to-specfile to generate an app for your platform as an alternative to using pyinstaller options.
If you would like to contribute to Circleguard, join our discord and ask what you can help with, or take a look at the open issues for circleguard and circlecore. We're happy to work with you if you have any questions!
You can also help out by opening issues for bugs or feature requests, which helps us and others keep track of what needs to be done next.
- Discord: https://discord.gg/VNnkTjm
- Circlecore: https://github.com/circleguard/circlecore
Thanks to kszlim, whose replay parser formed the basis of circleparse.
Thanks to Accalix for creating our logo. You can check out more of his work here.