Skip to content

Commit e2a6959

Browse files
committed
Sync 2.2.0
1 parent 3cab0c0 commit e2a6959

9 files changed

Lines changed: 165 additions & 10 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.idea

docs/_sidebar.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
* [Home](README.md)
1+
* [Home](/README.md)
22

3-
* [Configurations](Configurations.md)
4-
* [Commands](Commands.md)
5-
* [Locale](Locale.md)
3+
* [Configurations](/Configurations.md)
4+
* [Commands](/Commands.md)
5+
* [Locale](/Locale.md)
66

7-
* [Management](management/README.md)
7+
* [AntiCheat](/anticheat/README.md)
8+
* [Reporting](/anticheat/Reporting.md)
9+
* [Trust Factor](/anticheat/TrustFactor.md)
810

9-
* [Commands](management/Commands.md)
10-
* [ChatFilter](management/ChatFilter.md)
11+
* [Management](/management/README.md)
1112

12-
* [Customization](customization/README.md)
13-
* [Alias](customization/Alias.md)
14-
* [MOTD](customization/MOTD.md)
13+
* [Commands](/management/Commands.md)
14+
* [ChatFilter](/management/ChatFilter.md)
15+
16+
* [Customization](/customization/README.md)
17+
* [Alias](/customization/Alias.md)
18+
* [MOTD](/customization/MOTD.md)

docs/anticheat/README.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# AntiCheat
2+
3+
Expermintal functions
4+
5+
## Configurations
6+
**anticheat/config.yml**
7+
```yaml
8+
trust-factor:
9+
enabled: false
10+
allow-auto-increase: true
11+
12+
reports:
13+
green: 1
14+
yellow: 5
15+
red: 10
16+
17+
reporting:
18+
use-external: true
19+
external-reporting-commands:
20+
- report
21+
22+
operations:
23+
ban-command: "/ban %player% %duration% %reason%"
24+
```
25+
26+
- **trust-factor** See [Trust Factor](./TrustFactor.md)
27+
- **reporting** See [Reporting](./Reporting.md)
28+
- **operations**
29+
- **ban-command** Command to execute when a player triggered max-vl
30+
31+
## Checks Configurations
32+
**anticheat/checks.yml**
33+
34+
**Example in IllegalMove**
35+
```yaml
36+
IllegalMovement:
37+
enabled: true
38+
use-tf: true
39+
tf-offset:
40+
...
41+
42+
...
43+
44+
flag-vl: 10
45+
max-vl: 50
46+
47+
ban-durations:
48+
...
49+
```
50+
51+
- **use-tf** Use TrustFactor system
52+
- **tf-offset** See [Trust Factor](./TrustFactor.md#configurations-for-checks)
53+
- **flag-vl** VL to trigger flags
54+
- **max-vl** VL to execute [`operations.ban-command`](#configurations)
55+
- **ban-durations** See [Trust Factor](./TrustFactor.md#configurations-for-checks)
56+
57+
## Checks
58+
59+
**[Sub Pages](checks/README.md)**

docs/anticheat/Reporting.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Reporting
2+
3+
AntiCheat service supported use reports counter to manage [TrustFactor](TrustFactor.md) system
4+
5+
## Configurations
6+
**anticheat/config.yml**
7+
```yaml
8+
reporting:
9+
use-external: true
10+
external-reporting-commands:
11+
- report
12+
```
13+
14+
- **use-external** Use external reporting commands for recording
15+
- **external-reporting-commands** External reporting commands for recording reports count, supported ```/<command> <player> <reason>``` format

docs/anticheat/TrustFactor.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# TrustFactor
2+
3+
TrustFactor is an expermintal system, TF levels will decrease when user triggered flag-vl for any modules
4+
5+
Default level is ```BLUE```
6+
7+
When AC received report message(s), it will decrease to ```GREEN```
8+
9+
When user reported by more users, it will decrease to ```YELLOW```
10+
11+
If user get banned by AC or reported by more and more users, it will decrease to ```RED```
12+
13+
TF levels never increases automaticially
14+
15+
This system is disabled in default, you can enable it in **anticheat/config.yml**
16+
17+
## Configurations
18+
**anticheat/config.yml**
19+
```yaml
20+
trust-factor:
21+
enabled: false
22+
allow-auto-increase: true
23+
```
24+
25+
- **allow-auto-increase** Allow TF levels increase automaticially on user reports successfully
26+
- **reports.green** Change TF level to ```GREEN``` after reports received
27+
- **reports.yellow** Change TF level to ```YELLOW``` after reports received
28+
29+
## Configurations for checks
30+
31+
TF has different configurations in each AC checks, here is an example in IllegalMovement:
32+
33+
```yaml
34+
IllegalMove:
35+
...
36+
tf-offset:
37+
blue: -5
38+
green: 0
39+
yellow: 3
40+
red: 5
41+
...
42+
ban-durations:
43+
blue: 10min
44+
green: 1h
45+
yellow: 1d
46+
red: 7d
47+
```
48+
49+
- **use-tf** Use TF for this check
50+
- **tf-offset** Amount to decrese flag-vl and max-vl
51+
- **ban-durations** Durations for each TF level

docs/anticheat/checks/Bot.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# AutoBot
2+
3+
All functions in this page are INCOMPLETED
4+
5+
## AutoMine
6+
7+
[BETA] Detect AutoMine/PathFinding from mods like Baritone

docs/anticheat/checks/Illegals.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Illegals
2+
3+
Detecte actions that impossible from players
4+
5+
## Illegal Move
6+
7+
- **GuiMove** Also known as `InventoryMove`
8+
- **AirJump** Detect if player jumped in air

docs/anticheat/checks/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Checks
2+
3+
Click links on the sidebar

docs/anticheat/checks/_sidebar.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
- [Back to AntiCheat](../README.md)
2+
3+
- [Illegals](Illegals.md)
4+
- [Illegal Movement](Illegals.md#illegal-move)
5+
6+
- [AutoBot](Bot.md)
7+
- [AutoMine](Bot.md#automine)

0 commit comments

Comments
 (0)