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.

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)
for r in cg.steal_check([r1, r2]): # r is a StealResult
    print(f"{r.replay1.username} +{r.replay1.mods} vs {r.replay2.username} "
          f"+{r.replay2.mods} on {r.replay1.map_id}. {r.similarity} sim")
from circleguard import *

cg = Circleguard("key")
m = Map(221777, span="1-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-4.1.2.tar.gz (36.5 kB view details)

Uploaded Source

Built Distribution

circleguard-4.1.2-py3-none-any.whl (58.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: circleguard-4.1.2.tar.gz
  • Upload date:
  • Size: 36.5 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-4.1.2.tar.gz
Algorithm Hash digest
SHA256 0f345509f054530732a362f96f648530f43cac76c4f1b29c133dfb6aa3cfbd3b
MD5 75301eeaa656919fae9f10484bcc71dc
BLAKE2b-256 258613642c44cca553be9876faecbece7625a4f12fb77976ee7b0af2015518fa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: circleguard-4.1.2-py3-none-any.whl
  • Upload date:
  • Size: 58.4 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-4.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 586a10021e2ef0d19969159f83113309c02b7e17272d1eea4561c2789d74b930
MD5 8ec932ceec57d21959f0c24d3ebe676c
BLAKE2b-256 8be551f9afdea267af9bbe25a7b3b0c7be7dc535db1f3dfa71908b2c46034409

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