diff --git a/Chanban/README.md b/Chanban/README.md index 9225555..982633d 100644 --- a/Chanban/README.md +++ b/Chanban/README.md @@ -35,6 +35,7 @@ All configuration is done at the top of `cmgmt.tcl`. | `tBanDuration` | `30` | Duration of temporary bans, in minutes | | `upCommand` | `curl -s -F file=@- https://x0.at/` | Command used to upload the ban list. Must read from stdin | | `banMask` | `2` | Ban mask type (see mask types below) | +| `addOpMask` | `1` | Mask type used when adding an op | | `protectMasks` | `*!*@services.ptirc.org` | Masks that can never be banned or kicked | | `noAddNicks` | `ChanServ NickServ ChanBot` | Nicks to ignore when auto-adding bans | | `noAddMasks` | `*!*@services.ptirc.org` | Masks to ignore when auto-adding bans | @@ -58,7 +59,7 @@ All configuration is done at the top of `cmgmt.tcl`. ## Commands -All commands require the user to have the `o` (op) flag on the channel. Commands are available both publicly in the channel (prefixed with the trigger) and privately via `/msg` to the bot. +Most commands require the user to have the `o` (op) flag on the channel. The `addop`, `delop`, and `ops` commands require the `n` (owner) flag. Commands are available both publicly in the channel (prefixed with the trigger) and privately via `/msg` to the bot. ### Public Commands (in channel) @@ -72,6 +73,9 @@ All commands require the user to have the `o` (op) flag on the channel. Commands | `@unban ` | Removes a ban mask from the channel and the bot's ban list | | `@banlist` | Uploads the bot's ban list for the channel and posts a link | | `@autoadd ` | Enables, disables, or checks the status of automatic ban adding | +| `@addop ` | Adds a user as channel op (requires `n` flag) | +| `@delop ` | Removes a user as channel op (requires `n` flag) | +| `@ops` | Lists all registered ops for the channel (requires `n` flag) | | `@opcmds` | Lists all available commands | ### Private Commands (via /msg) @@ -88,6 +92,9 @@ The syntax is the same but requires the channel to be specified as the first arg | `unban <#chan> ` | Removes a ban mask from the specified channel | | `banlist <#chan>` | Uploads and sends the ban list for the specified channel | | `autoadd <#chan> ` | Manages automatic ban adding for the specified channel | +| `addop <#chan> ` | Adds a user as channel op (requires `n` flag) | +| `delop <#chan> ` | Removes a user as channel op (requires `n` flag) | +| `ops <#chan>` | Lists all registered ops for the specified channel (requires `n` flag) | | `opcmds <#chan>` | Lists all available commands | --- @@ -100,7 +107,7 @@ When enabled, the bot automatically mirrors IRC bans (`+b` modes) into its inter - Bans matching any host belonging to a user with the `m`, `n`, or `o` flag are protected and will be immediately removed. - Extended bans (masks starting with `~`) are tracked separately as `EXTBAN` entries and marked as sticky. - Auto-tracking is per-channel and is toggled with `@autoadd on/off`. -- Op notices (`NOTICE @#channel`) are sent when bans are automatically added or removed. +- Op notices (`NOTICE @#channel`) are sent when bans are automatically added. --- @@ -115,12 +122,14 @@ To change the language, set the `locale` variable in the configuration section t | Code | Language | |---|---| | `en` | English | -| `pt` | Portuguese (European) | | `it` | Italian | +| `pt` | Portuguese (European) | To add a new language, copy `en.msg`, rename it to the desired locale code, and translate the strings. The `%s` placeholders must be kept in the same order as described in the comments above each entry. -### Custom Upload Command +--- + +## Custom Upload Command The `upCommand` variable accepts any command that reads from stdin and returns a URL. Some examples: