Skip to content

Commit

Permalink
Sync 2.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
zyklone4096 committed Dec 13, 2023
1 parent 3cab0c0 commit e2a6959
Show file tree
Hide file tree
Showing 9 changed files with 165 additions and 10 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.idea
24 changes: 14 additions & 10 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
* [Home](README.md)
* [Home](/README.md)

* [Configurations](Configurations.md)
* [Commands](Commands.md)
* [Locale](Locale.md)
* [Configurations](/Configurations.md)
* [Commands](/Commands.md)
* [Locale](/Locale.md)

* [Management](management/README.md)
* [AntiCheat](/anticheat/README.md)
* [Reporting](/anticheat/Reporting.md)
* [Trust Factor](/anticheat/TrustFactor.md)

* [Commands](management/Commands.md)
* [ChatFilter](management/ChatFilter.md)
* [Management](/management/README.md)

* [Customization](customization/README.md)
* [Alias](customization/Alias.md)
* [MOTD](customization/MOTD.md)
* [Commands](/management/Commands.md)
* [ChatFilter](/management/ChatFilter.md)

* [Customization](/customization/README.md)
* [Alias](/customization/Alias.md)
* [MOTD](/customization/MOTD.md)
59 changes: 59 additions & 0 deletions docs/anticheat/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# AntiCheat

Expermintal functions

## Configurations
**anticheat/config.yml**
```yaml
trust-factor:
enabled: false
allow-auto-increase: true

reports:
green: 1
yellow: 5
red: 10

reporting:
use-external: true
external-reporting-commands:
- report

operations:
ban-command: "/ban %player% %duration% %reason%"
```
- **trust-factor** See [Trust Factor](./TrustFactor.md)
- **reporting** See [Reporting](./Reporting.md)
- **operations**
- **ban-command** Command to execute when a player triggered max-vl
## Checks Configurations
**anticheat/checks.yml**
**Example in IllegalMove**
```yaml
IllegalMovement:
enabled: true
use-tf: true
tf-offset:
...

...

flag-vl: 10
max-vl: 50

ban-durations:
...
```
- **use-tf** Use TrustFactor system
- **tf-offset** See [Trust Factor](./TrustFactor.md#configurations-for-checks)
- **flag-vl** VL to trigger flags
- **max-vl** VL to execute [`operations.ban-command`](#configurations)
- **ban-durations** See [Trust Factor](./TrustFactor.md#configurations-for-checks)

## Checks

**[Sub Pages](checks/README.md)**
15 changes: 15 additions & 0 deletions docs/anticheat/Reporting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Reporting

AntiCheat service supported use reports counter to manage [TrustFactor](TrustFactor.md) system

## Configurations
**anticheat/config.yml**
```yaml
reporting:
use-external: true
external-reporting-commands:
- report
```
- **use-external** Use external reporting commands for recording
- **external-reporting-commands** External reporting commands for recording reports count, supported ```/<command> <player> <reason>``` format
51 changes: 51 additions & 0 deletions docs/anticheat/TrustFactor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# TrustFactor

TrustFactor is an expermintal system, TF levels will decrease when user triggered flag-vl for any modules

Default level is ```BLUE```

When AC received report message(s), it will decrease to ```GREEN```

When user reported by more users, it will decrease to ```YELLOW```

If user get banned by AC or reported by more and more users, it will decrease to ```RED```

TF levels never increases automaticially

This system is disabled in default, you can enable it in **anticheat/config.yml**

## Configurations
**anticheat/config.yml**
```yaml
trust-factor:
enabled: false
allow-auto-increase: true
```
- **allow-auto-increase** Allow TF levels increase automaticially on user reports successfully
- **reports.green** Change TF level to ```GREEN``` after reports received
- **reports.yellow** Change TF level to ```YELLOW``` after reports received

## Configurations for checks

TF has different configurations in each AC checks, here is an example in IllegalMovement:

```yaml
IllegalMove:
...
tf-offset:
blue: -5
green: 0
yellow: 3
red: 5
...
ban-durations:
blue: 10min
green: 1h
yellow: 1d
red: 7d
```

- **use-tf** Use TF for this check
- **tf-offset** Amount to decrese flag-vl and max-vl
- **ban-durations** Durations for each TF level
7 changes: 7 additions & 0 deletions docs/anticheat/checks/Bot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# AutoBot

All functions in this page are INCOMPLETED

## AutoMine

[BETA] Detect AutoMine/PathFinding from mods like Baritone
8 changes: 8 additions & 0 deletions docs/anticheat/checks/Illegals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Illegals

Detecte actions that impossible from players

## Illegal Move

- **GuiMove** Also known as `InventoryMove`
- **AirJump** Detect if player jumped in air
3 changes: 3 additions & 0 deletions docs/anticheat/checks/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Checks

Click links on the sidebar
7 changes: 7 additions & 0 deletions docs/anticheat/checks/_sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
- [Back to AntiCheat](../README.md)

- [Illegals](Illegals.md)
- [Illegal Movement](Illegals.md#illegal-move)

- [AutoBot](Bot.md)
- [AutoMine](Bot.md#automine)

0 comments on commit e2a6959

Please sign in to comment.