GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-25 04:02:45 +01:00
Code Issues Projects Releases Wiki Activity

adv-relay-config: various wording adjustments

Browse Source
This commit is contained in:
James Lu 2018-04-16 22:09:01 -07:00
parent 236d800b47
commit 89a7f59262
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/advanced-relay-config.md
View File

@ -1,8 +1,16 @@
# Advanced Configuration for PyLink Relay # Advanced Configuration for PyLink Relay
PyLink Relay provides a few advanced configuration options not documented in the example configuration, either because they have limited use, or are too complicated to be described briefly. PyLink Relay provides a few configuration options not documented in the example configuration, either because they have limited use or are too complicated to be described briefly.
**This guide assumes that you are relatively familiar with the way YAML syntax works (lists, named arrays/dicts, etc.).** For the purposes of this document, configuration options will be referred to in the format `a::b::c`, which represents the "`c`" configuration key in a "`b`" block, all within an "`a`" block. **This guide assumes that you are relatively familiar with the way YAML syntax works (lists, named arrays/dicts, etc.).** In this document, configuration options will be referred to in the format `a::b::c`, which represents the "`c`" option inside a "`b`" config block, all within an "`a`" config block.
In actual YAML, that translates to this:
```yaml
a:
b:
c: "some value"
```
### Custom Clientbot Styles ### Custom Clientbot Styles
@ -13,14 +21,14 @@ These options take template strings as documented here: https://docs.python.org/
- For all events: - For all events:
- `$netname`: origin network name - `$netname`: origin network name
- `$sender`: nick of sender - `$sender`: nick of sender
- `$sender_identhost`: ident@host string of sender - `$sender_identhost`: ident@host string of the sender
- `$colored_sender`: color hashed version of `$sender` - `$colored_sender`: color hashed version of `$sender`
- `$colored_netname`: color hashed version of `$netname` - `$colored_netname`: color hashed version of `$netname`
- For KICK, and other events that have a `$target` field corresponding to a user: - For KICK, and other events that have a `$target` field corresponding to a user:
- `$target_nick`: nick of target (as opposed to `$target`, which is an UID) - `$target_nick`: the nick of the target (as opposed to `$target`, which is an user ID)
- For events that have a `$channel` field attached (e.g. JOIN, PART): - For events that have a `$channel` field attached (e.g. JOIN, PART):
- `$local_channel`: the LOCAL channel name (of the clientbot network) - `$local_channel`: the *local* channel name (i.e. the channel on the clientbot network)
- `$channel`: the real channel on the sender's network - `$channel`: the real channel name on the sender's network
- For SJOIN, SQUIT: - For SJOIN, SQUIT:
- `$nicks`: a comma-joined list of nicks that were bursted - `$nicks`: a comma-joined list of nicks that were bursted
- `$colored_nicks`: a comma-joined list of each bursted nick, color hashed - `$colored_nicks`: a comma-joined list of each bursted nick, color hashed