Skip to content
This repository has been archived by the owner on Apr 24, 2024. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
awumii committed Sep 5, 2021
1 parent 1d6f56e commit 6a9692f
Showing 1 changed file with 17 additions and 19 deletions.
36 changes: 17 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,27 @@
# EpicGuard [![GitHub stars](https://img.shields.io/github/stars/xxneox/EpicGuard)](https://github.com/xxneox/EpicGuard/stargazers) [![GitHub forks](https://img.shields.io/github/forks/xxneox/EpicGuard)](https://github.com/xxneox/EpicGuard/network) [![GitHub issues](https://img.shields.io/github/issues/xxneox/EpicGuard)](https://github.com/xxneox/EpicGuard/issues) [![GitHub license](https://img.shields.io/github/license/xxneox/EpicGuard)](https://github.com/xxneox/EpicGuard/blob/master/LICENSE) [![Java CI](https://github.com/xxneox/EpicGuard/actions/workflows/gradle.yml/badge.svg)](https://github.com/xxneox/EpicGuard/actions/workflows/gradle.yml)

Releases may be outdated, use [latest builds](https://github.com/xxneox/EpicGuard/actions)
A simple AntiBot plugin for newest Minecraft versions.

## Supported platforms
* [Paper 1.16.5+](https://papermc.io/)
* [Paper 1.16.5+](https://papermc.io/) *(all paper forks are supported)*
* [Velocity 3.0.0+](https://velocitypowered.com/)
* BungeeCord (you have to use [Waterfall](https://papermc.io/downloads#Waterfall))
* Java 16+ is required.

## Features
* A total of 8 configurable antibot checks:
* Geographical check - country/city blacklist or whitelist.
* VPN/Proxy check - configurable services and caching.
* Nickname check - block certain nickname patterns using regex.
* Reconnect check - require re-joining the server with an identical pair of address and nickname.
* Server list check - require pinging the server before connecting (adding it to the server list).
* Settings check - make sure that player sends a settings packet after joining (vanilla client behaviour).
* Lockdown - temporarily block incoming connections if there are too many of them.
* Name similiarity check (BETA)
* Account limit.
* SQLite/MySQL support.
* Live actionbar statistics.
* Automatic whitelisting.
* Console filter.
## Using EpicGuard in your project:
<details>
<summary>Gradle (Groovy)</summary>
Expand Down Expand Up @@ -87,22 +101,6 @@ String countryId = api.geoManager().countryCode("127.0.0.1")
```
</details>

## Features
* A total of 8 configurable antibot checks:
* Geographical check - country/city blacklist or whitelist.
* VPN/Proxy check - configurable services and caching.
* Nickname check - block certain nickname patterns using regex.
* Reconnect check - require re-joining the server with an identical pair of address and nickname.
* Server list check - require pinging the server before connecting (adding it to the server list).
* Settings check - make sure that player sends a settings packet after joining (vanilla client behaviour).
* Lockdown - temporarily block incoming connections if there are too many of them.
* Name similiarity check (BETA)
* Account limit.
* SQLite/MySQL support.
* Live actionbar statistics.
* Automatic whitelisting.
* Console filter.

## Support
If you found an issue with the plugin, you can either create a new [Issue](https://github.com/xxneox/EpicGuard/issues), or join the discord support server.
[![Discord](https://discord.com/assets/94db9c3c1eba8a38a1fcf4f223294185.png)](https://discord.gg/VkfhFCv)

0 comments on commit 6a9692f

Please sign in to comment.