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.0.1.tar.gz (33.5 kB view details)

Uploaded Source

Built Distribution

circleguard-4.0.1-py3-none-any.whl (50.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: circleguard-4.0.1.tar.gz
  • Upload date:
  • Size: 33.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.0.1.tar.gz
Algorithm Hash digest
SHA256 06744315fff69365211b9e88a54756e7ada2548159d6c7936a7b5a2bb785ad38
MD5 f5f84a19f0ddac7e7472ec7bb2c57d02
BLAKE2b-256 bfc4f2e94c56a91985613820f93213c6f6ac9cb6e8f2b9b2d849db1b4e04a743

See more details on using hashes here.

File details

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

File metadata

  • Download URL: circleguard-4.0.1-py3-none-any.whl
  • Upload date:
  • Size: 50.6 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.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e68326af7d9e5e646061c08d18b5d8a78f5de312971e8e3c7b244e0826c66402
MD5 514173bc6a023f74adf90566b370f707
BLAKE2b-256 ff4382a456e77971d52abff8fcb54b7034483241bf973be22d3e7054c43b89c1

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