Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/circleguard/circleguard
An osu! replay analysis program
https://github.com/circleguard/circleguard
gui osu
Last synced: about 2 months ago
JSON representation
An osu! replay analysis program
- Host: GitHub
- URL: https://github.com/circleguard/circleguard
- Owner: circleguard
- License: agpl-3.0
- Created: 2019-03-22T02:24:33.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-18T23:01:54.000Z (about 1 year ago)
- Last Synced: 2023-10-18T23:24:38.201Z (about 1 year ago)
- Topics: gui, osu
- Language: Python
- Homepage:
- Size: 131 MB
- Stars: 123
- Watchers: 2
- Forks: 6
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/circleguard/circleguard/releases/latest)
[](https://github.com/circleguard/circleguard/releases/latest)
[](https://discord.gg/e84qxkQ)
# Circleguard
Circleguard is a tool to help you analyze osu! replays. Either your own, or replays from someone you suspect is cheating. Features:
* A replay viewer, with
* A ur bar
* Judgment indicators (green dots for 100s, blue dots for 50s, red dots for misses)
* Ability to speed up and slow down playback speed
* Ability to jump to any point in the replay
* Frame by frame movement
* Cheat detection
* Similarity (for replay stealing)
* Unstable rate (for relax)
* Suspicious movements called snaps (for aim correction)
* Frametime (for timewarp)
* Raw replay data (time, position, and keys pressed for each frame) in a nicely formatted table
If you're only interested in using circleguard to analyze your own replays, to (eg) figure out why you missed a note or to be able to quickly jump to any point in time in a replay, don't be scared off by the talk of cheat detection above. When you open circleguard, [simply click the "Visualization" panel](https://i.imgur.com/Gg9ohbP.png) to easily visualize one of your replays. Circleguard is fully fledged as a replay analysis tool as well as a cheat detection tool.
[*(click here to view a high quality version)*](https://streamable.com/9bkq8z)
[*(click here to view a high quality version)*](https://streamable.com/0z0bw4)
Circleguard is developed and maintained by:
* [tybug](https://github.com/tybug)
With contributions from:
* [samuelhklumpers](https://github.com/samuelhklumpers)
* [InvisibleSymbol](https://github.com/InvisibleSymbol)
## Download
The latest version of circleguard can be found here: . 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 it is distributed as a zip and you can run Circleguard.vbs (found inside the zip) in place of an exe.
If you are on another OS such as Linux, you will have to build circleguard yourself. See [Building From Source](#building-from-source).
There is an introduction / tutorial to using circleguard when you first open it. If you have any questions, feel free to ask on [the discord](https://discord.gg/VNnkTjm).
## Building From Source
The gui is bundled into a single program using [pyinstaller](https://pyinstaller.readthedocs.io/en/stable/). You'll need to install pyinstaller, download the source code of this repository, and read the pyinstaller [documentation for your specific platform](https://pyinstaller.readthedocs.io/en/stable/requirements.html). You may find that further tweaking is required depending on your platform. If you run into trouble, I'll do my best to assist you if you ask in [the discord](https://discord.gg/VNnkTjm).
If you are building for windows or mac, there are premade specfiles in the root directory for easy building. Run `pyinstaller path-to-specfile` to generate an app for your platform as an alternative to using pyinstaller options. For instance, `pyinstaller gui_win_x64.spec` for 64-bit windows.
## Running Locally
To run circleguard locally, you'll need to have [git](https://git-scm.com/downloads) and [python3.10+](https://www.python.org/downloads/) installed. After installing them, run the following:
```bash
git clone https://github.com/circleguard/circleguard.git
cd circleguard
pip install -r requirements.txt
python circleguard/main.py
# you might have to use python3 instead, eg python3 circleguard/main.py
```
## Contributing
Join [our discord](https://discord.gg/VNnkTjm) and ask how you can help, or look around for open issues which interest you and tackle those. Pull requests are welcome!
## Links
Discord:
### Circlecore
Circlecore does most of the heavy lifting for circleguard, such as calculating ur, similarity, frametimes, etc. If you would like to use circlecore in your own project, please see the developer guidance over at its repository:
### Circlevis
The replay viewer is powerful enough that it was split off into its own repository. If you would like to use the replay viewer in your own project, please see the developer guidance over at its repository:
## Credits
Thanks to [Accalix](https://twitter.com/Accalix_) for creating circleguard's logo.