3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-18 08:02:51 +01:00
Commit Graph

294 Commits

Author SHA1 Message Date
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
James Lu
eb078056e1 faq: move service bot issues under a separate heading
[skip ci]
2018-05-06 12:20:49 -07:00
James Lu
030facdb75 faq: more minor edits
[skip ci]
2018-05-06 12:19:08 -07:00
James Lu
074019b77a faq: add links to YAML guides, complete with a mini-rant on YAML misconceptions
[skip ci]
2018-05-06 12:12:17 -07:00
James Lu
0ce80f0ede faq: link to the new Disabling Colors/Control Codes section in adv-relay-config 2018-05-06 11:44:18 -07:00
James Lu
9967b7d9fe adv-relay-config: fix up in-page link [skip ci] 2018-04-17 11:52:09 -07:00
James Lu
041b6aecb6 adv-relay-config: more revisions (closes #597) [skip ci]
commit c82dcb95a6fa1584104a258c9772845b5549b35e
Author: James Lu <james@overdrivenetworks.com>
Date:   Tue Apr 17 11:49:44 2018 -0700

    adv-relay-config: more cleanup and stylistic tweaks

commit 515974a54a3a5970b4b78569e395ba69b7ee2ebc
Author: James Lu <james@overdrivenetworks.com>
Date:   Tue Apr 17 11:45:02 2018 -0700

    adv-relay-config: revert sorting events

    I'd rather have this match the code 1 to 1.

commit c63a298bd44b341831c2492d667becac67b42b42
Author: Ken Spencer <me@iotaspencer.me>
Date:   Tue Apr 17 02:15:31 2018 -0400

    adv-relay-config: change a bit of formatting (#597)

commit aa9577e8300d30713249e054905e6975897e1965
Author: Ken Spencer <me@iotaspencer.me>
Date:   Tue Apr 17 02:09:31 2018 -0400

    adv-relay-config: add more about coloring, sort events
2018-04-17 11:50:28 -07:00
James Lu
89a7f59262 adv-relay-config: various wording adjustments 2018-04-16 22:09:01 -07:00
James Lu
236d800b47 adv-relay-config: move the supported events slightly lower (#597)
[skip ci]
2018-04-16 22:01:49 -07:00
Ken Spencer
601259c771 adv-relay-config: fix up and change table to markdown (#600) 2018-04-16 21:56:20 -07:00
Ken Spencer
5623c06b8f adv-relay-config: fix colons so they match example-conf (#599)
First part of #597.
2018-04-16 20:33:10 -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
6d08e0b953 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]

(cherry picked from commit 484822e5d7)
2018-03-30 11:00:53 -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
58b717a2a0 docs/t: warn in main articles that specifications in master may be outdated
[skip ci]
2018-01-13 18:29:57 -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
James Lu
0ad2bc2f7b docs/modelists: use a different color to represent modes implemented as extbans and vice versa
[skip ci]
2017-10-05 19:32:57 -07:00
James Lu
61fe97b646 docs/modelists: drop :data suffix from extbans lists
[skip ci]
2017-10-05 19:28:43 -07:00
James Lu
48aab1cf16 docs/services-api: revise
- Rewrite lead section to be more concise
- Move to snake case method names
- Consistently use the terms "services" and "service bots"

[skip ci]
2017-10-05 19:21:52 -07:00
James Lu
39b1e28061 Remove plugins/example_service, it is out of date and broken with 2.x
Closes #532.
2017-10-05 19:08:28 -07:00
James Lu
f79168ce5f docs/t: remove future articles that won't be around for a while
[skip ci]
2017-10-05 19:05:36 -07:00
James Lu
5574c746b9 docs: update table of contents
Mode lists are in a separate folder now.

[skip ci]
2017-10-05 19:04:45 -07:00
James Lu
82a6ceb99e docs: Refresh release-process.md
[skip ci]
2017-10-05 18:20:59 -07:00
James Lu
f0d1c1bb89 pmodule-spec: mention in detail how users are tracked
Closes #478.
2017-10-05 18:18:09 -07:00
James Lu
8fff9ea641 pmodule-spec: mention post_connect definition for IRCNetwork derivatives (#478) 2017-10-05 18:18:09 -07:00
James Lu
d8768bcb73 Revise docs/automode.md
- The default bot name has been "Automode" instead of "ModeBot" for a while now; reflect that change here
- General edits for flow

[skip ci]
2017-10-04 23:28:27 -07:00
James Lu
3022274f6b Merge branch 'master' into devel
Conflicts:
	README.md
	VERSION
2017-09-24 12:26:06 -07:00
James Lu
0e45fbdf55 Revert "faq: add a note regarding #497 (bans and modes blocking clientbot from relaying)"
This reverts commit 7ae22dc848.
2017-09-19 21:15:48 -07:00
James Lu
499fe319aa permissions-api: fix markdown syntax [skip ci] 2017-09-08 19:02:51 -07:00
James Lu
4cf7b36b7b permissions-api: clarify how globs are processed
[skip ci]
2017-09-08 19:02:03 -07:00
James Lu
d3892a85be Add $service exttarget for matching service bots 2017-09-05 19:19:01 -07:00
James Lu
0a72519155 exttargets.md: bump "as of" PyLink version
[skip ci]
2017-09-05 06:30:23 -07:00
James Lu
a03214514c hybrid, ts6, ratbox: fix +p mode definitions properly
+p is noknock and rfc1459-style private on all 3 IRCds, though the latter bit is undocumented in /help cmodes (maybe it's assumed?)
+p is also "paranoia" on hybrid, which adds more restrictions to halfops and /invite

(cherry picked from commit c107f0062f)
2017-08-31 15:06:25 -07:00
James Lu
32130a7988 channel/user-modes.csv: add RFC1459 & ngIRCd columns
(cherry picked from commit 0a56ab662b)
2017-08-31 15:06:25 -07:00
James Lu
74ae6fd7c0 p10: add support for nefarious2 extbans
Closes #524.
2017-08-31 14:52:03 -07:00
James Lu
5084cc2c69 pmodule-spec: rewording, fix headings 2017-08-30 01:29:09 -07:00
James Lu
46e9975bd5 Continue rewriting the protocol module spec (#478) 2017-08-30 01:26:35 -07:00
James Lu
5b941daf4d Begin rewriting the protocol spec for PyLink 2.0 (#478) 2017-08-30 00:34:42 -07:00
James Lu
7230aaa7df Add extbans docs (#498) 2017-08-24 01:07:50 -07:00
James Lu
89699051d5 Services API rework
- Move nick/ident/host/gecos fetching from services_support into functions
- Remove the unused 'ident' argument from ServiceBot
- Rename the 'nick' argument in ServiceBot to 'default_nick'
- Define default nicks for the PyLink, Automode, and Games services
2017-08-21 21:51:45 -07:00
James Lu
361a3de9dd faq: stop advertising PyLink as cross platform
Windows support has not been tested for a long time, and there doesn't seem to be much developer/user interest in this.
2017-08-16 10:51:17 -07:00
James Lu
e180f9fa56 docs/modelists: add in chatircd +qah 2017-08-12 13:58:57 -07:00
James Lu
92dae6db5e docs/t: link to html versions of mode lists 2017-08-11 15:19:46 -07:00
James Lu
4c0d765a2f docs: revamp mode list docs
- HTML version now available via a .csv -> .html generator script
- Addded a column for ChatIRCd
2017-08-11 15:14:55 -07:00
James Lu
c107f0062f hybrid, ts6, ratbox: fix +p mode definitions properly
+p is noknock and rfc1459-style private on all 3 IRCds, though the latter bit is undocumented in /help cmodes (maybe it's assumed?)
+p is also "paranoia" on hybrid, which adds more restrictions to halfops and /invite
2017-08-11 13:45:40 -07:00
James Lu
5a00a632d6 Remove core-structure doc, outdated and not really useful 2017-08-06 23:13:20 -07:00
James Lu
ea70d34b28 docs/exttargets: refresh for 2.0 2017-08-06 21:42:09 -07:00
James Lu
f4da1fc94c Merge branch 'master' into devel
Conflicts:
	VERSION
	classes.py
	docs/faq.md
	example-conf.yml
	protocols/p10.py
	pylink
	world.py
2017-08-05 22:11:22 -07:00
James Lu
7ae22dc848 faq: add a note regarding #497 (bans and modes blocking clientbot from relaying)
This will be fixed more completely in the future. Thanks to @Ryan-Goldstein for reporting!
2017-08-03 10:44:47 -07:00
James Lu
b9a5de16de user-modes.csv: fix wrong names for sno_serverconnects, sno_stats 2017-07-31 00:57:51 +08:00
James Lu
0a56ab662b channel/user-modes.csv: add RFC1459 & ngIRCd columns 2017-07-31 00:56:10 +08:00
James Lu
7b281e4b04 faq: tweak wording
(cherry picked from commit 17a4bbea87)
2017-07-31 00:33:34 +08:00
James Lu
381d96552b faq: fix formatting in the connection troubleshooting guide
(cherry picked from commit f1f8f91bd7)
2017-07-31 00:33:32 +08:00
James Lu
5d000c9930 faq: add a section regarding #463 (sporadic SSL-related errors)
(cherry picked from commit 99acd06e02)
2017-07-31 00:33:31 +08:00
James Lu
8e67017c81 faq: be slightly less excited
(cherry picked from commit cc4890184c)
2017-07-31 00:33:31 +08:00
James Lu
c9734cc0af faq: add "Relay users are missing" section
(cherry picked from commit 0d9c53a4f4)
2017-07-31 00:33:30 +08:00
James Lu
b41234ad79 faq: add a troubleshooting guide for connection failures
(cherry picked from commit bc5474a43a)
2017-07-31 00:33:29 +08:00
James Lu
f18f7de9f7 faq: sort by subtopic
(cherry picked from commit 42ce9c83b5)
2017-07-31 00:33:28 +08:00
James Lu
c16ca14fba faq: reword "advantages over Janus" section
(cherry picked from commit 9dcc941292)
2017-07-31 00:33:27 +08:00
James Lu
54dab5f107 faq: remove obsolete note about clientbot support
The answer is fairly obvious now, and it's even mentioned in the readme.

(cherry picked from commit 01dc2505e2)
2017-07-31 00:33:27 +08:00
James Lu
bed40cc10a faq: add point about maxnicklen misconfigurations and relay
(cherry picked from commit c7f300357c)
2017-07-31 00:33:26 +08:00
James Lu
17a4bbea87 faq: tweak wording 2017-07-31 00:29:11 +08:00
James Lu
f1f8f91bd7 ffaq: fix formatting in the connection troubleshooting guide 2017-07-31 00:27:48 +08:00
James Lu
99acd06e02 faq: add a section regarding #463 (sporadic SSL-related errors) 2017-07-31 00:21:16 +08:00
James Lu
cc4890184c faq: be slightly less excited 2017-07-31 00:19:26 +08:00
James Lu
0d9c53a4f4 faq: add "Relay users are missing" section 2017-07-31 00:06:19 +08:00
James Lu
bc5474a43a faq: add a troubleshooting guide for connection failures 2017-07-31 00:01:07 +08:00
James Lu
42ce9c83b5 faq: sort by subtopic 2017-07-30 23:42:23 +08:00
James Lu
9dcc941292 faq: reword "advantages over Janus" section 2017-07-30 23:40:26 +08:00