Add docs/config.md
All checks were successful
Check syntax / check (push) Successful in 9s

This commit is contained in:
Nova Cat 2024-12-22 19:55:23 -08:00
parent d784694262
commit 5e0235919a

21
docs/config.md Normal file
View file

@ -0,0 +1,21 @@
Configure the bot for the channel. Requires the "full" perms. (will be allowed by chanops soon)
Use +FLAG to enable a disabled-by-default, and -FLAG vice versa.
Available flags:
* multiline - be able to print multiline output (enabled default)
* colonthree - make the bot say ":3" when someone's message starts with ":3" (enabled default)
* links - parse titles of links sent by users (DISABLED default)
* sed - parse sed expressions without the need of $sed command (DISABLED default)
* config - placeholder, do not modify.
---
Syntax:
```
$config [FLAG] [FLAG] - Apply one or more flags
$config clear - Clear all flags
$config - list all flags in the channel
```