James Lu
61cf48c37c
pmodule-spec: various fixes
...
- Corrected the location of the `self.irc.cmodes/umodes/prefixmodes` attributes
- Mention `self.conf_keys` as a special variable for completeness
2017-03-15 23:11:44 -07:00
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
James Lu
2e0c7db4e3
using-ircparser.md: minor tweaks and reordering
...
Thanks again to @IotaSpencer for writing this article :)
2017-03-12 20:45:42 -07:00
James Lu
75ea743b4a
docs/t: link to using-ircparser.md in contents
2017-03-12 20:38:58 -07:00
James Lu
c8f945d40f
writing-plugins.md: mention that IRCParser is a 1.2+ feature
2017-03-12 20:37:53 -07:00
Ken Spencer
d6d330bec6
Add docs/technical/using-ircparser.md guide.
2017-03-12 23:08:56 -04:00
Ken Spencer
ed7a117247
doc/technical/writing-plugins.md: mention and link to using-ircparser.md
2017-03-12 21:55:22 -04:00
James Lu
6fcb129ad6
hooks-reference: document the 'was_successful' key in PYLINK_DISCONNECT
2017-02-24 22:27:51 -08:00
James Lu
a7280d2943
docs/t: more notes regarding the permissions API
2017-02-24 18:31:26 -08:00
James Lu
359132045d
protocols: allow forwarding NOTICE from servers ( #384 )
2017-01-29 19:49:37 -08:00
James Lu
354a3022a4
services-api.md: remove extra_channels argument per d31d09ce7e
2017-01-22 00:55:37 -08:00
James Lu
ce742d40eb
docs/technical: fix capitalization of ircd-ratbox
2017-01-21 13:13:53 -08:00
James Lu
3dd35ba5a1
Add an example services plugin
...
Closes #399 .
2017-01-21 11:59:43 -08:00
James Lu
4147af6546
hooks-reference: remove redundant Introduction heading
2017-01-09 22:25:16 -08:00
James Lu
7fe65e1f8a
Refresh protocol spec for 1.0-beta1+
...
- Replace utils.parseModes() with irc.parseModes()
- Update source code links to 1.0-beta1
2017-01-09 22:23:35 -08:00
James Lu
6728627f78
docs: document the permissions API for developers
...
Closes #368 .
2016-12-25 11:17:10 -08:00
James Lu
c66c85bc9a
hooks-reference: refresh for 1.1.x
2016-12-21 23:26:30 -08:00
James Lu
4f3fa04cde
docs/t/services-api: mention ServiceBot.join()
2016-10-16 18:48:29 -07:00
James Lu
9997fa9306
docs/t: update protocol modules list
2016-10-01 13:42:48 -07:00
James Lu
36e18929de
docs, hybrid, ratbox: Mode definition updates
2016-10-01 13:41:11 -07:00
James Lu
c94a92bd5f
Document the PyLink release process
2016-09-16 22:01:10 -07:00
James Lu
c5c77eeb97
protocols: chandata->channeldata for MODE and JOIN hooks
2016-09-02 17:52:19 -07:00
James Lu
ae94bec6b8
protocols: add a chandata key to SJOIN hook payloads
2016-08-27 18:56:36 -07:00
James Lu
87757a60a3
Irc: rename 'chandata' in SQUIT payload to 'channeldata'
2016-08-27 17:42:07 -07:00
James Lu
945818e1d8
Refresh protocol module spec for 0.10 ( #284 )
...
Reword various things, and update links to source code references. Also, mention the following:
- conf_keys validation (#282 )
- Topic acceptance rules (or rather, the lack thereof: #277 )
2016-08-24 23:25:36 -07:00
James Lu
6f0be9400b
docs/t: add clientbot to protocol-modules
2016-08-09 00:07:27 -07:00
James Lu
df4277e530
hooks-reference: update keys for SJOIN
2016-08-08 21:06:49 -07:00
James Lu
b376aba591
docs/t: add Services API description
...
Closes #224 .
2016-07-23 20:56:51 -07:00
James Lu
7f7c8a8b51
Doxygen configuration & autorun script
2016-07-23 19:42:17 -07:00
James Lu
1629533242
pmodule-spec: add modes argument to sjoin()
2016-07-17 22:25:01 -07:00
James Lu
88281a3a54
docs/technical: purge ancient autogen docs
2016-07-13 19:23:09 -07:00
James Lu
72eb04ebc6
docs/t: add SVSNICK to hooks reference
2016-07-13 18:53:51 -07:00
James Lu
db93db7f4e
docs/t: update pmodule-spec.md
2016-07-12 00:32:57 -07:00
James Lu
c5176b7386
Add last commit's image to docs contents
2016-07-12 00:29:14 -07:00
James Lu
0823fb2a1e
docs/technical: Add protocol modules inheritance graph
2016-07-12 00:28:13 -07:00
James Lu
ca638f77e3
docs/t: drop update-autogen, it's broken now
2016-07-09 00:25:58 -07:00
James Lu
d2956c3d00
protocols: return uplink field in SQUIT handlers
2016-06-25 13:34:43 -07:00
James Lu
e057df2ae9
channel-modes: fix definition for private (+p)
...
Charybdis and Elemental-IRCd implement +p as noknock, not the RFC1459-style private.
2016-06-19 21:14:10 -07:00
James Lu
cb30aca750
docs/t/writing-plugins: mention main() and die()
...
Closes #113 .
2016-06-11 11:03:16 -07:00
James Lu
229c36381e
docs/t: update links to include user-modes.csv
...
Closes #200 .
2016-05-31 20:57:18 -07:00
James Lu
85a97ce86b
docs/t: add usermodes list ( #200 )
2016-05-31 20:57:18 -07:00
James Lu
92de5e81b2
docs/t: remove + from entries in channel-modes
2016-05-31 20:57:18 -07:00
James Lu
89ed92b46a
Update autogen docs
2016-05-27 22:39:40 -07:00
James Lu
a0d20df899
docs: tweak writing-plugins & TOC, move plugin_example to plugins
...
Closes #226 .
2016-05-22 10:59:57 -07:00
James Lu
aea6657a8b
docs: update hooks-reference
...
Closes #223 .
2016-05-22 10:48:19 -07:00
James Lu
3856ee435c
docs/t: rewrite parts of writing-plugins.md
2016-05-19 23:42:42 -07:00
James Lu
4e8de60005
core: Rewrite WHOIS handlers to simply listen to a custom hook (PYLINK_CUSTOM_WHOIS)
2016-05-19 23:32:43 -07:00
James Lu
ae87def11f
Purge c_ and u_ prefixes from named modes
...
Closes #217 .
2016-05-15 11:05:02 -07:00
James Lu
ce95e15897
Refresh autogen docs
2016-05-11 21:56:02 -07:00
James Lu
6b40c97a75
docs: update channel-modes
...
Include lists for Nefarious and update those for the rest.
2016-05-11 21:52:32 -07:00
James Lu
ad428b55bc
docs: relayout table of contents & links between pages
2016-05-11 21:52:32 -07:00
James Lu
f2f945e4bb
Revert "docs/t: use rawgit links to serve HTML"
...
This reverts commit 0dd8b80a21
2016-05-11 21:52:32 -07:00
James Lu
84503a2ead
docs/cmodes: update noknock mappings for c599978
2016-04-24 21:53:12 -07:00
James Lu
4013965029
pmodule-spec: mention checking recvpass
...
It's surprisingly how easily this can be overlooked. I've been guilty of this too.
2016-04-17 22:32:19 -07:00
James Lu
c2c8dda4ef
docs/t: revamp core-structure pic
2016-04-10 21:51:12 -07:00
James Lu
50afc52a03
pmodule-spec: be clearer about mode definitions
...
Clarify the difference between channel names/UIDs and channel/user objects. Also, reflect the API changes made in 8135f3a735
2016-04-10 21:31:51 -07:00
James Lu
989b6374e6
docs/t: add channel-modes.csv ( #200 )
2016-04-09 18:30:43 -07:00
James Lu
528dfdba2a
pmodule-spec: mention cmodes, umodes, prefixmodes variables
2016-04-03 16:40:11 -07:00
James Lu
a91fa46549
Regenerate pydoc documentation
2016-03-26 11:42:12 -07:00
James Lu
c8a3514776
hooks-reference: add VERSION and WHOIS
2016-03-26 11:41:46 -07:00
James Lu
0dd8b80a21
docs/t: use rawgit links to serve HTML
2016-03-11 23:20:08 -08:00
James Lu
506ae011a4
Update autogenerated docs (adding a script to do this now)
2016-03-11 23:14:16 -08:00
James Lu
557efc369f
docs/t: mark hooks-reference as finished in README
2016-03-11 22:41:28 -08:00
James Lu
9d0fcb5395
docs: finish off hooks-reference ( #113 )
2016-03-11 22:40:48 -08:00
James Lu
cad3e3d5f5
Remove references to overdrive TLDs in code
2016-01-17 21:07:51 -08:00
James Lu
2fd0a8ae74
Update protocol module spec for all the function name changes ( #156 )
2016-01-16 17:37:19 -08:00
James Lu
812a866a4e
protocols: rename pingServer -> ping
2016-01-16 17:11:23 -08:00
James Lu
3d0bf18001
protocols: rename topicClient -> topic; topicServer -> topicBurst
...
This is one of the few commands that I won't consolidate at this time, because there is actually a difference in how most IRCds handle topic bursts and normal topic changes
2016-01-16 17:09:52 -08:00
James Lu
5ccf204c75
protocols: consolidate modeClient and modeServer into mode()
2016-01-16 17:08:17 -08:00
James Lu
cb467bcfdb
plugins, docs: update to use irc.proto.kill
2016-01-16 17:03:58 -08:00
James Lu
983edaf8d0
plugins, docs, test suite: update to use irc.proto.kick
2016-01-16 16:59:28 -08:00
James Lu
ee65ac60e1
protocols: rename sjoinServer(...) -> sjoin(...)
2016-01-16 16:53:46 -08:00
James Lu
9a61e64dfc
protocols: squitServer(...) -> squit(...)
2016-01-16 16:53:06 -08:00
James Lu
5324475d18
protocols: quitClient(...) -> quit(...), partClient(...) -> part(...)
2016-01-16 16:51:54 -08:00
James Lu
7e5284969d
protocols: rename nickClient(...) -> nick(...)
2016-01-16 16:51:04 -08:00
James Lu
196282db86
protocols: numericServer(...) -> numeric(...)
2016-01-16 16:47:35 -08:00
James Lu
3a53005d8c
protocols: messageClient -> message, noticeClient -> notice
2016-01-16 16:44:23 -08:00
James Lu
108be5e25e
protocols: rename knockClient -> knock
2016-01-16 16:41:17 -08:00
James Lu
20cb65e668
protocols: rename awayClient -> away
2016-01-16 16:40:36 -08:00
James Lu
b4e5c57a35
protocols: rename inviteClient(...) -> invite(...)
2016-01-16 16:38:27 -08:00
James Lu
acdd7dbb78
protocols: rename joinClient(...) -> join(...)
2016-01-16 16:36:45 -08:00
James Lu
f2efaf9437
docs: update hooks-reference ( #113 )
2016-01-09 19:18:19 -08:00
James Lu
9556efae46
docs: pingServer is required in protocol modules
2015-12-29 11:18:15 -08:00
James Lu
270bdcc79a
Move autogen docs to separate folder, add them for conf, classes, log, and world
2015-12-26 16:55:59 -08:00
James Lu
bf2b256b84
docs: fix markdown formatting
2015-12-26 16:47:25 -08:00
James Lu
e4815a72e1
docs: add part of hooks-reference, mention topics and modes in protocol module spec, some more changes
...
ref: #113 .
2015-12-26 16:44:22 -08:00
James Lu
4529481556
docs/writing-plugins.md: also mention irc.reply()
2015-12-26 15:07:44 -08:00
James Lu
775df5a6c5
plugin_example.py: use irc.reply()
2015-12-26 15:02:23 -08:00
James Lu
01a4da5d3a
classes: Fix another missing docstring
2015-12-26 14:47:23 -08:00
James Lu
11adee9d78
Yet another documentation refresh ( #113 )
2015-12-26 14:45:28 -08:00
James Lu
2080a39cf4
coreplugin: sanity check: make sure irc.connected is set after 2 seconds & mention how setting this is neccessary in docs
2015-11-15 21:50:23 -08:00
James Lu
3fb7b3ff1a
Doc updates: +using-utils.md stub; update autogenerated references for protocols/inspircd, utils
2015-10-03 16:39:52 -07:00
James Lu
f884d71cf0
docs/pmodule-spec.md: formatting again
2015-09-24 18:39:33 -07:00
James Lu
86495db770
docs/pmodule-spec: formatting
2015-09-24 18:38:38 -07:00
James Lu
f015fe5e25
Documentation updates, finish off pmodule-spec.md ( #113 )
2015-09-24 18:36:54 -07:00
James Lu
6c503b3603
Fix typos and other stupid mistakes...
2015-09-06 23:18:27 -07:00
James Lu
bd9a857042
docs: add auto-generated InspIRCd protocol spec, and finish off most of writing-plugins.md
2015-09-06 23:11:55 -07:00
James Lu
32556d418d
docs: bring plugin_example.py up to date
2015-09-06 22:40:10 -07:00
James Lu
7625268732
docs/: Start work on writing-plugins.md, improvements to example plugin
2015-08-24 12:10:14 -07:00
James Lu
005789e85a
plugin_example: document the arguments each hook / command function takes
2015-08-09 01:06:00 -07:00
