3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-24 03:29:28 +01:00
PyLink/docs/advanced-services-config.md
James Lu 7892e37bfa Documentation tweaks
- Add advanced-service-config to TOC
- Move "matching SERVICE name" note to docs/t/services-api.md
- Various wording / grammar tweaks
2017-03-13 13:50:16 -07:00

62 lines
1.4 KiB
Markdown

# Advanced Services Configuration
There are some service configuration options that you may want to be aware of.
#### Nick / Ident
You can override the `nick` or `ident` of a service bot using a directive liek this:
```yaml
servers:
somenet:
# ...
SERVICE_nick: OTHERNICK
SERVICE_ident: OTHERIDENT
```
You can also set an arbitrary nick/ident using a per-**service** directive.
```yaml
SERVICE:
nick: OTHERNICK
ident: OTHERIDENT
```
#### joinmodes
By default, service bots join channels without giving themselves any modes. You can configure what modes a service bot joins channels with using this directive:
```yaml
SERVICE:
joinmodes: 'o'
```
This would request the mode 'o' (op on most IRCds) when joining the channel.
Technically any mode can be put here, but if an IRCd in question doesn't support
the mode then it will be ignored.
You can also use combinations of modes, such as 'ao' (usually admin/protect + op)
```yaml
SERVICE:
joinmodes: 'ao'
```
Combinations should work provided an IRCd in question supports it.
#### Fantasy prefix
You can also set the service bot's fantasy prefix; of course this is only
applicable if the `fantasy` plugin is loaded.
The setting allows for one or more characters to be set as the prefix.
```yaml
SERVICE:
prefix: './'
```
The above is perfectly valid, as is any other string.