Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bram1903/totemguard
TotemGuard is a simple anticheat that tries to detect players who are using AutoTotem.
https://github.com/bram1903/totemguard
anticheat autototem minecraft packetevents
Last synced: 6 days ago
JSON representation
TotemGuard is a simple anticheat that tries to detect players who are using AutoTotem.
- Host: GitHub
- URL: https://github.com/bram1903/totemguard
- Owner: Bram1903
- License: gpl-3.0
- Created: 2024-08-29T13:01:27.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-04T17:56:48.000Z (10 days ago)
- Last Synced: 2025-01-04T18:33:47.411Z (10 days ago)
- Topics: anticheat, autototem, minecraft, packetevents
- Language: Java
- Homepage: https://discord.deathmotion.com
- Size: 76.4 MB
- Stars: 18
- Watchers: 2
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
TotemGuard
## Overview
TotemGuard is a lightweight anti-cheat plugin designed to detect players using AutoTotem. It operates asynchronously to
minimize server impact and offers extensive configurability, enabling server owners to tailor the plugin to their
specific needs.
### Prerequisites
TotemGuard requires the [PacketEvents](https://modrinth.com/plugin/packetevents) library to function. Ensure it is
installed on your server.
## Table of Contents
- [Overview](#overview)
- [Prerequisites](#prerequisites)
- [Showcase](#showcase)
- [Supported Platforms & Versions](#supported-platforms--versions)
- [Checks](#checks)
- [Features](#features)
- [Commands](#commands)
- [Permission Nodes](#permission-nodes)
- [Installation](#installation)
- [Compiling From Source](#compiling-from-source)
- [Prerequisites](#prerequisites)
- [Steps](#steps)
- [Credits](#credits)
- [License](#license)
## Showcase
## Supported Platforms & Versions
| Platform | Supported Versions |
|-------------------------------------------------|--------------------|
| Bukkit, Spigot, Paper, Folia, and related forks | 1.16.5 - 1.21.4 |
## Checks
For a much more detailed explanation of the checks, see [the wiki!](https://github.com/Bram1903/TotemGuard/wiki/Checks)
### AutoTotem
- **AutoTotemA** - Click time difference
- **AutoTotemB** - Impossible standard deviation
- **AutoTotemC** - Impossible average standard deviation
- **AutoTotemD** - Suspicious re-totem packet sequence
- **AutoTotemE** - Impossible low outliers
- **AutoTotemF** - Invalid interactions during inventory close
### BadPackets
- **BadPacketsA** - Opt-out message in a mod configuration channel
- **BadPacketsB** - Banned client brand
- **BadPacketsC** - Same slot change packet
### ManualTotem
- **ManualTotemA** - Time difference between replacement after totem removal
## Features
- **Performance** - Asynchronous operations ensure minimal impact on server performance.
- **Database Support** - Compatible with both MySQL and SQLite.
- **Folia Integration** - Supports [Folia](https://papermc.io/software/folia) for regionized multithreading.
- **Webhooks** - Send alerts and punishments to a Discord webhook.
- **Highly Configurable** - Adjust nearly every setting during runtime to fit your server's needs.
- **Update Checker** - Automatically checks for updates on startup.
- **Bypass Permission** - Allows players with `TotemGuard.Bypass` to bypass checks.
- **Cross Server Alerts** - Easily send and retrieve alerts across multiple servers, through either plugin messaging or
Redis.
- **Bedrock Exception** - Automatically ignores Bedrock Edition players to prevent false positives.
- **BetterReload Support** - Integrates with [BetterReload](https://modrinth.com/plugin/betterreload) for seamless
configuration reloading.
## Commands
- `/totemguard` or `/tg` - Main command for TotemGuard.
- `/totemguard reload` - Reload the plugin configuration.
- `/totemguard alerts` - Toggle alerts for the player.
- `/totemguard check ` - Check the player for AutoTotem.
- `/totemguard alerts ` - Toggle alerts for another player.
- `/totemguard profile` - Display the player's profile.
- `/totemguard stats` - Show plugin statistics.
- `/totemguard clearlogs` - Clear the logs.
- `/totemguard track/untrack ` - Tracks the player.
- `/totemguard top` - Shows the top 10 violators.
- `/totemguard manualban ` - Manually ban a player.
- `/totemguard database trim` - Trim the database.
- `/totemguard database clear` - Clear the database.
## Permission Nodes
Operators (OPs) have these permissions by default, except `TotemGuard.Debug`:
- `TotemGuard.*` - Access to all TotemGuard permissions.
- `TotemGuard.Staff` - Access to `TotemGuard.Check`, `TotemGuard.Alerts`, and `TotemGuard.Profile`.
- `TotemGuard.Databases.*` - Access to all database-related commands.
- `TotemGuard.Reload` - Access to the `/totemguard reload` command.
- `TotemGuard.Check` - Access to the `/totemcheck` command.
- `TotemGuard.Alerts` - Access to the `/totemguard alerts` command.
- `TotemGuard.Alerts.Others` - Toggle alerts for other players.
- `TotemGuard.Profile` - Access to the `/totemguard profile` command.
- `TotemGuard.Stats` - Access to the `/totemguard stats` command.
- `TotemGuard.ClearLogs` - Access to the `/totemguard clearlogs` command.
- `TotemGuard.Track` - Access to the `/totemguard track` command.
- `TotemGuard.Bypass` - Bypass the plugin's checks.
- `TotemGuard.Update` - Receive update notifications.
- `TotemGuard.Top` - Access to the `/totemguard top` command.
- `TotemGuard.ManualBan` - Access to the `/totemguard manualban` command.
- `TotemGuard.Database.Trim` - Access to the `/totemguard database trim` command.
- `TotemGuard.Database.Clear` - Access to the `/totemguard database clear` command.
- `TotemGuard.Debug` - View debug messages.
## Installation
1. **Prerequisites**: Ensure [PacketEvents](https://modrinth.com/plugin/packetevents) is installed.
2. **Download**: Get the latest release from
the [GitHub release page](https://github.com/Bram1903/TotemGuard/releases/latest).
3. **Install**: Place the plugin JAR file in your server's `plugins` directory.
4. **Configure**: Customize the `config.yml` file as needed.
5. **Reload**: Apply the changes using `/totemguard reload`.
## Compiling From Source
### Prerequisites
- Java Development Kit (JDK) 21 or higher
- [Git](https://git-scm.com/downloads)
### Steps
1. **Clone the Repository**:
```bash
git clone https://github.com/Bram1903/TotemGuard.git
```
2. **Navigate to the Project Directory**:
```bash
cd TotemGuard
```
3. **Compile the Source Code**:
Use the Gradle wrapper to build the plugin:
Linux / macOS
```bash
./gradlew build
```
Windows
```cmd
.\gradlew build
```
## Credits
**Maintainer: [@OutDev](https://github.com/OutDev0)**
For their creative ideas and dedicated efforts in maintaining the project.
### Special Thanks to Our Contributors
- **[@Retrooper](https://github.com/retrooper)**
For developing [PacketEvents](https://github.com/retrooper/packetevents), a foundational library integral to the
project's success.
- **[@MattMX](https://github.com/Matt-MX)**
For supporting development by providing server access and contributing valuable insights
through [PvPHub](https://github.com/PvPHubLLC).
## License
This project is licensed under the [GPL3 License](LICENSE).