Skip to content

Commit 01eacb4

Browse files
committed
[ci skip] readme
1 parent 8268e10 commit 01eacb4

1 file changed

Lines changed: 3 additions & 18 deletions

File tree

README.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,6 @@ AdvancedSensitiveWords is a Paper moderation plugin built around DFA word matchi
44

55
> **2.x is a breaking release.** It targets Paper only, uses Gradle with Kotlin DSL, and generates a new kebab-case configuration model. Do not reuse pre-2.0 configuration files without reviewing every setting.
66
7-
## Requirements
8-
9-
| Component | Requirement |
10-
| --- |--------------------------------------------------------|
11-
| Server | Paper 1.21.11 |
12-
| Java | Java 21 |
13-
| Proxy (optional) | Velocity with the matching Velocity jar |
14-
| Optional integrations | TrChat, PacketEvents, PlaceholderAPI, floodgate, AuthMe |
15-
167
Spigot, CraftBukkit, and BungeeCord are not supported since version 2.x.
178

189
## Installation
@@ -24,7 +15,7 @@ Spigot, CraftBukkit, and BungeeCord are not supported since version 2.x.
2415

2516
For Velocity notifications and proxy commands, install the Velocity artifact on the proxy, set `plugin.hook-velocity: true` on Paper, then restart both sides. The proxy module does not filter chat by itself.
2617

27-
## What 2.x Filters
18+
## Filters
2819

2920
- **Chat and commands**: Paper `AsyncChatEvent`, command preprocessing, cross-message chat context, configurable replacement or cancellation, fake messages on cancellation, and TrChat fake-message/shadowban compatibility.
3021
- **Books**: event-based writable-book checking, optional cross-page checking in cancel mode, and a bounded cache for processed book content.
@@ -33,7 +24,7 @@ For Velocity notifications and proxy commands, install the Velocity artifact on
3324
- **Player names and broadcasts**: login rejection for blocked names and optional broadcast filtering.
3425
- **Optional LLM chat review**: asynchronous, cost-gated review for messages that did not match DFA or chat context. It is disabled by default and never retracts chat; it can notify, record, increment the separate AI VL, and run configured actions after a validated response.
3526

36-
## Quick Configuration
27+
## Configuration
3728

3829
Configuration is generated in lower kebab-case. The generated file is the authoritative list of defaults and inline comments.
3930

@@ -154,13 +145,7 @@ import java.time.Duration;
154145
AdvancedSensitiveWordsApi.shadowBan().shadow(player, Duration.ofMinutes(5));
155146
```
156147

157-
`AsyncModerationResponseEvent` is fired asynchronously after an LLM response. Event handlers may observe, cancel ASW follow-up, or replace the validated result, but must schedule Bukkit entity/world work themselves.
158-
159-
## Building From Source
160-
161-
```powershell
162-
.\gradlew.bat --no-daemon build
163-
```
148+
`AsyncModerationResponseEvent` is fired asynchronously after an LLM response. Event handlers may observe, cancel ASW follow-up, or replace the validated result.
164149

165150
## License
166151

0 commit comments

Comments
 (0)