Skip to main content

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

PyPi version CodeFactor

Circlecore

Circlecore is a cheat detection library for osu!.

Circlecore currently supports detection of the following cheats:

  • Replay Stealing
  • Relax
  • Aim Correction

Designed for use in Circleguard, circlecore is easily integratable into any existing python project and we have worked hard to ensure it is easy to use.

We highly encourage projects that use circlecore - if you are using it in one of your apps, please let us know and we will link to you somwhere in our readme or documentation.

Circleguard 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 gui application Circleguard. However, circlecore is installed from pypi with the name circleguard, and is imported as such in python (import circleguard).

Links

Github: https://github.com/circleguard/circlecore
Documentation: https://circleguard.dev/docs/circlecore
Discord: https://discord.gg/VNnkTjm
Website: https://circleguard.dev

Usage

We have documentation and a tutorial at https://circleguard.dev/docs/circlecore.

If you want a 30 second introduction to circlecore, see the following code snippets.

from circleguard import *

cg = Circleguard("key")
r1 = ReplayMap(221777, 2757689)
r2 = ReplayMap(221777, 4196808)
c = Check([r1, r2], StealDetect(50))
for r in cg.run(c): # r is a StealResult
    if not r.ischeat:
        print(f"replays by {r.replay1.username} and {r.replay2.username} are not stolen")
        continue
    print(f"{r.later_replay.username}'s replay on map {r.later_replay.map_id} +{r.later_replay.mods}"
          f"is stolen from {r.earlier_replay.username} with similarity {r.similarity}")
from circleguard import *

cg = Circleguard("key")
m = Map(221777, num=2)
cg.load_info(m)
for r in m:
    print(f"User {r.username} +{r.mods} on map {r.map_id}")

Project details


Download files

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

Source Distribution

circleguard-3.2.0.tar.gz (32.9 kB view details)

Uploaded Source

Built Distribution

circleguard-3.2.0-py3-none-any.whl (49.8 kB view details)

Uploaded Python 3

File details

Details for the file circleguard-3.2.0.tar.gz.

File metadata

  • Download URL: circleguard-3.2.0.tar.gz
  • Upload date:
  • Size: 32.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.2

File hashes

Hashes for circleguard-3.2.0.tar.gz
Algorithm Hash digest
SHA256 be7eca695ce2650fe95089aa34e76e0c418cd679958078f393b9ac3e8afe5c22
MD5 a452b307882267a4bd3bc1647c937506
BLAKE2b-256 1d52651305aecdeb38adb78efba5caca9e48a92fd97a5f3c3a7d2c007d712d18

See more details on using hashes here.

File details

Details for the file circleguard-3.2.0-py3-none-any.whl.

File metadata

  • Download URL: circleguard-3.2.0-py3-none-any.whl
  • Upload date:
  • Size: 49.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.2

File hashes

Hashes for circleguard-3.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 64fc739cdb10b35e38a99317e17cf144756d4be8629e6e9e05b518088a145dd1
MD5 edebb7a7555bb6ea866566e0bc5b4500
BLAKE2b-256 68dcaefefb73e1ff25b57c9b1f8bd8dc3e1a35f577c71a03002abba37431c7cd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page