awumii / EpicGuard

🛡 Bot protection system for Minecraft servers. | Outdated, use: https://github.com/4drian3d/EpicGuard
GNU General Public License v3.0
93 stars 22 forks source link

🚧️ Maintained fork can be found at: https://github.com/4drian3d/EpicGuard

🛡 EpicGuard GitHub stars GitHub forks GitHub issues GitHub license Java CI

A simple AntiBot plugin for newest Minecraft versions.

✅ Supported platforms / Latest release requirements

✨ Features

📚 Commands & Permissions

To be able to use commands, give yourself the epicguard.admin permission.
On different platforms there are additional aliases available, such as /guardvelocity or /epicguardpaper

Command Description
/guard help Displays all available commands.
/guard reload Reloads config and messages.
/guard whitelist <add/remove> <nick/address> Whitelist/unwhitelist an address or nickname.
/guard blacklist <add/remove> <nick/address> Blacklist/unblacklist an address or nickname.
/guard analyze <nick/address> Displays detailed information about the specified address or nickname.
/guard status Toggles live attack information on actionbar.
/guard save Forces save to the database.

⚠️ Current state of the project

I (xxneox) am basically the only maintainer of this project. I don't have time to work on it anymore, so it's only getting bugfixes and important changes. Support is only given for important issues. This repository might get archived at any time.

🔧 Using EpicGuard API in your project:

The api is not very advanced, and there is not much you can do with it for now.

Gradle (Groovy) ```groovy repositories { maven { url = 'https://jitpack.io' } } dependencies { compileOnly 'com.github.xxneox:EpicGuard:[VERSION OR COMMIT ID HERE]' } ```
Gradle (Kotlin) ```kotlin repositories { maven("https://jitpack.io") } dependencies { compileOnly("com.github.xxneox:EpicGuard:[VERSION OR COMMIT ID HERE]") } ```
Maven ```xml jitpack.io https://jitpack.io com.github.xxneox EpicGuard [VERSION OR COMMIT ID HERE] provided ```
Using the API Make sure that EpicGuard is fully loaded before your plugin. [Click to see the API class](https://github.com/xxneox/EpicGuard/blob/master/core/src/main/java/me/xneox/epicguard/core/EpicGuardAPI.java) ```java // Importing the API class. import me.xneox.epicguard.core.EpicGuardAPI; import me.xneox.epicguard.core.manager.AttackManager; public class EpicGuardAPIExample { // Accessing the EpicGuardAPI instance. EpicGuardAPI api = EpicGuardAPI.INSTANCE; // Obtaining the AttackManager instance: AttackManager attackManager = api.attackManager(); // Checking if server is under attack. boolean isUnderAttack = attackManager.isUnderAttack(); // checking current connections per second. int cps = attackManager.connectionCounter(); // Checking user's country: String countryId = api.geoManager().countryCode("127.0.0.1"); } ```

🕵️ Privacy disclaimers