Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

A player made and maintained cheat detection tool for osu!. Provides support for detecting replay stealing, remodding, relax, and aim correction from a profile, map, or set of osr files.

Project description

logo

PyPi version CodeFactor

Circlecore

Circlecore is a utilities library for osu!. Features include:

  • Unstable Rate calculation
  • Hits calculation (all places where a player hit a hitobject)
  • Similarity calculation between two replays, for replay stealing detection
  • Frametime calculation, for timewarp detection
  • Jerky, suspicious movement detection (called Snaps)

Circlecore is used by Circleguard, a replay analysis tool.

Circlecore is developed and maintained by:

Installation

Circlecore can be installed from pip:

pip install circleguard

This documentation refers to the project as circlecore to differentiate it from our organization Circleguard and the replay analysis tool Circleguard. However, circlecore is installed from pypi with the name circleguard, and is imported as such in code (import circleguard).

Links

Github: https://github.com/circleguard/circlecore
Documentation: https://circleguard.github.io/circlecore/
Discord: https://discord.gg/VNnkTjm

Usage

We have a full tutorial and documentation at https://circleguard.github.io/circlecore/. If you really want to jump right in, below is a quickstart guide:

from circleguard import *

# replace "key" with your api key
cg = Circleguard("key")
# replay on http://osu.ppy.sh/b/221777 by http://osu.ppy.sh/u/2757689
replay = ReplayMap(221777, 2757689)

print(cg.ur(replay)) # unstable rate
print(cg.frametime(replay)) # average frametime
print(cg.frametimes(replay)) # full frametime list
print(cg.hits(replay)) # where the replay hits hitobjects
print(cg.snaps(replay)) # any jerky/suspicious movement

replay2 = ReplayMap(221777, 4196808)
print(cg.similarity(replay, replay2)) # how similar the replays are

# ReplayMap isn't the only way to represent replays; we can also
# get a beatmap's top 3 plays
map_ = cg.Map(221777, span="1-3")
# or a User's fifteenth and twentieth best plays
user = cg.User(124493, span="15, 20")
# or a local replay
replay3 = ReplayPath("/path/to/local/osr/replay.osr")
# and more. You can find them all at
# https://circleguard.github.io/circlecore/appendix.html#circleguard.loadables.Loadable

# maps and users can be iterated over
for r in map_:
    print(cg.ur(r))

Contributing

Join our discord and ask how you can help, or look around for open issues which interest you and tackle those. Pull requests are welcome!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for circleguard, version 5.0.1
Filename, size File type Python version Upload date Hashes
Filename, size circleguard-5.0.1-py3-none-any.whl (68.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size circleguard-5.0.1.tar.gz (49.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page