James Lu
a5b77c18dd
docs/t/writing-plugins: document hook priorities with some examples
...
Closes #595 .
[skip ci]
2018-07-11 21:23:03 -07:00
James Lu
3208782225
docs: readd pylink-opers.md as a redirect to relay-quickstart.md
...
[skip ci]
2018-07-11 18:59:16 -07:00
James Lu
5b321f9f6f
relay-quickstart: explicitly write PyLink 2.0 instead of "2.0"
...
[skip ci]
2018-07-10 19:00:51 -07:00
James Lu
d3fc95953e
relay-quickstart: fix some typos / unclear wording
...
[skip ci]
2018-07-10 18:59:31 -07:00
James Lu
d310abeec3
faq, relay-quickstart: consistently capitalize Relay as a proper noun
...
[skip ci]
2018-07-10 18:55:33 -07:00
James Lu
66125530ef
faq: discuss how relay handles kills, modes, and server bans (G/K/ZLINE)
...
Closes #619 .
[skip ci]
2018-07-10 18:53:11 -07:00
James Lu
1b26c17d81
docs/channel-modes: add missing entry for auditorium (inspircd +u)
...
[skip ci]
2018-07-10 18:53:11 -07:00
James Lu
aacb65ab9e
relay-quickstart: rewrap, fix typo (at the latest -> at a minimum)
...
[skip ci]
2018-07-10 18:53:11 -07:00
James Lu
bba235bba2
Update GitHub repository address
2018-07-08 12:54:10 -07:00
James Lu
86b93ea969
docs: rewrite the Relay Quick Start Guide ( #619 )
...
- Rename pylink-opers.md -> relay-quickstart.md to better reflect its contents.
- Add a section regarding services compatibility and which features _not_ to use with Relay
- Document LINKACL whitelists, CHANDESC, CLAIM/LINKACL options introduced in 2.0
- Document reworked KILL handling in 2.0 and why K/G/ZLINE support hasn't been implemented
- Explain Relay concepts in more depth for people not familiar with Janus
2018-07-08 12:30:57 -07:00
James Lu
5a9b870e00
services-api: less awkward wording
...
[skip ci]
2018-07-02 00:59:29 -07:00
James Lu
a520496f81
writing-plugins: fix markdown syntax errors
...
[ci skip]
2018-07-02 00:57:41 -07:00
James Lu
86bfda7281
services-api: various wording and typo fixes
...
[ci skip]
2018-07-02 00:57:36 -07:00
James Lu
a74fe9bf08
writing-plugins: refer to the services API guide for utils.add_cmd features
2018-07-02 00:47:30 -07:00
James Lu
b2e85fa385
services-api: mention command alias support in 2.0-alpha1+
2018-07-02 00:45:11 -07:00
James Lu
0ccaac595b
services-api: refresh + expand for 2.0 and the persistent channel rework
...
Closes #603 .
Other changes:
- Move the "Removing services" section to earlier in the doc - it is important!
- Consistently use 'strings' instead of "strings" in example code
- Mention briefly how "spawn_service:" false affects plugins
- Mention the "dynamic" channel handling added in 2.0-alpha3
2018-07-02 00:35:31 -07:00
James Lu
348dc7348c
services-api: use snake case function names for (un)register_service()
...
[skip ci]
2018-07-01 23:36:14 -07:00
James Lu
f90ec284a4
pmodule-spec: document protocol capabilities
...
Closes #436 .
2018-06-26 22:47:39 -07:00
James Lu
bdd568f75b
pmodule-spec: consistently refer to protocol module attrs as self.<whatever>
instead of irc.<whatever>
...
[skip ci]
2018-06-26 22:23:35 -07:00
James Lu
a548ae0714
pmodule-spec: reflow, mention self.connected in Special variables
...
[skip ci]
2018-06-26 22:20:28 -07:00
James Lu
763ffcf903
pmodule-spec: various wording tweaks
...
[skip ci]
2018-06-26 22:14:38 -07:00
James Lu
c48846727e
pmodule-spec: fix link to protocol-modules.svg
...
[skip ci]
2018-06-26 22:02:09 -07:00
James Lu
420f523dfd
writing-plugins: briefly mention log, world, irc.connected, and useful builtin modules
...
Closes #522 .
2018-06-26 21:58:17 -07:00
James Lu
e340f6e9a2
writing-plugins.md: rewrite for clarity for conciseness
...
Also document the introduction of hook handler return values and irc.error()
[skip ci]
2018-06-26 21:36:17 -07:00
James Lu
e037b927f8
adv-relay-conf: fix reference to wrong relay version
...
$mode_prefix in particular was only added in 2.x.
[skip ci]
2018-06-26 14:44:56 -07:00
James Lu
0ae7eb2563
relay_clientbot: allow overriding clientbot styles by network
...
Closes #455 .
2018-06-08 19:15:47 -07:00
James Lu
f54382534c
kick and kill should raise NotImplementedError when not supported by a protocol
...
Closes #605 .
2018-05-09 22:19:03 -07:00
James Lu
d46c494351
faq: move service bot issues under a separate heading
...
[skip ci]
(cherry picked from commit eb078056e1
)
2018-05-08 13:37:22 -07:00
James Lu
b5133aebbb
faq: more minor edits
...
[skip ci]
(cherry picked from commit 030facdb75
)
2018-05-08 13:37:22 -07:00
James Lu
940ff357c9
faq: add links to YAML guides, complete with a mini-rant on YAML misconceptions
...
[skip ci]
(cherry picked from commit 074019b77a
)
2018-05-08 13:37:22 -07:00
James Lu
a425015c13
faq: link to the new Disabling Colors/Control Codes section in adv-relay-config
...
(cherry picked from commit 0ce80f0ede
)
2018-05-08 13:37:22 -07:00
James Lu
f06a8f09b4
docs/adv-relay-config: resync with master
...
Remaining changes: restore documentation for
- $mode_prefix in Custom Clientbot Styles
- The relay_endburst_delay option on InspIRCd networks
[skip ci]
2018-05-08 13:36:20 -07:00
Ken Spencer
78d1d20856
adv-relay-config: fix colons so they match example-conf ( #598 )
...
First part of #597 .
2018-04-16 20:27:00 -07:00
James Lu
d5d94f86e8
servermaps: split into two perms (servermaps.map and servermaps.localmap)
2018-03-02 16:14:04 -05:00
James Lu
484822e5d7
docs: various fixes pointed out by @MrBenC
...
- Clarify the project's goals of being an IRC services *framework*
- Briefly mention in the FAQ that the relay plugin is needed for...well, relay!
[skip ci]
2018-02-17 00:50:12 -08:00
James Lu
3f7e2328fe
relay: make endburst delay configurable
...
Also, raise the default to 10 seconds.
2018-02-10 15:53:49 -08:00
James Lu
d608661a33
permissions-reference: document perms for 'raw' plugin
2018-01-21 13:52:29 -08:00
James Lu
31c96bd1ed
hooks-reference: bump to 2.0-alpha2
...
- Replace `IrcChannel`, `IrcUser`, and `IrcServer` with their new class names (`classes.Channel`, `classes.User`, and `classes.Server`)
- Replace `irc.fullVersion()` with `irc.version()`
- Various minor wording tweaks.
2018-01-13 18:23:12 -08:00
James Lu
06ee01b7a7
hooks-reference: don't use the wrong terminology in example channel names
2018-01-13 18:23:12 -08:00
James Lu
ce3b1152b2
modelists: fix page title for extbans table
...
[skip ci]
2018-01-05 18:46:08 -08:00
James Lu
5f9365a521
relay, inspircd: add support for blockhighlight +V
2017-12-21 21:18:20 -08:00
James Lu
ec3b230eab
inspircd: move definitions for cmodes +J and +E to kicknorejoin_insp and repeat_insp
...
These use InspIRCd specific arguments which don't map cleanly to other IRCds. #559
2017-12-18 13:10:48 -08:00
James Lu
bd2cd90957
modelists/channel-modes: add inspircd +D definition
...
[skip ci]
2017-12-05 12:04:35 -08:00
James Lu
8b62d6d458
modelists: resort data by ircd names defined in protocol modules
2017-11-21 07:39:45 -08:00
James Lu
f969197436
Convert protocol-modules graphic to a .svg
2017-11-12 12:07:08 -08:00
James Lu
847854aac3
Merge branch 'master' into devel
...
Conflicts:
README.md
2017-11-07 19:19:52 -08:00
James Lu
c35c8cd4aa
FAQ updates [skip ci]
...
- add answers for "services bots not spawning" and "inconsistent config spacing causing errors"
- reword the connection troubleshooting section slightly
- mention using 'showchan' to help determine the cause of missing user issues
2017-11-07 09:59:37 -08:00
James Lu
5e7469b56f
Remove protocols/ratbox, superseded by ts6
...
Closes #543 .
2017-10-22 01:06:55 -07:00
James Lu
1470e7691f
relay_clientbot: add support for showing prefix modes
...
This adds a new expansion $mode_prefix, and adds it to the default formats for MESSAGE and ACTION.
Closes #540
2017-10-15 01:42:07 -07:00
James Lu
85ac0bb80a
docs/modelists: add a GitHack link to extbans.html
...
[skip ci]
2017-10-05 19:37:26 -07:00