Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
M-archand authored Aug 23, 2024
1 parent ab80986 commit 3122e04
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,35 @@
# BannedWords
A simple CS2 plugin that lets you set a configurable list of words that will result in an automatic silence or gag.

## [ Configuration ]

> [!NOTE]
> Config located in /addons/counterstrikesharp/configs/plugins/BannedWords/BannedWords.json
>
```json
{
"BanSettings": {
"PlayerBanType": "silence", // Usage: silence, gag
"DurationInMinutes": 5
},
"BannedWords": [
"word1",
"word2",
"word3",
],
"ConfigVersion": 1
}
```
> [!NOTE]
> Ban chat messages located in /addons/counterstrikesharp/plugins/BannedWords/lang/en.json
>
```json
{
"silencemsgplayer": " {Red}[Server] - {Default}You have automatically been silenced for {0} minutes due to {1}",
"silencemsgserver": " {Red}[Server] - {LightRed}{0} {Default}has automatically been silenced due to {1}",
"gagmsgplayer": " {Red}[Server] - {Default}You have automatically been gagged for {0} minutes due to {1}",
"gagmsgserver": " {Red}[Server] - {LightRed}{0} {Default}has automatically been gagged due to {1}",
"banreason": "using a banned word."
}

0 comments on commit 3122e04

Please sign in to comment.